CreateIpv4Block

1. 接口描述

调用本接口创建一个或多个Ipv4 Cidr Block。

准备工作

查询可用资源：调用DescribeAvailableIpv4Resources查看指定地区的资源供给情况。
成本估算：了解Cidr Block的的计费方式。更多详情，请参见计费方式概述。

注意事项

预付费Cidr Block的购买会预先扣除本次购买所需金额，后付费Cidr Block购买时需要确保账户账号状态正常。
调用本接口创建Cidr Block，支持代金券自动抵扣，详情请参考代金券选用规则。
本接口为异步接口，当创建Cidr Block请求下发成功后会返回一个ID列表，此时创建Cidr Block操作并未立即完成。在此期间Cidr Block的状态将会处于CREATING，Cidr Block创建结果可以通过调用DescribeCidrBlocks 接口查询，如果Cidr Block状态由CREATING(创建中)变为AVAILABLE，则代表Cidr Block创建成功，CREATE_FAILED代表Cidr Block创建失败。创建过程中不可对Cidr Block进行任何操作。

2. 请求参数

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

参数名称必选类型描述

参数名称	必选	类型	描述
zoneId	是	String	Cidr Block所属的可用区ID。
name	否	String	Cidr Block的名称。不得超过64个字符。
chargeType	是	String	付费类型。 PREPAID：预付费，即包年包月 POSTPAID：后付费。
chargePrepaid	否	ChargePrepaid	预付费模式。即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长等属性。若指定Cidr Block的付费模式为预付费则该参数必传。
netmask	是	Integer	购买的掩码。取值范围1~32。可以从`DescribeAvailableIpv4Resource`接口中获取可用的掩码列表。
amount	否	Integer	购买的数量。默认为1。
resourceGroupId	否	String	Cidr Block所属的资源组ID。如果指定的区域内存在可用的VLAN，则会忽略该参数自动使用与VLAN相同的资源组。

zoneId

是

String

Cidr Block所属的可用区ID。

name

否

String

Cidr Block的名称。

不得超过64个字符。

chargeType

是

String

付费类型。

PREPAID：预付费，即包年包月

POSTPAID：后付费。

chargePrepaid

否

ChargePrepaid

预付费模式。

即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长等属性。若指定Cidr Block的付费模式为预付费则该参数必传。

netmask

是

Integer

购买的掩码。

取值范围1~32。

可以从DescribeAvailableIpv4Resource接口中获取可用的掩码列表。

amount

否

Integer

购买的数量。

默认为1。

resourceGroupId

否

String

Cidr Block所属的资源组ID。

如果指定的区域内存在可用的VLAN，则会忽略该参数自动使用与VLAN相同的资源组。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
orderNumber	String	订单编号。
cidrBlockIds	Array of String	Cidr Block ID列表。

参数名称

类型

描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

orderNumber

String

订单编号。

cidrBlockIds

Array of String

Cidr Block ID列表。

4. 代码示例

1. 创建一个后付费的Ipv4 Cidr Block

在区域**IST-B创建一个掩码为29，名称为example1**的Ipv4 Cidr Block，并且加入默认资源组。

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

Request:
{
  "zoneId": "IST-B",
  "name": "example1",
  "chargeType": "POSTPAID",
  "netmask": 29
}

Response:
{
  "requestId": "T135376EE-7090-4773-B81E-7FB38358B656",
  "response": {
    "requestId": "T135376EE-7090-4773-B81E-7FB38358B656",
    "orderNumber": "orderNum",
    "cidrBlockIds": [
      "cidrBlockId"
    ]
  }
}

2. 创建一个预付费的Ipv4 Cidr Block

在区域**AMS-D创建一个掩码为29，名称为example2**的Ipv4 Cidr Block，并且加入默认资源组。

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

Request:
{
  "zoneId": "AMS-D",
  "name": "example2",
  "chargeType": "PREPAID",
  "chargePrepaid": {
    "period": 1
  },
  "netmask": 29,
  "amount": 1
}

Response:
{
  "requestId": "T3B843750-5B98-421B-9D74-D3234C664760",
  "response": {
    "requestId": "T3B843750-5B98-421B-9D74-D3234C664760",
    "orderNumber": "orderNum",
    "cidrBlockIds": [
      "cidrBlockId"
    ]
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明
404	INVALID_ZONE_NOT_FOUND	指定的区域不存在。
403	OPERATION_DENIED_NETMASK_OUT_OF_STOCK	指定的掩码库存不足。
403	RESOURCE_INSUFFICIENT_PRODUCT_SOLD_OUT	指定的产品已售罄。

HTTP状态码

错误码

说明

404

INVALID_ZONE_NOT_FOUND

指定的区域不存在。

403

OPERATION_DENIED_NETMASK_OUT_OF_STOCK

指定的掩码库存不足。

403

RESOURCE_INSUFFICIENT_PRODUCT_SOLD_OUT

指定的产品已售罄。

最后更新于7个月前