查询连接终端节点服务的连接列表-凯发k8国际娱乐官网入口
功能介绍
查询连接当前用户下的某一个终端节点服务的连接列表。marker_id是连接的唯一标识。
调用方法
请参见。
uri
get /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
string |
项目id。 最小长度:1 最大长度:64 |
vpc_endpoint_service_id |
是 |
string |
终端节点服务的id。 最小长度:1 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
string |
终端节点的id,唯一标识。 最小长度:1 最大长度:64 |
marker_id |
否 |
string |
终端节点的报文标识。 |
status |
否 |
string |
终端节点的连接状态。
|
sort_key |
否 |
string |
查询结果中终端节点列表的排序字段,取值为:
缺省值:create_at |
sort_dir |
否 |
string |
查询结果中终端节点列表的排序方式,取值为:
缺省值:desc |
limit |
否 |
integer |
查询返回终端节点服务的连接列表限制每页个数,即每页返回的个数。 取值范围:0~1000,取值一般为10,20或者50,默认为10。 最小值:1 最大值:1000 缺省值:10 |
offset |
否 |
integer |
偏移量。 偏移量为一个大于0小于终端节点服务总个数的整数, 表示从偏移量后面的终端节点服务开始查询。 最小值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
x-auth-token |
是 |
string |
用户token。通过调用iam服务获取用户token接口获取(响应消息头中x-subject-token的值)。 |
content-type |
否 |
string |
发送的实体的mime类型。推荐用户默认使用application/json, 如果api是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
connections |
array of connectionendpoints objects |
连接列表。 |
total_count |
integer |
满足查询条件的终端节点总条数,不受分页(即limit、offset参数)影响。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
终端节点的连接状态。
|
description |
string |
终端节点连接描述。 最小长度:0 最大长度:512 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
服务器已成功处理了请求 |
错误码
请参见。
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨