功能介紹
查詢終端節(jié)點組列表。
調用方法
請參見如何調用API。
URI
GET /v1/endpoint-groups
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
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 |
|
name |
否 |
String |
資源名稱，取值范圍：0~64個字符之間，只能由數字、字母、中劃線和中文組成。 最小長度：0 最大長度：64 |
|
status |
否 |
String |
配置狀態(tài)，可選范圍:
最小長度：1 最大長度：10 枚舉值：
|
|
listener_id |
否 |
String |
監(jiān)聽器ID |
請求參數
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。通過調用 IAM 服務獲取用戶Token接口獲?。憫㈩^中X-Subject-Token的值）。 |
響應參數
狀態(tài)碼： 200
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
endpoint_groups |
終端節(jié)點組列表。 |
|
|
page_info |
分頁查詢頁的信息。 |
|
|
request_id |
String |
請求ID。 |
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
id |
String |
終端節(jié)點組ID。 |
|
name |
String |
終端節(jié)點組名稱，取值范圍：1~64個字符之間，只能由數字、字母、中劃線和中文組成。 最小長度：1 最大長度：64 |
|
description |
String |
終端節(jié)點組描述信息，取值范圍：0~255個字符之間，禁止輸入字符：<>。 最小長度：0 最大長度：255 |
|
status |
String |
配置狀態(tài)，取值：
枚舉值：
|
|
traffic_dial_percentage |
Integer |
流量撥分到此組的百分比。 最小值：0 最大值：100 |
|
region_id |
String |
終端節(jié)點組所屬區(qū)域ID。 最小長度：1 最大長度：36 |
|
listeners |
關聯(lián)監(jiān)聽器列表。 數組長度：1 - 1 |
|
|
created_at |
String |
創(chuàng)建時間。 |
|
updated_at |
String |
更新時間。 |
|
domain_id |
String |
租戶ID。 |
|
frozen_info |
云服務或資源實例凍結信息。 |
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
status |
Integer |
云服務或資源實例狀態(tài)，取值：
最小值：0 最大值：2 |
|
effect |
Integer |
在凍結/解凍操作下，取值：
最小值：1 最大值：3 缺省值：1 |
|
scene |
Array of strings |
更新云服務狀態(tài)的業(yè)務場景列表，取值：
最大長度：16 |
請求示例
查詢終端節(jié)點組列表
GET https://{ga_endpoint}/v1/endpoint-groups
響應示例
狀態(tài)碼： 200
操作成功
{
"endpoint_groups" : [ {
"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" ]
}
} ],
"page_info" : {
"next_marker" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
"current_count" : 1
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
操作成功 |
錯誤碼
請參見錯誤碼。
