查询公共终端节点服务列表
功能介绍
查询公共终端节点服务的列表，公共终端节点服务是所有用户可见且可连接的终端节点服务， 由运维人员创建，用户可直接使用，但无权创建。
调用方法
请参见如何调用API。
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 |
sort_dir |
否 |
String |
查询结果中终端节点服务列表的排序方式，取值为：
缺省值：desc |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
否 |
String |
发送的实体的MIME类型。推荐用户默认使用application/json， 如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
endpoint_services |
Array of EndpointService objects |
终端节点服务列表。 |
total_count |
Integer |
满足查询条件的公共终端节点服务总条数，不受分页（即limit、offset参数）影响。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
公共终端节点服务的ID，唯一标识。 最小长度：1 最大长度：64 |
owner |
String |
终端节点服务的所有者。 |
service_name |
String |
公共终端节点服务的名称。 |
service_type |
String |
终端节点服务类型。
|
created_at |
String |
终端节点服务的创建时间。 采用UTC时间格式，格式为：YYYYMM-DDTHH:MM:SSZ |
is_charge |
Boolean |
连接该终端节点服务的终端节点是否计费。
|
enable_policy |
Boolean |
是否允许自定义终端节点策略。
|
请求示例
查询公共终端节点服务列表
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 |
服务器已成功处理了请求 |
错误码
请参见错误码。
