Querying Task Specifications of a Data Flow

Function

This API is used to query task specifications of different data flows in real-time migration, real-time synchronization, and real-time disaster recovery scenarios 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}/link-flavors

**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
engine_type	No	String	Definition Engine type. Constraints N/A Range The value range can be obtained by querying information about available data flows. Default Value N/A
job_type	No	String	Definition Task scenario. Constraints N/A Range migration: real-time migration sync: real-time synchronization cloudDataGuard: real-time disaster recovery subscription: data subscription replay: workload replay verify: verification task cdc: CDC task Default Value N/A
job_direction	No	String	Definition Task direction. 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: between self-built databases Default Value N/A
net_type	No	String	Definition Network type. Constraints N/A Range eip: public network vpc: VPC network. The VPC network cannot be selected in DR scenarios. vpn: VPN or Direct Connect Default Value N/A
node_type	No	String	Definition Task instance specification type. Constraints N/A Range micro: micro specifications small: small specifications medium: medium specifications high: large specifications xlarge: ultra-large specifications 2xlarge: macro specifications Default Value N/A
is_multi_write	No	Boolean	Definition Whether the DR type is dual-active. Constraints This parameter is mandatory when job_type is set to cloudDataGuard. If the DR type is dual-active, set this parameter to true. Otherwise, set this parameter to false. Range true: multi-write task false: non-multi-write task Default Value N/A

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
vm_flavor	object	Definition VM specifications. For details, see Table 5.
volume_flavor	object	Definition Disk specifications. For details, see Table 5.
flow_flavor	object	Definition Traffic specifications. For details, see Table 5.

**Table 5** FlavorInfo
Parameter	Type	Description
id	String	Definition Specification ID. Constraints N/A Range N/A
cloud_service_type	String	Definition Cloud service type. Constraints N/A Range N/A
spec_type_code	String	Definition Type specification code. Constraints N/A Range N/A
spec_code	String	Definition Specification code. Constraints N/A Range N/A

Status code: 400

**Table 6** 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 task specifications of a high-specification VPC network–based MySQL data flow for synchronization to the cloud

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/link-flavors?engine_type=mysql&job_type=sync&job_direction=up&net_type=vpc&node_type=high

Example Response

Status code: 200

{ 
  "vm_flavor" : { 
    "id" : "59ac1c64-b798-4c40-93c2-a24c8514314c", 
    "cloud_service_type" : "hws.service.type.drs", 
    "spec_type_code" : "hws.resource.type.drs.vm", 
    "spec_code" : "drs.lg.sync" 
  }, 
  "volume_flavor" : null, 
  "flow_flavor" : { 
    "id" : "f5dc1c46-9881-43c1-95a3-e00d45a7d2c5", 
    "cloud_service_type" : "hws.service.type.drs", 
    "spec_type_code" : "hws.resource.type.drs.flow", 
    "spec_code" : "drs.vpc.flow.in.sync" 
  } 
}

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: Querying Information about Available Data Flows

Next topic: Task Management