申请私有IP

功能介绍

申请私有IP。

URI

POST /v1/{project_id}/privateips

请求消息

• 请求参数

  表2 请求参数

  名称	是否必选	参数类型	说明
  privateips	是	Array of privateip objects	私有IP列表对象，请参见表3。

  表3 privateip字段说明

  名称	是否必选	参数类型	说明
  subnet_id	是	String	分配IP的子网标识
  ip_address	否	String	功能说明：指定IP地址申请 取值范围：子网网段中的可以使用且未分配的IP地址，不指定时由系统自动分配

• 请求样例

  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。

  表5 privateip字段说明

  名称	参数类型	说明
  status	String	功能说明：私有IP的状态 取值范围： ACTIVE：活动的 DOWN：不可用
  id	String	私有IP标识
  subnet_id	String	分配IP的子网标识
  tenant_id	String	项目ID
  device_owner	String	功能说明：私有IP的使用者，空表示未使用 取值范围：network:dhcp，network:router_interface_distributed，compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用)，neutron:VIP_PORT 约束：此处的取值范围只是本服务支持的类型，其他类型未做标注
  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"
          }
      ]
  }

状态码

请参见状态码。

错误码

请参考错误码。