
# 申请私有IP - CreatePrivateip
#### 功能介绍
申请私有IP。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=VPC&version=v2&api=CreatePrivateip)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpc/vpc_permission_0000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                   | 访问级别  | 资源类型（\*为必须）  | 条件键                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | vpc:privateIps:create | Write | privateIp \* | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | -  | -      |
  | vpc:privateIps:create | Write | subnet \*    | - [g:ResourceTag/\<tag-key\>](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html)  - vpc:SubnetId  - vpc:VpcId  - vpc:AvailabilityZone   | -  | -      |
     
  
 
#### URI
POST /v1/{project_id}/privateips
参数说明请参见[表1]。
 表1参数说明 
| 名称         | 是否必选 | 说明                                                                                 |
|:---|:---|:---|
| project_id | 是    | 项目ID，获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html)。 |
   
#### 请求参数
表2请求参数 
| 名称         | 是否必选 | 参数类型                                                             | 说明                                                                                                           |
|:---|:---|:---|:---|
| privateips | 是    | Array of [privateip] objects | 私有IP列表对象，请参见[表3]。 约束：默认最多申请20个私有IP |
   
 表3privateip字段说明 
| 名称         | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| subnet_id  | 是    | String | 分配IP的子网标识 如果您使用管理控制台，此值即为子网详情中的"网络ID"参数值。                                                                                                                                                                                      |
| ip_address | 否    | String | - 功能说明：指定IP地址申请  - 取值范围：子网网段中的可以使用且未分配的IP地址，不指定时由系统自动分配   |
   
#### 请求示例
- 创建两个私有IP，指定在id为531dec0f-3116-411b-a21b-e612e42349fd的子网中创建，一个ip地址自动分配，一个指定ip地址为192.168.1.17。
  ```
  POST https://{Endpoint}/v1/{project_id}/privateips
  {
    "privateips": 
     [ 
      {
          "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd"
      },
      {
          "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd",
           "ip_address": "192.168.1.17"
      }
     ]
  }
  ```
  
 
#### 响应参数
表4响应参数 
| 名称         | 参数类型                                                             | 说明                                                    |
|:---|:---|:---|
| privateips | Array of [privateip] objects | 私有IP列表对象，请参见[表5]。 |
   
 表5privateip字段说明 
| 名称           | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|
| status       | String | - 功能说明：私有IP的状态  - 取值范围： - ACTIVE：活动的  - DOWN：不可用                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| id           | String | 私有IP标识                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| subnet_id    | String | 分配IP的子网标识 如果您使用管理控制台，此值即为子网详情中的"网络ID"参数值。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| tenant_id    | String | 项目ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| device_owner | String | - 功能说明：私有IP的使用者，空表示未使用  - 取值范围： network:dhcp DHCP服务IP地址 network:router_interface_distributed 网关IP地址 compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用) 虚拟机网卡IP地址 neutron:VIP_PORT 虚拟IP地址 compute:subeni 辅助弹性网卡IP地址 neutron:LOADBALANCERV2 共享ELB使用的IP地址 neutron:LOADBALANCERV3 独享ELB使用的IP地址 network:endpoint_interface VPC终端节点使用的IP地址 network:nat_gateway NAT网关使用的IP地址   - 约束：此处的取值范围只是本服务支持的类型，其他类型未做标注   |
| ip_address   | String | 申请到的私有IP                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
   
#### 响应示例
```
{
    "privateips": [
        {
            "status": "DOWN",
            "id": "c60c2ce1-1e73-44bd-bf48-fd688448ff7b",
            "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd",
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "device_owner": "",
            "ip_address": "192.168.1.10"
        },
        {
            "status": "DOWN",
            "id": "4b123c18-ae92-4dfa-92cd-d44002359aa1",
            "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd",
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "device_owner": "",
            "ip_address": "192.168.1.17"
        }
    ]
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。
#### 错误码
请参考[错误码](https://support.huaweicloud.com/api-vpc/vpc_api_0003.html)。
