功能介紹
創(chuàng)建終端節(jié)點組。
調(diào)用方法
請參見如何調(diào)用API。
URI
POST /v1/endpoint-groups
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。通過調(diào)用 IAM 服務獲取用戶Token接口獲?。憫㈩^中X-Subject-Token的值)。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
endpoint_group |
是 |
創(chuàng)建終端節(jié)點組的詳細信息。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
終端節(jié)點組名稱,取值范圍:1~64個字符之間,只能由數(shù)字、字母、中劃線和中文組成。 最小長度:1 最大長度:64 |
|
description |
否 |
String |
終端節(jié)點組描述信息,取值范圍:0~255個字符之間,禁止輸入字符:<>。 最小長度:0 最大長度:255 |
|
traffic_dial_percentage |
否 |
Integer |
流量撥分到此組的百分比。 最小值:0 最大值:100 缺省值:100 |
|
region_id |
是 |
String |
終端節(jié)點組所屬區(qū)域ID。 最小長度:1 最大長度:36 |
|
listeners |
是 |
關(guān)聯(lián)監(jiān)聽器列表。一個終端節(jié)點組下僅支持關(guān)聯(lián)一個監(jiān)聽器。 數(shù)組長度:1 - 1 |
響應參數(shù)
狀態(tài)碼: 201
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
endpoint_group |
終端節(jié)點組實例。 |
|
|
request_id |
String |
請求ID。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
終端節(jié)點組ID。 |
|
name |
String |
終端節(jié)點組名稱,取值范圍:1~64個字符之間,只能由數(shù)字、字母、中劃線和中文組成。 最小長度: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 |
關(guān)聯(lián)監(jiān)聽器列表。 數(shù)組長度:1 - 1 |
|
|
created_at |
String |
創(chuàng)建時間。 |
|
updated_at |
String |
更新時間。 |
|
domain_id |
String |
租戶ID。 |
|
frozen_info |
云服務或資源實例凍結(jié)信息。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
status |
Integer |
云服務或資源實例狀態(tài),取值:
最小值:0 最大值:2 |
|
effect |
Integer |
在凍結(jié)/解凍操作下,取值:
最小值:1 最大值:3 缺省值:1 |
|
scene |
Array of strings |
更新云服務狀態(tài)的業(yè)務場景列表,取值:
最大長度:16 |
請求示例
創(chuàng)建一個終端節(jié)點組,流量調(diào)度占比為10%,所屬區(qū)域ID為ap-southeast-1。
POST https://{ga_endpoint}/v1/endpoint-groups
{
"endpoint_group" : {
"name" : "endpoint-group-name",
"description" : "endpoint-group description",
"traffic_dial_percentage" : 10,
"region_id" : "ap-southeast-1",
"listeners" : [ {
"id" : "1b11747a-b139-492f-9692-2df0b1c87193"
} ]
}
}
響應示例
狀態(tài)碼: 201
創(chuàng)建成功
{
"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)碼 |
描述 |
|---|---|
|
201 |
創(chuàng)建成功 |
錯誤碼
請參見錯誤碼。
