备案 控制台 登录 注册
文档中心 > AllocateEip
AllocateEip

最近更新时间：2021-12-24

请求方法：POST

接口描述：使用AllocateEip接口申请弹性公网IP（EIP）。


请求参数

Param

名称

类型

是否必选

描述

Action

String

是

要执行的操作，取值：AllocateEip。

RegionId

String

是

地域ID。
  HB1-BJMY （华北2-北京2） ；
  HD1-SHMY（华东1-上海）

Body

名称

类型

是否必选

描述

Bandwidth

Integer

是

公网IP规格。1-500

AzoneId

String

是

可用区ID。

ChargeType

String

是

付费类型，
  prepaid：预付费
  postpaid：后付费

InstanceCode

String

是

规格编码，默认为：eip.bgp.static

InstanceName

String

否

实例名称。

Note

String

否

注释。

PayType

String

是

计费类型
  YEAR_MONTH：包年包月

OrderCategory

String

是

订单类型

● 新购（NEW）

● 续费（RENEW）

● 升配（UPGRADE）

● 降配（DOWNGRADE）

ProductDescription

String

否

配置描述。

Quantity

Integer

是

数量。

RenewType

string

是

续费方式，包年包月必传，默认值为：manualrenew

后付费值为：notrenew

RentCount

String

是

包年包月时长，取值为：1,2,3,6,12,24,36

RentUnit

String

是

时长单位，包年包月必传，month


返回参数

名称

类型

描述

RequestId

String

请求ID。

Code

String

创建结果编码。

Msg

String

创建结果描述。

Res



+Resources

Array

新建的实例列表。

++EIP

String

分配的EIP的ID。

+OrderId

String

订单ID。


示例

请求示例

POST https://api.unicloud.com/networks/eip?Action=AllocateEip

&RegionId=HB1-BJMY

&公共请求参数


body

{

  "Bandwidth": 2,

  "AzoneId":"HB1-BJMYB",

  "ChargeType": "prepaid",

  "InstanceCode": "eip.bgp.static",

  "InstanceName": "company2",

  "OrderCategory": "NEW",

  "PayType": "YEAR_MONTH",

  "ProductDescription": "{'name':'company2','billingMethod':'YEAR_MONTH','conf':{'地域':'华北2-北京2','线路选择':'BGP静态','带宽':'2Mbps','计费周期':'包年包月'}}",

  "Quantity": 1,

  "RenewType": "manualrenew",

  "RentCount": 1,

  "RentUnit": "month"

}

返回示例

JSON 格式

{

    "Code": "Network.Success",

    "Msg": "创建订单成功",

    "Res": {

        "Resources": [

            {

                "EIP": "eip-toidxlehcx3ob"

            }

        ],

        "OrderId": "6689455866058559562"

    },

    "RequestId": "0298643f-ecbc-4d37-af29-4157ffd28557"

}