查询增强型跨源连接
功能介绍
该API用于查询该用户指定的已创建的增强型跨源连接。
URI
- URI格式
GET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}
- 参数说明
表1 URI参数 参数名称
是否必选
参数类型
说明
project_id
是
String
项目编号，用于资源隔离。获取方式请参考获取项目ID。
connection_id
是
String
连接ID，用于标识跨源连接的UUID。
请求消息
无请求参数。
响应消息
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
is_success |
否 |
Boolean |
执行请求是否成功。“true”表示请求执行成功。 |
|
message |
否 |
String |
系统提示信息，执行成功时，信息为空。 |
|
id |
否 |
String |
连接ID，用于标识跨源连接的UUID。 |
|
name |
否 |
String |
创建连接时，用户自定义的连接名称。 |
|
status |
否 |
String |
连接状态，包括以下两种状态：
|
|
available_queue_info |
否 |
Array of Objects |
各个队列创建跨源连接的信息，详细信息请参考表3。 |
|
dest_vpc_id |
否 |
String |
对应服务的虚拟私有云标识。 |
|
dest_network_id |
否 |
String |
对应服务的子网网络标识。 |
|
create_time |
否 |
Long |
创建连接的时间。为UTC的时间戳。 |
|
hosts |
否 |
Array of Objects |
用户自定义主机信息，详细信息参见表 hosts参数说明。 |
|
elastic_resource_pools |
否 |
Array of Objects |
各个弹性资源池创建对等连接的信息，详细信息请参考表6。 |
|
ipv6_enable |
否 |
boolean |
是否启用IPv6。 true：启用IPv6。 false，不开启IPv6。 |
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
peer_id |
否 |
String |
跨源连接ID。 |
|
status |
否 |
String |
连接状态，状态码请参考表5。 |
|
name |
否 |
String |
队列名称。 |
|
err_msg |
否 |
String |
状态为失败时的详细报错信息。 |
|
update_time |
否 |
Long |
更新时间。 |
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
peer_id |
否 |
String |
跨源连接ID。 |
|
status |
否 |
String |
连接状态，状态码请参考表5。 |
|
name |
否 |
String |
弹性资源池名称。 |
|
err_msg |
否 |
String |
状态为失败时的详细报错信息。 |
|
update_time |
否 |
Long |
更新时间。 |
请求示例
无
响应示例
{
"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"
}
]
}
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。
