Doc CenterSign in to zenConsole

DescribeCloudRouterAvailablePorts

1. API Description

This API is used to query available ports that can be added into a Layer 3 cloud router.

Note

Only ports in state of ACTIVE can be added into a Layer 3 cloud router currently.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

portIds

No

Array of String

Port ID.

dcId

No

String

Data center ID.

pageNum

No

Integer

Number of pages returned.

Default value: 1.

pageSize

No

Integer

Number of items in the current page result.

Default value: 20;

Maximum value: 1000.

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.

dataSet

Information on ports.

totalCount

Integer

Number of ports meeting the filtering conditions.

4. Code Example

Query available ports that can be added into a Layer 3 cloud router.

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

Request：
{}

Response：
{   
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E"，
     "dataSet": [
        {
            "loaStatus":"LOA_UPLOADED",
            "portChargeType":"POSTPAID",
            "portStatus":"RUNNING",
            "portName":"portName",
            "portId":"your-port-id",
            "portType":"1G",
            "dcId":"SHA12",
            "cityName":"Shanghai",
            "areaName":"China",
            "dcName":"云立方",
            "connectionStatus":"ACTIVE",
            "createdTime":"2023-08-23T02:16:05Z",
            "portRemarks":"portRemarks"
        }
     ],
     totalCount: 1
  }
}

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