# 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      | Array of [ByoipCreateItem](https://docs.console.zenlayer.com/api-reference/compute/datastructure#byoipcreateitem) | The list of BYOIPs to be created.                                                                                                                                                                 |
| marketingInfo   | No       | [MarketingInfo](https://docs.console.zenlayer.com/api-reference/compute/datastructure#marketinginfo)              | Information on marketing campaigns.                                                                                                                                                               |
| resourceGroupId | No       | String                                                                                                            | <p>The ID of the resource group where the BYOIP CIDR block will reside after creation.</p><p>If the value is not passed in, the BYOIP CIDR block will be put into the default resource group.</p> |
| tags            | No       | [TagAssociation](https://docs.console.zenlayer.com/api-reference/compute/datastructure#tagassociation)            | <p>Tags associated when creating resources.</p><p>Note: The associated <code>tag key</code> cannot be duplicated.</p>                                                                             |

## 3. Output Parameters

| Parameter Name | Type            | Description                                                                                                           |
| -------------- | --------------- | --------------------------------------------------------------------------------------------------------------------- |
| requestId      | String          | <p>The unique request ID, which is returned for each request.</p><p>RequestId is required for locating a problem.</p> |
| 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

{% tabs %}
{% tab title="Example" %}
**Create a BYOIP CIDR block.**

```json
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>"]
  }
}
```

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](https://docs.console.zenlayer.com/api-reference/api-introduction/toolkit/api-sdk)，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](https://docs.console.zenlayer.com/api-reference/api-introduction/instruction/commonerrorcode).

| 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. |