華為云計(jì)算 云知識 查詢終端節(jié)點(diǎn)組詳情ShowEndpointGroup
查詢終端節(jié)點(diǎn)組詳情ShowEndpointGroup

 

功能介紹

查詢終端節(jié)點(diǎn)組詳情。

調(diào)用方法

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

URI

GET /v1/endpoint-groups/{endpoint_group_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

endpoint_group_id

String

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

最小長度:1

最大長度:36

請求參數(shù)

表2 請求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

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

參數(shù)

參數(shù)類型

描述

endpoint_group

EndpointGroupDetail object

終端節(jié)點(diǎn)組實(shí)例。

request_id

String

請求ID。

表4 EndpointGroupDetail

參數(shù)

參數(shù)類型

描述

id

String

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

name

String

終端節(jié)點(diǎn)組名稱,取值范圍:1~64個字符之間,只能由數(shù)字、字母、中劃線和中文組成。

最小長度:1

最大長度:64

description

String

終端節(jié)點(diǎn)組描述信息,取值范圍:0~255個字符之間,禁止輸入字符:<>。

最小長度:0

最大長度:255

status

String

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

  • ACTIVE:運(yùn)行中

  • PENDING:待定

  • ERROR:錯誤

  • DELETING:正在刪除

枚舉值:

  • ACTIVE

  • PENDING

  • ERROR

  • DELETING

traffic_dial_percentage

Integer

流量撥分到此組的百分比。

最小值:0

最大值:100

region_id

String

終端節(jié)點(diǎn)組所屬區(qū)域ID。

最小長度:1

最大長度:36

listeners

Array of Id objects

關(guān)聯(lián)監(jiān)聽器列表。

數(shù)組長度:1 - 1

created_at

String

創(chuàng)建時間。

updated_at

String

更新時間。

domain_id

String

租戶ID。

frozen_info

FrozenInfo object

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

表5 Id

參數(shù)

參數(shù)類型

描述

id

String

關(guān)聯(lián)監(jiān)聽器ID。

最小長度:0

最大長度:36

表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

請求示例

查詢終端節(jié)點(diǎn)組詳情

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

響應(yīng)示例

狀態(tài)碼: 200

操作成功

{
  "endpoint_group" : {
    "id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
    "name" : "endpoint-group-name",
    "description" : "endpoint-group description",
    "status" : "ACTIVE",
    "traffic_dial_percentage" : 10,
    "region_id" : "ap-southeast-1",
    "listeners" : [ {
      "id" : "1b11747a-b139-492f-9692-2df0b1c87193"
    } ],
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    }
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

狀態(tài)碼

狀態(tài)碼

描述

200

操作成功

錯誤碼

請參見錯誤碼。