创建IP地址组CreateIpGroup
功能介绍
创建IP地址组。 该接口属于异步接口，会先返回一个IP地址组ID，但后台的创建任务仍在执行；可以使用查询IP地址组详情接口查询状态，当IP地址组状态为ACTIVE时，表示IP地址组创建完成。
调用方法
请参见如何调用API。
URI
POST /v1/ip-groups
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
IP地址组ID。 |
|
name |
String |
IP地址组名称。 最小长度：1 最大长度：64 |
|
description |
String |
IP地址组描述。 最小长度：0 最大长度：255 |
|
status |
String |
配置状态，取值：
枚举值：
|
|
ip_list |
IP地址组中的IP网段列表。 |
|
|
associated_listeners |
监听器的访问控制策略。 |
|
|
created_at |
String |
创建时间。 |
|
updated_at |
String |
更新时间。 |
请求示例
创建一个IP地址组，IP网段为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"
} ]
}
}
响应示例
状态码： 201
创建成功
{
"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"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
创建成功 |
错误码
请参见错误码。
