Creating an Enhanced Datasource Connection

Updated on 2024-11-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to create an enhanced datasource connection with other services.

NOTE:

For details about how to use the console interface, see Enhanced Datasource Connections in Data Lake Insight User Guide.
Datasource connections cannot be created for the default queue.

URI

URI format
POST /v2.0/{project_id}/datasource/enhanced-connections

Parameter description

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request Parameters

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Name of the connection. The name can contain only letters, digits, and underscores (_), and cannot be left empty. A maximum of 64 characters are allowed.
dest_vpc_id	Yes	String	The ID of the service VPC to be connected.
dest_network_id	Yes	String	The subnet ID of the to-be-connected service.
elastic_resource_pools	No	Array of Strings	List of elastic resource pools that need to use datasource resources.
queues	No	Array of Strings	This parameter is about to be taken offline with DLI queues. Use the elastic_resource_pools parameter instead. List of queue names that are available for datasource connections. NOTE: Only dedicated queues are allowed to use the enhanced datasource connections.
routetable_id	No	String	Route table associated with the subnet of the service.
hosts	No	Array of objects	The user-defined host information. A maximum of 20,000 records are supported. For details, see hosts request parameters.
tags	No	Array of objects	Tags of datasource connections. For details, see Table 4.

**Table 3** hosts request parameters
Parameter	Mandatory	Type	Description
name	No	String	The user-defined host name. The value can consist of 128 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). It must start with a letter.
ip	No	String	The IPv4 address of the host.

**Table 4** tags parameter
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. NOTE: A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.
value	Yes	String	Tag key. NOTE: A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.

Response Parameters

**Table 5** Response parameters
Parameter	Type	Description
is_success	Boolean	Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed.
message	String	System prompt. If execution succeeds, the message may be left blank.
connection_id	String	Connection ID. Identifies the UUID of a datasource connection.

Example Request

Create an enhanced datasource connection for a queue and configure host information.

{
  "name": "test",
  "dest_vpc_id": "22094d8f-c310-4621-913d-4c4d655d8495",
  "dest_network_id": "78f2562a-36e4-4b39-95b9-f5aab22e1281",
  "elastic_resource_pools": [
    "e1"
   ],
  "hosts": [
    {
      "ip":"192.168.0.1",
      "name":"ecs-97f8-0001"
    },
    {
      "ip":"192.168.0.2", 
      "name":"ecs-97f8-0002"
    }
  ]
}

Example Response

{
  "is_success": true,
  "message": "Create peer connection for queues:{Resource pool list in the request parameter}",
  "connection_id": "2a620c33-5609-40c9-affd-2b6453071b0f"
}

Status Codes

Table 6 describes the status code.

**Table 6** Status codes
Status Code	Description
201	The job is created successfully.
400	Request error.
500	Internal service error.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.

Parent topic: APIs Related to Enhanced Datasource Connections

Previous topic: APIs Related to Enhanced Datasource Connections

Next topic: Deleting an Enhanced Datasource Connection