CreateByoip

1. API Description

This API (CreateByoip) is used to Create a BYOIP CIDR block . Returns the list of RPKI/IRR validation failures.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

byoipList

Yes

The list of BYOIPs to be created.

marketingInfo

No

Information on marketing campaigns.

resourceGroupId

No

String

The ID of the resource group where the BYOIP CIDR block will reside after creation.

If the value is not passed in, the BYOIP CIDR block will be put into the default resource group.

tags

No

Tags associated when creating resources.

Note: The associated tag key cannot be duplicated.

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.

rpkiFailedList

Array of String

List of CIDR blocks that failed RPKI validation.

irrFailedList

Array of String

List of CIDR blocks that failed IRR validation.

byoipIds

Array of String

ID list of created BYOIP CIDR blocks.

4. Code Example

Create a BYOIP CIDR block.

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

Request:
{
  "byoIpList": [
    {
      "cidrBlock": "88.0.2.0/24",
      "networkType": "PremiumBGP",
      "regionId": "asia-east-1",
      "asn": 62610
    }
  ]
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "rpkiFailedList": [],
    "irrFailedList": [],
    "byoipIds":["<byoIpId1>"]
  }
}

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

400

INVALID_BYOIP_ASN_INVALID

Invalid BYOIP ASN number.

400

INVALID_BYOIP_DUPLICATE

BYOIP is duplicated.

400

INVALID_BYOIP_IS_ALREADY_EXIST

BYOIP already exists.

400

INVALID_CIDR_ADDRESS

Invalid IP address.

400

INVALID_CIDR_FORMAT

The specified CIDR block format error.

400

INVALID_IPV6_CIDR_RANGE

The CIDR range is invalid.

400

INVALID_IPV6_SUBNET_MASK_LENGTH

IPv6 subnet mask length is out of valid range.

404

INVALID_REGION_NOT_FOUND

Specified availability zone does not exist.

400

OPERATION_DENIED_EIP_UNSUPPORT_NETWORK_TYPE

Elastic IP network billing model is not supported.

400

OPERATION_DENIED_NOT_SUPPORT_BYOIP_SELF

The selected BYOIP network type does not support self-advertisement in the specified region.

Last updated