Help Center/ Cloud Data Migration/ API Reference/ API/ Link Management/ Creating a Link

Updated on 2026-06-16 GMT+08:00

Creating a Link

Function

This API is used to create a link.

Calling Method

For details, see Calling APIs.

URI

POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/link

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.
cluster_id	Yes	String	Cluster ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
validate	No	String	When the parameter is set to true, the API only validates whether the parameters are correctly configured, but does not create any link.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
links	Yes	Array of links objects	Link list. For details, see the descriptions of links parameters.

**Table 5** links
Parameter	Mandatory	Type	Description
link-config-values	Yes	link-config-values object	Link parameters. For details, see the descriptions of link-config-values parameters.
creation-user	No	String	User who created a link
name	Yes	String	Link name
id	No	Integer	Link ID
creation-date	No	Long	Time when a link was created
connector-name	Yes	String	Connector name. The corresponding link parameter is generic-jdbc-connector, which indicates a relational database link. obs-connector: link to OBS hdfs-connector: link to HDFS hbase-connector: link to HBase and link to CloudTable hive-connector: link to Hive ftp-connector/sftp-connector: link to an FTP or SFTP server mongodb-connector: link to MongoDB redis-connector: link to Redis/DCS kafka-connector: link to Kafka dis-connector: link to DIS elasticsearch-connector: link to Elasticsearch/Cloud Search Service (CSS) dli-connector: link to DLIhttp-connector: link to HTTP/HTTPS (No link parameters are required.) dms-kafka-connector: link to DMSKafka
update-date	No	Long	Time when a link was updated
enabled	No	Boolean	Whether to activate the link. The default value is true.
update-user	No	String	User who updated a link

**Table 6** link-config-values
Parameter	Mandatory	Type	Description
configs	Yes	Array of configs objects	Data structure of link parameters. For details, see the descriptions of configs parameters.
extended-configs	No	extended-configs object	Extended configuration. For details, see the descriptions of extended-configs parameters.
validators	No	Array of strings	Validator

**Table 7** configs
Parameter	Mandatory	Type	Description
inputs	Yes	Array of Input objects	Input parameter list. Each element in the list is in name,value format. For details, see the descriptions of inputs parameters. In the from-config-values data structure, the value of this parameter varies with the source link type. For details, see section "Source Job Parameters" in the Cloud Data Migration User Guide. In the to-config-values data structure, the value of this parameter varies with the destination link type. For details, see section "Destination Job Parameters" in the Cloud Data Migration User Guide. For details about the inputs parameter in the driver-config-values data structure, see the job parameter descriptions.
name	Yes	String	Configuration name. The value is fromJobConfig for a source job, toJobConfig for a destination job, and linkConfig for a link.
id	No	Integer	Configuration ID, which is generated by the system. You do not need to set this parameter.
type	No	String	Configuration type, which is generated by the system. You do not need to set this parameter. The value can be LINK (for link management APIs) or JOB (for job management APIs).

**Table 8** Input
Parameter	Mandatory	Type	Description
name	Yes	String	Parameter name. For link management APIs, parameter names start with linkConfig.. The parameters vary depending on the link type. For details, see the parameter descriptions of the corresponding link in Link Parameters. For job management APIs, source link parameter names start with fromJobConfig.. For details, see the source job parameters in Source Job Parameters. Destination link parameter names start with toJobConfig.. For details, see Destination Job Parameters. For details about job parameters, see the task parameter descriptions in Job Parameters.
value	Yes	Object	Parameter value, which must be a string.
type	No	String	Value type, such as STRING and INTEGER. The value is set by the system.

**Table 9** extended-configs
Parameter	Mandatory	Type	Description
name	No	String	Name
value	No	String	Value

Response Parameters

Status code: 200

**Table 10** Response body parameters
Parameter	Type	Description
name	String	Link name
validation-result	Array of validationResult objects	Validation structure. If a link fails to be created, the failure cause is returned. For details, see the descriptions of validation-result parameters. If a link is successfully created, an empty list is returned.

**Table 11** validationResult
Parameter	Type	Description
linkConfig	Array of validationLinkConfig objects	Validation result of link creation or update. For details, see the descriptions of validationLinkConfig parameters.

**Table 12** validationLinkConfig
Parameter	Type	Description
message	String	Error message
status	String	Error level, for example, ERROR or WARNING

Status code: 400

**Table 13** Response body parameters
Parameter	Type	Description
code	String	Return code
errCode	String	Error code
message	String	Error message
externalMessage	String	Additional information

Status code: 500

**Table 14** Response body parameters
Parameter	Type	Description
message	String	Error message
status	String	Error level, for example, ERROR or WARNING

Example Requests

Creating a link named mysql_link

POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/6ec9a0a4-76be-4262-8697-e7af1fac7920/cdm/link

{
  "links" : [ {
    "link-config-values" : {
      "configs" : [ {
        "inputs" : [ {
          "name" : "linkConfig.databaseType",
          "value" : "MYSQL"
        }, {
          "name" : "linkConfig.host",
          "value" : "100.94.8.163"
        }, {
          "name" : "linkConfig.port",
          "value" : "3306"
        }, {
          "name" : "linkConfig.database",
          "value" : "DB_name"
        }, {
          "name" : "linkConfig.username",
          "value" : "username"
        }, {
          "name" : "linkConfig.password",
          "value" : "DB_password"
        }, {
          "name" : "linkConfig.fetchSize",
          "value" : "100000"
        }, {
          "name" : "linkConfig.usingNative",
          "value" : "false"
        } ],
        "name" : "linkConfig"
      } ]
    },
    "name" : "mysql_link",
    "creation-date" : 1496654788622,
    "connector-name" : "generic-jdbc-connector",
    "update-date" : 1496654788622,
    "enabled" : true
  } ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "name" : "rdb_link",
  "validation-result" : [ { } ]
}

Status code: 400

Request error.

{
  "code" : "Cdm.0315",
  "errCode" : "Cdm.0315",
  "message" : "Link name [ftp_link] already exist or created by other user.",
  "externalMessage" : "Link name [ftp_link] already exist or created by other user."
}

Status code: 500

Internal service error. For details about the returned error code, see Error Codes.

{
  "validation-result" : [ {
    "linkConfig" : [ {
      "message" : "Can't connect to the database with given credentials: The authentication type 12 is not supported. Check that you have configured the pg_hba.conf file to include the client's IP address or subnet, and that it is using an authentication scheme supported by the driver.",
      "status" : "ERROR"
    } ]
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Request error.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	Internal service error. For details about the returned error code, see Error Codes.
503	Service unavailable.

Error Codes

See Error Codes.

Parent topic: Link Management

Previous topic: Link Management

Next topic: Querying a Link

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.