# 创建IP地址组 - CreateIpGroup
#### 功能介绍
创建IP地址组。
该接口属于异步接口，会先返回一个IP地址组ID，但后台的创建任务仍在执行；可以使用查询IP地址组详情接口查询状态，当IP地址组状态为ACTIVE时，表示IP地址组创建完成。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-ga/ga_03_0000.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ga/ga_06_0000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项               | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | ga:ipgroup:create | Write | ipgroup \*  | -   | -  | -      |
     
#### URI
POST /v1/ip-groups
#### 请求参数
表1请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                       |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
表2请求Body参数 
| 参数       | 是否必选 | 参数类型                                                                      | 描述            |
|:---|:---|:---|:---|
| ip_group | 是    | [CreateIpGroupOption] object | 创建IP地址组的详细信息。 |
   
 表3CreateIpGroupOption 
| 参数          | 是否必选 | 参数类型                                                                                    | 描述                                         |
|:---|:---|:---|:---|
| name        | 是    | String                                                                                  | IP地址组名称，取值范围：1\~64个字符之间，只能由数字、字母、中划线和中文组成。 |
| description | 否    | String                                                                                  | IP地址组的描述信息，取值范围：0\~255个字符之间，禁止输入字符：\<\>。   |
| ip_list     | 否    | Array of [CreateIpGroupIpOption] objects | IP地址组中的IP网段列表，一次最多支持添加20个条目。               |
   
 表4CreateIpGroupIpOption 
| 参数          | 是否必选 | 参数类型   | 描述                                          |
|:---|:---|:---|:---|
| cidr        | 是    | String | IP地址组中的IP网段，cidr格式。                         |
| description | 否    | String | IP地址组中的IP网段描述，取值范围：0\~255个字符之间，禁止输入字符：\<\>。 |
   
#### 响应参数
**状态码：201**
表5响应Body参数 
| 参数         | 参数类型                                                           | 描述       |
|:---|:---|:---|
| request_id | String                                                         | 请求ID。    |
| ip_group   | [IpGroupDetail] object | IP地址组详情。 |
   
 表6IpGroupDetail 
| 参数                   | 参数类型                                                                                                 | 描述                                                            |
|:---|:---|:---|
| id                   | String                                                                                               | IP地址组ID。                                                      |
| name                 | String                                                                                               | IP地址组名称。                                                      |
| description          | String                                                                                               | IP地址组描述。                                                      |
| status               | String                                                                                               | 配置状态，取值： - ACTIVE：运行中 - PENDING：待定 - ERROR：错误 - DELETING：正在删除 |
| ip_list              | Array of [IpInfo] objects                                           | IP地址组中的IP网段列表。                                                |
| associated_listeners | Array of [ListenerAccessControlPolicy] objects | 监听器的访问控制策略。                                                   |
| created_at           | String                                                                                               | 创建时间。                                                         |
| updated_at           | String                                                                                               | 更新时间。                                                         |
   
 表7IpInfo 
| 参数          | 参数类型   | 描述                  |
|:---|:---|:---|
| cidr        | String | IP地址组中的IP网段，cidr格式。 |
| description | String | IP地址组中的IP网段描述。      |
| created_at  | String | 创建时间。               |
   
 表8ListenerAccessControlPolicy 
| 参数          | 参数类型   | 描述                                              |
|:---|:---|:---|
| listener_id | String | 监听器ID。                                          |
| type        | String | 访问控制策略类型,即黑名单还是白名单, 取值： - BLACK：黑名单 - WHITE：白名单 |
   
#### 请求示例
创建一个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 | 创建成功 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ga/ErrorCode.html)。