功能介紹
創(chuàng)建IP地址組。 該接口屬于異步接口，會(huì)先返回一個(gè)IP地址組ID，但后臺(tái)的創(chuàng)建任務(wù)仍在執(zhí)行；可以使用查詢IP地址組詳情接口查詢狀態(tài)，當(dāng)IP地址組狀態(tài)為ACTIVE時(shí)，表示IP地址組創(chuàng)建完成。
調(diào)用方法
請(qǐng)參見如何調(diào)用API。
URI
POST /v1/ip-groups
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值）。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
ip_group |
是 |
創(chuàng)建IP地址組的詳細(xì)信息。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
IP地址組名稱，取值范圍：1~64個(gè)字符之間，只能由數(shù)字、字母、中劃線和中文組成。 最小長(zhǎng)度：1 最大長(zhǎng)度：64 |
|
description |
否 |
String |
IP地址組的描述信息，取值范圍：0~255個(gè)字符之間，禁止輸入字符：<>。 最小長(zhǎng)度：0 最大長(zhǎng)度：255 |
|
ip_list |
否 |
IP地址組中的IP網(wǎng)段列表，一次最多支持添加20個(gè)條目。 數(shù)組長(zhǎng)度：1 - 20 |
響應(yīng)參數(shù)
狀態(tài)碼： 201
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
request_id |
String |
請(qǐng)求ID。 |
|
ip_group |
IP地址組詳情。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
IP地址組ID。 |
|
name |
String |
IP地址組名稱。 最小長(zhǎng)度：1 最大長(zhǎng)度：64 |
|
description |
String |
IP地址組描述。 最小長(zhǎng)度：0 最大長(zhǎng)度：255 |
|
status |
String |
配置狀態(tài)，取值：
枚舉值：
|
|
ip_list |
IP地址組中的IP網(wǎng)段列表。 |
|
|
associated_listeners |
監(jiān)聽器的訪問(wèn)控制策略。 |
|
|
created_at |
String |
創(chuàng)建時(shí)間。 |
|
updated_at |
String |
更新時(shí)間。 |
請(qǐng)求示例
創(chuàng)建一個(gè)IP地址組，IP網(wǎng)段為127.0.0.0/24。
POST https://{ga_endpoint}/v1/ip-groups
{
"ip_group" : {
"name" : "ip-group-name",
"description" : "ip-group description",
"ip_list" : [ {
"cidr" : "127.0.0.0/24",
"description" : "cidr description"
} ]
}
}
響應(yīng)示例
狀態(tài)碼： 201
創(chuàng)建成功
{
"request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
"ip_group" : {
"id" : "e8996cd6-28cf-4ff2-951e-fa8ac895a6cd",
"name" : "ip-group-name",
"description" : "ip-group description",
"status" : "ACTIVE",
"ip_list" : [ {
"cidr" : "127.0.0.0/24",
"description" : "cidr description",
"created_at" : "2019-01-08T01:21:37.151Z"
} ],
"created_at" : "2019-01-08T01:21:37.151Z",
"updated_at" : "2019-01-08T01:21:37.151Z"
}
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
201 |
創(chuàng)建成功 |
錯(cuò)誤碼
請(qǐng)參見錯(cuò)誤碼。
