更新时间:2022-12-07 GMT+08:00

查询增强型跨源连接列表

功能介绍

该API用于查询该用户已创建的增强型跨源连接列表。

URI

  • URI格式

    GET /v2.0/{project_id}/datasource/enhanced-connections

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID。

    表2 query参数

    参数名称

    是否必选

    参数类型

    说明

    limit

    否

    String

    查询最大连接个数,默认为100。“limit”为“0”时,将返回全部跨源连接列表。

    offset

    否

    String

    查询结果偏移量,默认为0(连接以创建时间进行排序)。

    status

    否

    String

    连接状态,包括以下两种状态:

    • ACTIVE:已激活
    • DELETED:已删除
    说明:

    连接状态不区分大小写。

    name

    否

    String

    连接名。

    tags

    否

    String

    标签名列表。单个标签为k=v,多个标签以“,”分隔。示例tag1=v1,tag2=v2。

    带入query参数的URL示例如下:

    GET /v2.0/{project_id}/datasource/enhanced-connections?limit={limit}&offset={offset}&status={status}&name={name}

请求消息

无请求参数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

否

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

否

String

系统提示信息,执行成功时,信息可能为空。

connections

否

Array of Objects

跨源连接信息列表,详细信息请参考表4。

count

否

Integer

返回的跨源连接个数。

表4 connections参数

参数名称

是否必选

参数类型

说明

id

否

String

连接ID,用于标识跨源连接的UUID。

name

否

String

创建连接时,用户自定义的连接名称。

status

否

String

连接状态,包括以下两种状态:

  • ACTIVE:已激活
  • DELETED:已删除

available_queue_info

否

Array of Objects

各个队列创建跨源连接的信息,详细信息请参考表5。

dest_vpc_id

否

String

对应服务的虚拟私有云标识。

dest_network_id

否

String

对应服务的子网网络标识。

isPrivis

否

Boolean

该增强跨源连接如果做过项目赋权,则该字段是“false”,否则为“true”。

create_time

否

Long

创建连接的时间。为UTC的时间戳。

hosts

否

Array of Objects

用户自定义主机信息,详细信息参见表6。

表5 available_queue_info参数说明

参数名称

是否必选

参数类型

说明

peer_id

否

String

跨源连接ID。

status

否

String

连接状态,状态码请参考表7。

name

否

String

队列名称。

err_msg

否

String

状态为失败时的详细报错信息。

update_time

否

Long

更新时间。

表6 hosts参数说明

参数名称

是否必选

参数类型

说明

name

否

String

自定义主机名称。

ip

否

String

主机对应的IPv4地址。

表7 连接状态

名称

含义

说明

CREATING

创建中

跨源连接正在创建中。

ACTIVE

已激活

跨源连接创建成功,与目的地址连接正常。

FAILED

失败

跨源连接创建失败。

请求示例

无

响应示例

{
  "is_success": true,
  "message": "",
  "count": 1,
  "connections": [
    {
      "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",
      "isPrivis": true,
      "create_time": 1566888011125,
      "status": "ACTIVE"
    }
  ]
}

状态码

状态码如表8所示。

表8 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。