华为云计算 云知识 查询终端节点组下终端节点列表ListEndpointsga
查询终端节点组下终端节点列表ListEndpointsga

 

功能介绍

查询 终端节点 组下终端节点列表。

调用方法

请参见如何调用API

URI

GET /v1/endpoint-groups/{endpoint_group_id}/endpoints

表1 路径参数

参数

是否必选

参数类型

描述

endpoint_group_id

String

终端节点组ID。

最小长度:1

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

分页查询每页的资源个数。如果不设置,则默认为500。

最小值:1

最大值:2000

缺省值:500

marker

String

分页查询的起始的资源ID,表示上一页最后一条查询资源记录的ID。不指定时表示查询第一页。 必须与limit一起使用。

最小长度:1

最大长度:36

page_reverse

Boolean

分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。

缺省值:false

id

String

资源ID。

最小长度:0

最大长度:36

status

String

配置状态,可选范围:

  • ACTIVE:运行中

  • PENDING:待定

  • ERROR:错误

  • DELETING:正在删除

最小长度:1

最大长度:10

枚举值:

  • ACTIVE

  • PENDING

  • ERROR

  • DELETING

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

endpoints

Array of EndpointDetail objects

终端节点列表。

page_info

PageInfo object

分页查询页的信息。

request_id

String

请求ID。

表5 EndpointDetail

参数

参数类型

描述

id

String

终端节点ID。

resource_id

String

对应后端资源ID。

endpoint_group_id

String

终端节点组ID。

resource_type

String

终端节点类型。

枚举值:

  • EIP

status

String

配置状态,取值:

  • ACTIVE:运行中

  • PENDING:待定

  • ERROR:错误

  • DELETING:正在删除

枚举值:

  • ACTIVE

  • PENDING

  • ERROR

  • DELETING

weight

Integer

终端节点权重。

最小值:0

最大值:100

health_state

String

终端的健康状态,取值:

  • INITIAL:初始

  • HEALTHY:正常

  • UNHEALTHY:异常

  • NO_MONITOR:未监控

枚举值:

  • INITIAL

  • HEALTHY

  • UNHEALTHY

  • NO_MONITOR

created_at

String

创建时间。

updated_at

String

更新时间。

domain_id

String

租户ID。

ip_address

String

IP地址。

frozen_info

FrozenInfo object

云服务 或资源实例冻结信息。

表6 FrozenInfo

参数

参数类型

描述

status

Integer

云服务或资源实例状态,取值:

  • 0:解冻/正常(云服务恢复正常)。

  • 1:冻结(资源和数据会保留,但租户无法再正常使用云服务)。

  • 2:删除/终止(资源和数据将清除)。

最小值:0

最大值:2

effect

Integer

在冻结/解冻操作下,取值:

  • 1(默认值):冻结可释放。

  • 2:冻结不可释放。

  • 3:冻结后不可续费。

最小值:1

最大值:3

缺省值:1

scene

Array of strings

更新云服务状态的业务场景列表,取值:

  • ARREAR(默认值):欠费场景。为正常的运营业务场景,包括包周期资源到期、按需资源扣费失败。

  • POLICE:公安冻结场景。

  • ILLEGAL:违规冻结场景。

  • VERIFY:客户未实名认证冻结场景。

  • PARTNER:合作伙伴冻结(合作伙伴冻结子客户资源)。

最大长度:16

表7 PageInfo

参数

参数类型

描述

next_marker

String

下一页的marker,为空时表示最后一页。

current_count

Integer

当前列表中资源数量。

请求示例

查询终端节点组下终端节点列表

GET https://{ga_endpoint}/v1/endpoint-groups/3a9f50bb-f041-4eac-a117-82472d8a0007/endpoints

响应示例

状态码: 200

操作成功

{
  "endpoints" : [ {
    "id" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d",
    "resource_id" : "08155cd2-5897-49be-933f-eec757fd4010",
    "endpoint_group_id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
    "resource_type" : "EIP",
    "status" : "ACTIVE",
    "weight" : 10,
    "health_state" : "HEALTHY",
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "ip_address" : "208.182.11.121",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    }
  } ],
  "page_info" : {
    "next_marker" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d",
    "current_count" : 1
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

状态码

状态码

描述

200

操作成功

错误码

请参见错误码

 

上一篇:事件文件 下一篇:Hugo文档手册学习与基本介绍