Querying Information about Available Links
Function
This API is used to query information about available links.
Constraints
- This API is available only for migration and synchronization from MySQL to MySQL, migration from Redis to GeminiDB Redis, migration from Redis Cluster to GeminiDB Redis, and synchronization from Oracle to GaussDB Distributed.
- This API can be used only in certain regions. For details, see Endpoints.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.
URI
GET /v5/{project_id}/links
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| job_type | Yes | String | Definition DRS task type, which is used to distinguish different data replication scenarios. Constraints N/A Range
Default Value N/A |
| offset | No | Integer | Definition Offset, which is used for pagination query. The records after this offset will be queried. Constraints N/A Range N/A Default Value 0 |
| limit | No | Integer | Definition Maximum number of records that can be returned. This parameter is used to specify the number of records returned on each page during pagination query. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | Definition MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. Constraints N/A Range application/json Default Value application/json |
| X-Auth-Token | Yes | String | Definition User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A |
| X-Language | No | String | Definition Request language type. Constraints N/A Range
Default Value en-us |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| job_links | Array of objects | Definition List of available links, which includes detailed configuration information about each available link. For details, see Table 5. Constraints N/A Range N/A |
| total_count | Integer | Definition Total number of available links that meet the search criteria. Constraints N/A Range N/A |
| Parameter | Type | Description |
|---|---|---|
| job_type | String | Definition DRS task type, which is used to distinguish different data replication scenarios. Constraints N/A Range
|
| engine_type | String | Definition Type of the DRS task engine, which identifies the DB engine combination used by the data replication task. Constraints N/A Range
|
| source_endpoint_type | String | Definition Type of the source DB instance, which indicates the deployment mode of the source database. Constraints N/A Range
|
| target_endpoint_type | String | Definition Type of the destination DB instance, which indicates the deployment mode of the destination database. Constraints N/A Range
|
| job_direction | String | Definition Migration direction of the task. Constraints N/A Range
|
| net_type | String | Definition Type of the network used by the task. Constraints N/A Range
|
| task_types | Array of strings | Definition List of migration modes supported by the available link. Constraints N/A Range
|
| cluster_modes | Array of strings | Definition List of DB instance modes supported by the available link. Constraints N/A Range
|
| description | String | Definition Description of the link, which explains the application scenarios or function characteristics of the link. Constraints N/A Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code returned when an error occurs during task execution. Constraints
Range The format is DRS.XXXXXX. |
| error_msg | String | Definition Detailed error description returned when a task fails to be executed. Constraints
Range N/A |
Example Request
- Querying information about available links for real-time migration
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/links?job_type=migration - Querying information about available links for real-time synchronization
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/links?job_type=sync - Querying information about available links for real-time disaster recovery
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/links?job_type=cloudDataGuard
Example Response
Status code: 200
OK
{
"job_links" : [ {
"job_type" : "sync",
"engine_type" : "oracle-to-gaussdbv5",
"net_type" : "eip",
"task_types" : [ "FULL_INCR_TRANS", "FULL_TRANS", "INCR_TRANS" ],
"job_direction" : "up",
"cluster_modes" : [ "Independent", "Combined" ],
"source_endpoint_type" : "offline",
"target_endpoint_type" : "cloud"
}, {
"job_type" : "sync",
"engine_type" : "oracle-to-gaussdbv5",
"net_type" : "vpn",
"task_types" : [ "FULL_INCR_TRANS", "FULL_TRANS", "INCR_TRANS" ],
"job_direction" : "up",
"cluster_modes" : [ "Independent", "Combined" ],
"source_endpoint_type" : "offline",
"target_endpoint_type" : "cloud"
} ],
"total_count" : 2
} Status code: 400
Bad Request
{
"error_code" : "DRS.10000009",
"error_msg" : "Parameter error."
} Error Code
For details, see Error Code.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
