華為云計(jì)算 云知識 查詢終端節(jié)點(diǎn)組下終端節(jié)點(diǎn)列表ListEndpointsga
查詢終端節(jié)點(diǎn)組下終端節(jié)點(diǎn)列表ListEndpointsga

 

功能介紹

查詢終端節(jié)點(diǎn)組下終端節(jié)點(diǎn)列表。

調(diào)用方法

請參見如何調(diào)用API

URI

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

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

endpoint_group_id

String

終端節(jié)點(diǎn)組ID。

最小長度:1

最大長度:36

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

limit

Integer

分頁查詢每頁的資源個(gè)數(shù)。如果不設(shè)置,則默認(rèn)為500。

最小值:1

最大值:2000

缺省值:500

marker

String

分頁查詢的起始的資源ID,表示上一頁最后一條查詢資源記錄的ID。不指定時(shí)表示查詢第一頁。 必須與limit一起使用。

最小長度:1

最大長度:36

page_reverse

Boolean

分頁的順序,true表示從后往前分頁,false表示從前往后分頁,默認(rèn)為false。

缺省值:false

id

String

資源ID。

最小長度:0

最大長度:36

status

String

配置狀態(tài),可選范圍:

  • ACTIVE:運(yùn)行中

  • PENDING:待定

  • ERROR:錯(cuò)誤

  • DELETING:正在刪除

最小長度:1

最大長度:10

枚舉值:

  • ACTIVE

  • PENDING

  • ERROR

  • DELETING

請求參數(shù)

表3 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)。

響應(yīng)參數(shù)

狀態(tài)碼: 200

表4 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

endpoints

Array of EndpointDetail objects

終端節(jié)點(diǎn)列表。

page_info

PageInfo object

分頁查詢頁的信息。

request_id

String

請求ID。

表5 EndpointDetail

參數(shù)

參數(shù)類型

描述

id

String

終端節(jié)點(diǎn)ID。

resource_id

String

對應(yīng)后端資源ID。

endpoint_group_id

String

終端節(jié)點(diǎn)組ID。

resource_type

String

終端節(jié)點(diǎn)類型。

枚舉值:

  • EIP

status

String

配置狀態(tài),取值:

  • ACTIVE:運(yùn)行中

  • PENDING:待定

  • ERROR:錯(cuò)誤

  • DELETING:正在刪除

枚舉值:

  • ACTIVE

  • PENDING

  • ERROR

  • DELETING

weight

Integer

終端節(jié)點(diǎn)權(quán)重。

最小值:0

最大值:100

health_state

String

終端的健康狀態(tài),取值:

  • INITIAL:初始

  • HEALTHY:正常

  • UNHEALTHY:異常

  • NO_MONITOR:未監(jiān)控

枚舉值:

  • INITIAL

  • HEALTHY

  • UNHEALTHY

  • NO_MONITOR

created_at

String

創(chuàng)建時(shí)間。

updated_at

String

更新時(shí)間。

domain_id

String

租戶ID。

ip_address

String

IP地址。

frozen_info

FrozenInfo object

云服務(wù)或資源實(shí)例凍結(jié)信息。

表6 FrozenInfo

參數(shù)

參數(shù)類型

描述

status

Integer

云服務(wù)或資源實(shí)例狀態(tài),取值:

  • 0:解凍/正常(云服務(wù)恢復(fù)正常)。

  • 1:凍結(jié)(資源和數(shù)據(jù)會保留,但租戶無法再正常使用云服務(wù))。

  • 2:刪除/終止(資源和數(shù)據(jù)將清除)。

最小值:0

最大值:2

effect

Integer

在凍結(jié)/解凍操作下,取值:

  • 1(默認(rèn)值):凍結(jié)可釋放。

  • 2:凍結(jié)不可釋放。

  • 3:凍結(jié)后不可續(xù)費(fèi)。

最小值:1

最大值:3

缺省值:1

scene

Array of strings

更新云服務(wù)狀態(tài)的業(yè)務(wù)場景列表,取值:

  • ARREAR(默認(rèn)值):欠費(fèi)場景。為正常的運(yùn)營業(yè)務(wù)場景,包括包周期資源到期、按需資源扣費(fèi)失敗。

  • POLICE:公安凍結(jié)場景。

  • ILLEGAL:違規(guī)凍結(jié)場景。

  • VERIFY:客戶未實(shí)名認(rèn)證凍結(jié)場景。

  • PARTNER:合作伙伴凍結(jié)(合作伙伴凍結(jié)子客戶資源)。

最大長度:16

表7 PageInfo

參數(shù)

參數(shù)類型

描述

next_marker

String

下一頁的marker,為空時(shí)表示最后一頁。

current_count

Integer

當(dāng)前列表中資源數(shù)量。

請求示例

查詢終端節(jié)點(diǎn)組下終端節(jié)點(diǎn)列表

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

響應(yīng)示例

狀態(tài)碼: 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"
}

狀態(tài)碼

狀態(tài)碼

描述

200

操作成功

錯(cuò)誤碼

請參見錯(cuò)誤碼。