查询访问端点 - ListEndpoints
功能介绍
查询访问端点。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/endpoints
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户资源空间ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,偏移量不能小于0 |
|
limit |
否 |
Integer |
每页显示的条目数量,不能小于1或大于1000 |
|
sort |
否 |
String |
指定查询排序 |
|
type |
否 |
String |
指定查询访问端点的类型 |
|
name |
否 |
String |
指定查询访问端点的名称 |
|
vpc_id |
否 |
String |
指定查询访问端点的vpcId |
|
fuzzy_name |
否 |
String |
指定查询访问端点的名称,模糊查询 |
|
subnet_id |
否 |
String |
指定查询访问端点的SubnetId |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
总数 |
|
size |
Integer |
本页数量 |
|
items |
Array of EndpointInfo objects |
对象列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
访问端点ID |
|
name |
String |
用户指定的访问端点名称 |
|
vpc_id |
String |
访问端点所在的VPC的ID |
|
subnet_id |
String |
访问端点所在的子网的ID |
|
domain |
String |
访问域名 |
|
description |
String |
描述 |
|
status |
String |
访问端点状态 |
|
error_info |
ErrorInfo object |
错误信息 |
|
type |
String |
访问端点类型 |
|
scalable |
Boolean |
是否可更新 |
|
created_time |
String |
创建UTC时间 |
|
updated_time |
String |
更新UTC时间 |
|
endpoints |
Array of EndpointConnection objects |
访问端点终端节点列表 |
请求示例
查询访问端点
GET https://{eg_endpoint}/v1/{project_id}/endpoints
响应示例
状态码:200
访问端点列表
{
"total" : 1,
"size" : 1,
"items" : [ { } ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
访问端点列表 |
错误码
请参见错误码。