查询终端节点列表
功能介绍
查询终端节点列表。
URI
GET /v2.1/endpoints
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| direction | 是 | String | 终端节点方向。 取值： inbound，表示入站终端节点。 outbound，表示出站终端节点。 |
| vpc_id | 否 | String | 待查询的终端节点所属VPC的ID。 |
| name | 否 | String | 终端节点名称。 |
| limit | 否 | Integer | 每页返回的资源个数。 取值范围：0~500 取值一般为10，20，50。默认值为500。 |
| offset | 否 | Integer | 分页查询起始偏移量，表示从偏移量的下一个资源开始查询。 取值范围：0~2147483647 默认值为0。 当前设置marker不为空时，以marker为分页起始标识。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| endpoints | Array of EndpointResp objects | 查询终端节点列表响应。 |
| metadata | metadata object | 返回满足过滤条件的资源总数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 终端节点的ID，UUID形式的一个资源标识。 |
| name | String | 终端节点的名称。 |
| direction | String | 终端节点方向。 取值： inbound，表示入站终端节点。 outbound，表示出站终端节点。 |
| status | String | 资源状态。 |
| vpc_id | String | 终端节点所属的VPC ID。 |
| ipaddress_count | Integer | 该终端节点下的IP地址数量。 |
| resolver_rule_count | Integer | 该终端节点下的转发规则数量。 仅创建出站终端节点时返回该参数。 |
| create_time | String | 创建时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS。 |
| update_time | String | 更新时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS。 |
请求示例
无
响应示例
状态码：200
查询终端节点列表响应。
{
"endpoints" : [ {
"id" : "ff80808169bf16c70169bf1d02270000",
"name" : "poi-666",
"direction" : "inbound",
"status" : "ACTIVE",
"vpc_id" : "02443811-acf1-4c22-8f44-e3adf19f6097",
"ipaddress_count" : 6,
"resolver_rule_count" : 0,
"create_time" : "2019-03-27T12:25:43.181",
"update_time" : "2019-03-27T12:25:43.181"
}, {
"id" : "ff80808169be28130169be2e9dc40004",
"name" : "poi-667",
"direction" : "inbound",
"status" : "ACTIVE",
"vpc_id" : "02443811-acf1-4c22-8f44-e3adf19f6097",
"ipaddress_count" : 6,
"resolver_rule_count" : 0,
"create_time" : "2019-03-27T08:05:19.916",
"update_time" : "2019-03-27T08:05:19.916"
} ],
"metadata" : {
"total_count" : 2
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询终端节点列表响应。 |
错误码
请参见错误码。
