Querying Information about Available Data Flows

Function

This API is used to query information about available data flows for real-time migration, real-time synchronization, and real-time disaster recovery, based on different parameters.

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}/support-links

**Table 1** URI parameters
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

**Table 2** Query parameters
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 migration: real-time migration. sync: real-time synchronization. cloudDataGuard: real-time disaster recovery. replay: workload replay. verify: verification task. Default Value N/A
offset	No	Integer	Definition Offset, which is used for pagination query. The records after this offset will be queried. Constraints The maximum value is 10000. 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 The maximum value is 2000. Range N/A Default Value 10

Request Parameters

**Table 3** Request header 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 en-us: English zh-cn: Chinese Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
[Array elements]	Array of objects	Definition Response body for querying available data flow information. For details, see SupportLinksResp.

**Table 5** SupportLinksResp
Parameter	Type	Description
total_count	Integer	Definition Total number of records in the list, which is irrelevant to pagination. This parameter indicates the total number of records that meet the query criteria, which is used for pagination calculation. Constraints N/A Range N/A
support_links	Array of objects	Definition List of data flows supported by DRS. Each data flow contains information such as the engine type, network type, and migration mode. For details, see SupportLinkInfo.

**Table 6** SupportLinkInfo
Parameter	Type	Description
engine_type	String	Definition Type of the engine used by the DRS task. Constraints N/A Range N/A
net_type	String	Definition Type of the network used by the task. Constraints The VPC network cannot be selected in the DR scenario. Range eip: public network. vpc: VPC network. The VPC network cannot be selected in DR scenarios. vpn: VPN or Direct Connect.
task_modes	Array of strings	Definition List of migration modes supported by the available link. Constraints N/A Range N/A FULL_TRANS: full migration. FULL_INCR_TRANS: full+incremental migration. INCR_TRANS: incremental migration.
job_direction	String	Definition Migration direction of the task. Constraints N/A Range up: to-the-cloud scenarios and DR scenarios where the current cloud is the standby. down: out-of-cloud scenarios and DR scenarios where the current cloud is the active. non-dbs: self-built databases.
cluster_mode	String	Definition Deployment mode of a cloud DB instance, which indicates the cluster architecture type of the source or destination DB instance on the cloud. Constraints N/A Range Single: single node. Ha: primary/standby. Cluster: cluster. Sharding: sharding. Independent: independent GaussDB deployment. Replica: RDS read replica. ReplicaSet: MongoDB replica set.
job_instance_type	String	Definition Deployment type of the DRS replication instance. Constraints N/A Range Single: single-node deployment Ha: primary/standby
is_support_bind_eip	Boolean	Definition Whether an EIP can be bound to the replication instance for public network communication. Constraints N/A Range true: An EIP can be bound. false: An EIP cannot be bound.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code returned when an error occurs during task execution. Constraints Minimum length: 12 characters Maximum length: 12 characters Range The format is DRS.XXXXXX.
error_msg	String	Definition Detailed error description returned when a task fails to be executed. Constraints Minimum length: 1 character Maximum length: 512 characters Range N/A

Example Request

Querying information about available links for real-time migration

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/support-links?job_type=migration

Querying information about available links for real-time synchronization

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/support-links?job_type=sync

Querying information about available links for real-time disaster recovery

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/support-links?job_type=cloudDataGuard

Example Response

Status code: 200

{
  "support_links" : [ {
    "engine_type" : "mysql",
    "net_type" : "eip",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Ha",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "eip",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Single",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "eip",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Cluster",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpc",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Ha",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpc",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Single",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpc",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Cluster",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpn",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Ha",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpn",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Single",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mysql",
    "net_type" : "vpn",
    "task_modes" : [ "FULL_INCR_TRANS", "INCR_TRANS" ],
    "job_direction" : "up",
    "cluster_mode" : "Cluster",
    "is_support_bind_eip" : false
  }, {
    "engine_type" : "mongodb",
    "net_type" : "vpc",
    "task_modes" : [ "INCR_TRANS" ],
    "job_direction" : "down",
    "cluster_mode" : "Sharding",
    "is_support_bind_eip" : false
  } ],
  "total_count" : 1367
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000009",
  "error_msg" : "Parameter error."
}

Status Code

Status Code	Description
200	OK
400	Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Resource Management

Previous topic: Resource Management

Next topic: Querying Task Specifications of a Data Flow