功能介绍
查询连接当前用户下的某一个 终端节点 服务的连接列表。marker_id是连接的唯一标识。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 最小长度：1 |
|
vpc_endpoint_service_id |
是 |
String |
终端节点服务的ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
终端节点的ID，唯一标识。 |
|
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 |
请求参数
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
connections |
连接列表。 |
|
|
total_count |
Integer |
满足查询条件的终端节点总条数，不受分页（即limit、offset参数）影响。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
终端节点的ID，唯一标识。 |
|
marker_id |
Integer |
终端节点的报文标识。 |
|
created_at |
String |
终端节点的创建时间。 采用UTC时间格式，格式为：YYYY-MMDDTHH:MM:SSZ |
|
updated_at |
String |
终端节点的更新时间。 采用UTC时间格式，格式为：YYYY-MMDDTHH:MM:SSZ |
|
domain_id |
String |
用户的Domain ID。 |
|
error |
错误信息。 当终端节点服务状态异常，即“status”的值为“failed”时，会返回该字段。 |
|
|
status |
String |
终端节点的连接状态。 ● pendingAcceptance：待接受 ● creating：创建中 ● accepted：已接受 ● rejected：已拒绝 ● failed：失败 ● deleting：删除中 |
|
description |
String |
终端节点连接描述。 |
状态码： 400
状态码： 401
状态码： 403
状态码： 404
状态码： 405
状态码： 406
状态码： 407
状态码： 408
状态码： 409
状态码： 500
状态码： 501
状态码： 502
状态码： 503
状态码： 504
请求示例
查询连接终端节点服务的连接列表
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 |
服务器已成功处理了请求 |
|
400 |
服务器未能处理请求 |
|
401 |
被请求的页面需要用户名和密码 |
|
403 |
对被请求页面的访问被禁止 |
|
404 |
服务器无法找到被请求的页面 |
|
405 |
请求中指定的方法不被允许 |
|
406 |
服务器生成的响应无法被客户端所接受 |
|
407 |
用户必须首先使用代理服务器进行验证，这样请求才会被处理 |
|
408 |
请求超出了服务器的等待时间 |
|
409 |
由于冲突，请求无法被完成 |
|
500 |
请求未完成。服务异常 |
|
501 |
请求未完成。服务器不支持所请求的功能 |
|
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
|
503 |
请求未完成。系统暂时异常 |
|
504 |
网关超时 |
错误码
请参见错误码。
