This topic describes the CreatePolarDBDataSource API operation provided by OceanBase Migration Service (OMS).
Purpose
You can call this operation to create a PolarDB-X 1.0 data source.
Call description
Limitations
This operation is applicable to OMS V4.2.4 and later.
Request path
POST /api/v2?Action=CreatePilarDBDataSource
Request parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | The ID of the data source. We recommend that you set it to a combination of digits and letters. It must not contain any spaces and cannot exceed 32 characters in length. |
| region | string | The region of the data source. |
| username | string | The username of the database user intended for data migration or synchronization. |
| password | string | The password of the database user, which is Base64-encoded. |
| accessKey | string | The AccessKey ID of your Alibaba Cloud account. |
| secretKey | string | The AccessKey secret of your Alibaba Cloud account. |
| intranetAddr | string | The internal IP address of the database. |
| description | string | The description of the data source, which cannot exceed 128 characters in length. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the call is successful. |
| errorDetail | object | The error details. |
| code | string | The error code. |
| message | string | The error description. |
| advice | string | The suggestions. |
| requestId | string | The ID of the request. |
| pageNumber | integer | The number of the page returned. |
| pageSize | integer | The number of entries returned on each page. |
| totalCount | integer | The total number of entries returned. |
| cost | string | The amount of time spent in processing the request, in seconds. |
| data | string | The ID of the PolarDB-X 1.0 data source. |
Examples
Sample request
{
"name": "drds-test",
"region": "cn-anhui",
"userName": "tes***",
"password": "cGFzc3dvcmQ=",
"accessKey": "det****",
"secretKey": "tdw****",
"intranetAddr": "****"
}
Sample response
{
"success":true,
"errorDetail":null,
"code":null,
"message":null,
"advice":null,
"requestId":" a7b57****",
"pageNumber":null,
"pageSize":null,
"totalCount":null,
"cost":" 27 ms",
"data":" e_edz****"
}