查询连接终端节点服务的连接列表

功能介绍

查询连接当前用户下的某一个终端节点服务的连接列表。marker_id是连接的唯一标识。

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections?id={vpc_endpoint_id}&marker_id={marker_id}&status={status}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}

参数说明如表1所示。

表1 参数说明
参数	是否必选	描述
project_id	是	项目ID，获取方法请参见获取项目ID。
vpc_endpoint_service_id	是	终端节点服务的ID。

请求消息

参数说明

表2 请求参数
名称	是否必选	参数类型	描述
id	否	String	终端节点的ID，唯一标识。
marker_id	否	String	终端节点的报文标识。
status	否	String	终端节点的连接状态。 pendingAcceptance：待接受 accepted：已接受 rejected：已拒绝 failed：失败
sort_key	否	String	查询结果中终端节点列表的排序字段，取值为： create_at：终端节点的创建时间 update_at：终端节点的更新时间默认值为create_at。
sort_dir	否	String	查询结果中终端节点列表的排序方式，取值为： desc：降序排序 asc：升序排序默认值为desc。
limit	否	Integer	查询返回终端节点服务的连接列表限制每页个数，即每页返回的个数。取值范围：0~1000，取值一般为10，20或者50，默认为10。
offset	否	Integer	偏移量。偏移量为一个大于0小于终端节点服务总个数的整数，表示从偏移量后面的终端节点服务开始查询。

请求样例

查询连接ID为“4189d3c2-8882-4871-a3c2-d380272eed88”的终端节点服务连接列表。

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections

响应消息

参数说明

表3 响应参数
参数	参数类型	描述
connections	Array of objects	连接列表，详细内容请参见表4。
total_count	Integer	满足查询条件的终端节点总条数，不受分页（即limit、offset参数）影响。

表4 connection要素说明
属性	参数类型	描述
id	String	终端节点的ID，唯一标识。
marker_id	Integer	终端节点的报文标识。
created_at	String	终端节点的创建时间。采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ
updated_at	String	终端节点的更新时间。采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ
domain_id	String	用户的Domain ID。
status	String	终端节点的连接状态。 pendingAcceptance：待接受 creating：创建中 accepted：已接受 rejected：已拒绝 failed：失败 deleting：删除中
error	Array of objects	错误信息。当终端节点服务状态异常，即“status”的值为“failed”时，会返回该字段，详细内容请参见表5。

表5 Error要素说明
属性	参数类型	描述
error_code	String	错误编码。
error_message	String	错误信息。

响应样例

{
  "connections": [
    {
      "id": "adb7b229-bb11-4072-bcc0-3327cd784263",
      "status": "accepted",
      "marker_id": 16777510,
      "domain_id": "5fc973eea581490997e82ea11a1df31f",
      "created_at": "2018-09-17T11:10:11Z",
      "updated_at": "2018-09-17T11:10:12Z"
    },
    {
      "id": "fd69d29f-dc29-4a9b-80d8-b51d1e7e58ea",
      "status": "accepted",
      "marker_id": 16777513,
      "domain_id": "5fc973eea581490997e82ea11a1df31f",
      "created_at": "2018-09-17T07:28:56Z",
      "updated_at": "2018-09-17T07:28:58Z"
    }
  ],
  "total_count":2
}