功能介绍
查询公共 终端节点 服务的列表，公共终端节点服务是所有用户可见且可连接的终端节点服务， 由运维人员创建，用户可直接使用，但无权创建。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/vpc-endpoint-services/public
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 最小长度：1 最大长度：64 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
查询返回公共的终端节点服务数量限制，即每页返回的个数。 取值范围：0~1000，取值一般为10，20或者50，默认为10。 最小值：1 最大值：1000 缺省值：10 |
|
offset |
否 |
Integer |
偏移量。 偏移量为一个大于0小于终端节点服务总个数的整数， 表示从偏移量后面的终端节点服务开始查询。 最小值：0 |
|
endpoint_service_name |
否 |
String |
公共终端节点服务的名称，支持大小写以及模糊匹配。 最小长度：1 最大长度：128 |
|
id |
否 |
String |
公共终端节点服务的ID，唯一标识。 最小长度：1 最大长度：64 |
|
sort_key |
否 |
String |
查询结果中终端节点服务列表的排序字段，取值为： ● create_at：终端节点服务的创建时间 ● update_at：终端节点服务的更新时间 默认值为create_at。 缺省值：create_at |
|
sort_dir |
否 |
String |
查询结果中终端节点服务列表的排序方式，取值为： ● desc：降序排序 ● asc：升序排序 默认值为desc。 缺省值：desc |
请求参数
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
endpoint_services |
终端节点服务列表。 |
|
|
total_count |
Integer |
满足查询条件的公共终端节点服务总条数，不受分页（即limit、offset参数）影响。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
公共终端节点服务的ID，唯一标识。 |
|
owner |
String |
终端节点服务的所有者。 |
|
service_name |
String |
公共终端节点服务的名称。 |
|
service_type |
String |
终端节点服务类型。 ● gataway：由运维人员配置。用户无需创建，可直接使用。 ● interface：包括运维人员配置的 云服务 和用户自己创建的私有服务。 其中，运维人员配置的云服务无需创建， 用户可直接使用。 您可以通过创建终端节点创建访问Gateway和Interface类型终端节点服务的终端节点。 |
|
created_at |
String |
终端节点服务的创建时间。 采用UTC时间格式，格式为：YYYYMM-DDTHH:MM:SSZ |
|
is_charge |
Boolean |
连接该终端节点服务的终端节点是否计费。 ● true：计费 ● false：不计费 |
|
enable_policy |
Boolean |
是否开启终端节点策略。 ● false：不支持设置终端节点策略 ● true：支持设置终端节点策略 默认为false 是否开启终端节点策略。 ● false：不支持设置终端节点策略 ● true：支持设置终端节点策略 默认为false |
状态码： 400
状态码： 401
状态码： 403
状态码： 404
状态码： 405
状态码： 406
状态码： 407
状态码： 408
状态码： 409
状态码： 500
状态码： 501
状态码： 502
状态码： 503
状态码： 504
请求示例
查询公共终端节点服务列表
GET https://{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
服务器已成功处理了请求
{
"endpoint_services" : [ {
"id" : "b0e22f6f-26f4-461c-b140-d873464d4fa0",
"owner" : "example",
"service_name" : "test123",
"service_type" : "interface",
"created_at" : "2018-09-10T13:13:23Z",
"is_charge" : "true"
}, {
"id" : "26391a76-546b-42a9-b2fc-496ec68c0e4d",
"owner" : "example",
"service_name" : "OBS",
"service_type" : "gateway",
"created_at" : "2019-03-28T09:30:27Z",
"is_charge" : "true"
} ],
"total_count" : 2
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
服务器已成功处理了请求 |
|
400 |
服务器未能处理请求 |
|
401 |
被请求的页面需要用户名和密码 |
|
403 |
对被请求页面的访问被禁止 |
|
404 |
服务器无法找到被请求的页面 |
|
405 |
请求中指定的方法不被允许 |
|
406 |
服务器生成的响应无法被客户端所接受 |
|
407 |
用户必须首先使用代理服务器进行验证，这样请求才会被处理 |
|
408 |
请求超出了服务器的等待时间 |
|
409 |
由于冲突，请求无法被完成 |
|
500 |
请求未完成。服务异常 |
|
501 |
请求未完成。服务器不支持所请求的功能 |
|
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
|
503 |
请求未完成。系统暂时异常 |
|
504 |
网关超时 |
错误码
请参见错误码。
