This API is used to query the created enhanced datasource connections.
GET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}
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. |
connection_id |
Yes |
String |
Connection ID. Identifies the UUID of a datasource connection. |
None
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
is_success |
No |
Boolean |
Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed. |
message |
No |
String |
System prompt. If execution succeeds, the parameter setting may be left blank. |
id |
No |
String |
Connection ID. Identifies the UUID of a datasource connection. |
name |
No |
String |
User-defined connection name. |
status |
No |
String |
Connection status. The options are as follows:
|
available_queue_info |
No |
Array of Objects |
For details about how to create a datasource connection for each queue, see Table 3. |
dest_vpc_id |
No |
String |
The VPC ID of the connected service. |
dest_network_id |
No |
String |
Subnet ID of the connected service. |
create_time |
No |
Long |
Time when a link is created. The time is converted to a UTC timestamp. |
hosts |
No |
Array of Objects |
User-defined host information. For details, see hosts parameter description. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
peer_id |
No |
String |
ID of a datasource connection. |
status |
No |
String |
Connection status. For details about the status code, see Table 5. |
name |
No |
String |
Name of a queue. |
err_msg |
No |
String |
Detailed error message when the status is FAILED. |
update_time |
No |
Long |
Time when the available queue list was updated. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
The user-defined host name. |
ip |
No |
String |
The IPv4 address of the host. |
Parameter |
Definition |
Description |
---|---|---|
CREATING |
Creating |
The datasource connection is being created. |
ACTIVE |
Active |
The datasource connection has been created, and the connection to the destination address is normal. |
FAILED |
Failed |
Failed to create a datasource connection. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
peer_id |
No |
String |
ID of a datasource connection. |
status |
No |
String |
Connection status. For details about the status code, see Table 5. |
name |
No |
String |
Elastic resource pool name |
err_msg |
No |
String |
Detailed error message when the status is FAILED. |
update_time |
No |
Long |
Update time |
None
{ "is_success": true, "message": "", "name": "withvpc", "id": "4c693ecc-bab8-4113-a838-129cedc9a563", "available_queue_info": [ { "status": "ACTIVE", "name": "resource_mode_1", "peer_id": "d2ae6628-fa37-4e04-806d-c59c497492d1", "err_msg": "", "update_time": 1566889577861 } ], "dest_vpc_id": "22094d8f-c310-4621-913d-4c4d655d8495", "dest_network_id": "78f2562a-36e4-4b39-95b9-f5aab22e1281", "create_time": 1566888011125, "status": "ACTIVE", "hosts": [ { "ip":"192.168.0.1", "name":"ecs-97f8-0001" }, { "ip":"192.168.0.2", "name":"ecs-97f8-0002" } ] }
Table 7 describes the status code.
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 Code.