AvailableLanIp

1. API Description

This API is used to obtain the available private IP.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

cidrId

Yes

String

CIDR ID.

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.

lanIps

Array of PrivateIpInfo

Information on private IP.

4. Code Example

Obtain available private IP.

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

Request:
{
  "cidrId": "xxx"
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "lanIps": [
      {
        "lanIp": "xxx",
        "nicId": "xxx",
        "nicName": "xxx",
        "instanceId": "xxx",
        "instanceName": "xxx"
      }
    ]
  }
}

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

No error codes related to the API business logic. For other error codes, see Common Error Codes.​

Last updated