文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点功能> 查询公共终端节点服务列表
更新时间:2022-04-27 GMT+08:00
分享

查询公共终端节点服务列表

功能介绍

查询公共终端节点服务的列表,公共终端节点服务是所有用户可见且可连接的终端节点服务,由运维人员创建,用户可直接使用,但无权创建。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/vpc-endpoint-services/public

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

查询返回公共的终端节点服务数量限制,即每页返回的个数。

取值范围:0~1000,取值一般为10,20或者50,默认为10。

最小值:1

缺省值:10

最小长度:0

最大长度:1000

offset

Integer

偏移量。

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

最小值:0

endpoint_service_name

String

公共终端节点服务的名称,支持大小写以及模糊匹配。

最小长度:1

最大长度:128

id

String

公共终端节点服务的ID,唯一标识。

最小长度:1

最大长度:64

sort_key

String

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

  • create_at:终端节点服务的创建时间
  • update_at:终端节点服务的更新时间

缺省值:create_at

最小长度:1

最大长度:32

sort_dir

String

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

  • desc:降序排序
  • asc:升序排序

缺省值:desc

最小长度:1

最大长度:32

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:2048

Content-Type

String

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

最小长度:1

最大长度:64

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

endpoint_services

Array of EndpointService objects

终端节点服务列表。

total_count

Integer

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

表5 EndpointService

参数

参数类型

描述

id

String

公共终端节点服务的ID,唯一标识。

owner

String

终端节点服务的所有者。

service_name

String

公共终端节点服务的名称。

service_type

String

终端节点服务类型。

  • gataway:由运维人员配置。用户无需创建,可直接使用。
  • interface:包括运维人员配置的云服务和用户自己创建的私有服务。

其中,运维人员配置的云服务无需创建, 用户可直接使用。 您可以通过创建终端节点访问Gateway和Interface类型终端节点服务。

created_at

String

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

is_charge

Boolean

连接该终端节点服务的终端节点是否计费。

  • true:计费
  • false:不计费

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表7 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表9 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 403

表10 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表11 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 404

表12 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表13 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 405

表14 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表15 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 406

表16 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表17 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 407

表18 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表19 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 408

表20 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表21 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 409

表22 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表23 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 500

表24 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表25 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 501

表26 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表27 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 502

表28 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表29 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 503

表30 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表31 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 504

表32 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表33 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

请求示例

GET https://{vpc_endpoint}/v1/{project_id}/vpc-endpoint-services/public?limit={limit}&offset={offset}&endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}&sort_key={sort_key}&sort_dir={sort_dir}

响应示例

状态码: 200

服务器已成功处理了请求

"{\n  \"endpoint_services\": [\n    {\n      \"id\": \"b0e22f6f-26f4-461c-b140-d873464d4fa0\",\n      \"owner\": \"example\"\n      \"service_name\": \"test123\",\n      \"service_type\": \"interface\",\n      \"created_at\": \"2018-09-10T13:13:23Z\",\n      \"is_charge\": \"true\"\n    },\n\t{\n      \"id\": \"26391a76-546b-42a9-b2fc-496ec68c0e4d\",\n      \"owner\": \"example\"\n      \"service_name\":  \"OBS\",\n      \"service_type\": \"gateway\",\n      \"created_at\": \"2019-03-28T09:30:27Z\",\n      \"is_charge\": \"true\"\n    }\n  ],\n  \"total_count\": 2\n}"

状态码

状态码

描述

200

服务器已成功处理了请求

400

服务器未能处理请求

401

被请求的页面需要用户名和密码

403

对被请求页面的访问被禁止

404

服务器无法找到被请求的页面

405

请求中指定的方法不被允许

406

服务器生成的响应无法被客户端所接受

407

用户必须首先使用代理服务器进行验证,这样请求才会被处理

408

请求超出了服务器的等待时间

409

由于冲突,请求无法被完成

500

请求未完成。服务异常

501

请求未完成。服务器不支持所请求的功能

502

请求未完成。服务器从上游服务器收到一个无效的响应

503

请求未完成。系统暂时异常

504

网关超时

错误码

请参见错误码

分享:

    相关文档

    相关产品

close