AvailableIPs

1. API Description

This API is used to query the IPs of a CIDR block.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
cidrBlockId	Yes	String	ID of the CIDR block. You can find the cidrBlockId in the response by calling CIDRDetails.
instanceId	No	String	ID of the instance. You can find the instanceId in the response by calling InstanceDetails.
ip	No	String	IP address.

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.
cidrBlockIps	Array of CidrBlockIp	IPs of the CIDR block.

4. Code Example

Example

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

Request:
{
  "cidrBlockId": "aCidrBlockId"
}

Response:
{
  "requestId": "T91F2EF61-762D-4401-A18B-3D626386C4CC",
  "response": {
    "requestId": "T91F2EF61-762D-4401-A18B-3D626386C4CC",
    "cidrBlockIps": [
      {
        "cidrBlockId": "aCidrBlockId",
        "cidrBlockType": "IPV6",
        "ip": "2602:ffe4:1:11::1",
        "instanceId": "bindedInstanceId",
        "status": "BINDED"
      }
    ]
  }
}

5. Error Codes

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