AllocateDdosIpAddresses

1. 接口描述

调用本接口用于创建一个或多个Ddos IP。

准备工作

• 查询区域可购买的Ddos IP：调用DescribeDdosIpAvailableResources查看指定地区的资源供给情况。

• 成本估算：了解Ddos IP的的计费方式。更多详情，请参见计费方式概述。

注意事项

• 预付费Ddos IP的购买会预先扣除本次Ddos IP购买所需金额，后付费Ddos IP购买时需要确保用户账号状态正常。

• 调用本接口创建Ddos IP，支持代金券自动抵扣，详情请参考代金券选用规则。

• 本接口为异步接口，当创建Ddos IP请求下发成功后会返回一个ID列表，此时创建Ddos IP操作并未立即完成。在此期间Ddos IP的状态将会处于CREATING，Ddos IP创建结果可以通过调用DescribeDdosIpAddresses 接口查询，如果Ddos IP状态由CREATING(创建中)变为AVAILABLE，则代表Ddos IP创建成功，CREATE_FAILED代表Ddos IP创建失败，创建过程中不可对Ddos IP进行任何操作。

• 单次最多能创建100个Ddos IP。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
zoneId	是	String	DDoS IP所属的可用区ID。
ddosIpChargeType	是	String	付费类型。 PREPAID：预付费，即包年包月。 POSTPAID：后付费。
ddosIpChargePrepaid	否	ChargePrepaid	预付费模式。 即包年包月相关参数设置。 通过该参数可以指定包年包月实例的购买时长等属性。 若指定实例的付费模式为预付费则该参数必传。
amount	否	Integer	指定创建Ddos IP的数量。 范围为 1-100。 默认值：1。
resourceGroupId	否	String	资源组ID。 如果不指定，则会放入默认资源组。如果用户没有默认资源组权限， 则请求将会失败。

3. 响应结果

参数名称	类型	描述
ddosIpIdSet	Array of String	Ddos IP 的ID列表。 当通过本接口来创建Ddos IP时会返回该参数，表示一个或多个Ddos IP ID。返回Ddos IP ID列表并不代表Ddos IP创建成功，可根据 DescribeDdosIpAddresses 接口查询对应Ddos IP ID的状态来判断创建是否完成；如果Ddos IP状态由CREATING(创建中)变为AVAILABLE，则为创建成功。
orderNumber	String	订单编号。 当ddosIpChargeType为PREPAID时会返回。
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 代码示例

示例

1.用最简单的参数创建一个后付费的Ddos IP

创建一个SEL-A区域后付费的Ddos IP

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: AllocateDdosIpAddresses
<Common Request Params>

Request：
{
    "ddosIpChargeType": "POSTPAID",
    "zoneId": "SEL-A"
}

Response：
{
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "response": { 
        "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
        "ddosIpIdSet": ["ddosIpId1"],
        "orderNumber" : ""
    }
}

2. 创建2个预付费的Ddos IP

创建2个SEL-A区域1个月预付费Ddos IP

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: AllocateDdosIpAddresses
<Common Request Params>

Request：
{
    "ddosIpChargeType": "PREPAID",
    "zoneId": "SEL-A",
    "amount": 2,
    "ddosIpChargePrepaid": {
        "period": 1
    }
}

Response：
{
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "response": { 
        "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
        "ddosIpIdSet": ["ddosIpId1","ddosIpId2"],
        "orderNumber" : "orderNumber1"
    }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
404	INVALID_ZONE_NOT_FOUND	指定的可用区不存在。
400	INVALID_DDOS_IP_TYPE_ZONE_NO_SELL	指定Ddos IP在指定的可用区未售卖。
400	MISSING_PARAMETER	指定的参数为空。