文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点服务功能> 查询连接终端节点服务的连接列表
更新时间:2023-12-07 GMT+08:00
分享

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

功能介绍

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

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

vpc_endpoint_service_id

String

终端节点服务的ID。

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

id

String

终端节点的ID,唯一标识。

最小长度:1

最大长度:64

marker_id

String

终端节点的报文标识。

status

String

终端节点的连接状态。

  • pendingAcceptance:待接受

  • accepted:已接受

  • rejected:已拒绝

  • failed:失败

sort_key

String

查询结果中终端节点列表的排序字段,取值为:

  • create_at:终端节点的创建时间

  • update_at:终端节点的更新时间 默认值为create_at。

缺省值:create_at

sort_dir

String

查询结果中终端节点列表的排序方式,取值为:

  • desc:降序排序

  • asc:升序排序 默认值为desc。

缺省值:desc

limit

Integer

查询返回终端节点服务的连接列表限制每页个数,即每页返回的个数。 取值范围:0~1000,取值一般为10,20或者50,默认为10。

最小值:1

最大值:1000

缺省值:10

offset

Integer

偏移量。 偏移量为一个大于0小于终端节点服务总个数的整数, 表示从偏移量后面的终端节点服务开始查询。

最小值:0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json, 如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:application/json

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

connections

Array of ConnectionEndpoints objects

连接列表。

total_count

Integer

满足查询条件的终端节点总条数,不受分页(即limit、offset参数)影响。

表5 ConnectionEndpoints

参数

参数类型

描述

id

String

终端节点的ID,唯一标识。

最小长度:1

最大长度:64

marker_id

Integer

终端节点的报文标识。

created_at

String

终端节点的创建时间。 采用UTC时间格式,格式为:YYYY-MMDDTHH:MM:SSZ

updated_at

String

终端节点的更新时间。 采用UTC时间格式,格式为:YYYY-MMDDTHH:MM:SSZ

domain_id

String

用户的Domain ID。

最小长度:1

最大长度:64

error

Array of QueryError objects

错误信息。

当终端节点服务状态异常,即“status”的值为“failed”时,会返回该字段。

status

String

终端节点的连接状态。

  • pendingAcceptance:待接受

  • creating:创建中

  • accepted:已接受

  • rejected:已拒绝

  • failed:失败

  • deleting:删除中

description

String

终端节点连接描述。

最小长度:0

最大长度:512

表6 QueryError

参数

参数类型

描述

error_code

String

错误编码。

最小长度:0

最大长度:10

error_message

String

错误信息。

最小长度:0

最大长度:1024

请求示例

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

GET https://{endpoint}/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}

查询连接ID为“4189d3c2-8882-4871-a3c2-d380272eed88”的终端节点服务连接列表。 GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections

响应示例

状态码: 200

服务器已成功处理了请求

{
  "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
}

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码

分享:

    相关文档

    相关产品