Doc CenterSign in to zenConsole

CreateIpv6Block

1. API Description

This API is used to create one or more IPv6 CIDR blocks.

Prerequisites

Note

  • An IPv6 CIDR block contains 500 available IPs.

  • This API is an async API. A CIDR block ID list is returned after the creation request is sent. However, it does not mean the creation has been completed. The status of the CIDR block will be CREATING during the creation. You can use DescribeCidrBlocks to query the status of the CIDR block. If the status changes from Creating to Available, it means that the CIDR block has been created successfully; CREATE_FAILED means the CIDR block has been created failed. Any operations on the instances are not allowed while creating.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

zoneId

Yes

String

Zone ID to which the CIDR blocks belong.

name

No

String

CIDR block name to be displayed.

This parameter can contain up to 64 characters.

amount

No

Integer

Quantity of IPv6 CIDR blocks you want to purchase.

Default value: 1.

resourceGroupId

No

String

Resource group ID where the CIDR blocks reside.

If an available VLAN exists in the specified zone, this parameter will be ignored. The created CIDR blocks will be added to the resource group of the VLAN.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

cidrBlockIds

Array of String

List of CIDR block IDs.

4. Code Example

Create an IPv6 CIDR block example **** in IST-B, belonging to Default Resource Group.

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

Request:
{
  "zoneId": "ISB-B",
  "name": "example",
  "amount": 1
}

Response:
{
  "requestId": "T17BD4918-239C-4633-9F3A-9D2D5E0BA4E2",
  "response": {
    "requestId": "T17BD4918-239C-4633-9F3A-9D2D5E0BA4E2",
    "cidrBlockIds": [
      "cidrBlockId"
    ]
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code
Error Code
Description

404

INVALID_ZONE_NOT_FOUND

Zone not found.

403

RESOURCE_INSUFFICIENT_PRODUCT_SOLD_OUT

Resources sold out.

Last updated