查询终端节点服务列表
功能介绍
查询当前用户下的终端节点服务的列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/vpc-endpoint-services
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度：1 最大长度：64 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
endpoint_service_name |
否 |
String |
终端节点服务的名称，支持大小写，前后模糊匹配。 最小长度：1 最大长度：128 |
id |
否 |
String |
终端节点服务的ID，唯一标识。 |
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 |
public_border_group |
否 |
String |
筛选结果中匹配边缘属性的EPS |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
否 |
String |
发送的实体的MIME类型。推荐用户默认使用application/json， 如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
endpoint_services |
Array of ServiceList objects |
终端节点服务列表 |
total_count |
Integer |
满足查询条件的终端节点服务总条数，不受分页（即limit、offset参数）影响。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
终端节点服务的ID，唯一标识。 最小长度：1 最大长度：64 |
port_id |
String |
标识终端节点服务后端资源的ID， 格式为通用唯一识别码（Universally Unique Identifier，下文简称UUID）。取值为：
|
service_name |
String |
终端节点服务的名称。 最小长度：0 最大长度：16 |
server_type |
String |
资源类型。
|
vpc_id |
String |
终端节点服务对应后端资源所在的VPC的ID。 最小长度：1 最大长度：64 |
approval_enabled |
Boolean |
是否需要审批。
|
status |
String |
终端节点服务的状态。
|
service_type |
String |
终端节点服务类型。 终端节点服务类型包括“网关（gateway）型”和“接口（interface）型”：
|
created_at |
String |
终端节点服务的创建时间。 采用UTC时间格式，格式为：YYYY-MMDDTHH:MM:SSZ |
updated_at |
String |
终端节点服务的更新时间。 采用UTC时间格式，格式为：YYYY-MMDDTHH:MM:SSZ |
project_id |
String |
项目ID，获取方法请参见获取项目ID。 最小长度：1 最大长度：64 |
domain_id |
String |
Domain ID 最小长度：1 最大长度：64 |
ports |
Array of PortList objects |
服务开放的端口映射列表 同一个终端节点服务下，不允许重复的端口映射。 若多个终端节点服务共用一个port_id， 则终端节点服务之间的所有端口映射的server_port和protocol的组合不能重复。 |
tags |
Array of TagList objects |
资源标签列表 |
connection_count |
Integer |
终端节点服务下连接的状态为“创建中”或“已接受”的终端节点的个数。 最小值：0 |
tcp_proxy |
String |
用于控制将哪些信息（如客户端的源IP、源端口、marker_id等）携带到服务端。 支持携带的客户端信息包括如下两种类型：
|
error |
Array of Error objects |
提交任务异常时返回的异常信息 |
description |
String |
描述字段，支持中英文字母、数字等字符，不支持“<”或“>”字符。 最小长度：0 最大长度：512 |
public_border_group |
String |
终端节点服务对应Pool的Public Border Group信息 |
enable_policy |
Boolean |
是否允许自定义终端节点策略。
|
参数 |
参数类型 |
描述 |
|---|---|---|
client_port |
Integer |
终端节点访问的端口。 终端节点提供给用户，作为访问终端节点服务的端口，范围1-65535。 最小值：1 最大值：65535 最小长度：1 最大长度：65535 |
server_port |
Integer |
终端节点服务的端口。 终端节点服务绑定了后端资源，作为提供服务的端口，范围1-65535。 最小值：1 最大值：65535 最小长度：1 最大长度：65535 |
protocol |
String |
端口映射协议，支持TCP。 缺省值：TCP |
请求示例
查询终端节点服务列表
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services?endpoint_service_name={endpoint_service_name}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}&status={status}
响应示例
状态码： 200
服务器已成功处理了请求
{
"endpoint_services" : [ {
"id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
"port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88",
"vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80",
"status" : "available",
"approval_enabled" : false,
"service_name" : "test123",
"server_type" : "VM",
"service_type" : "interface",
"ports" : [ {
"client_port" : "8080",
"server_port" : "80",
"protocol" : "TCP"
}, {
"client_port" : "8081",
"server_port" : "80",
"protocol" : "TCP"
} ],
"project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
"created_at" : "2022-04-14T09:35:47Z",
"updated_at" : "2022-04-14T09:36:47Z",
"public_border_group" : "br-abc-aaa1"
} ],
"total_count" : 1
}
状态码
状态码 |
描述 |
|---|---|
200 |
服务器已成功处理了请求 |
错误码
请参见错误码。
