DescribePorts

1. API Description

This API (DescribePorts) is used to get Ports

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
pageSize	No	Integer	Number of items per page. Value range: 1-1000. Value range: [1, 1000]
pageNum	No	Integer	Page number, starting from 1. Value range: [1, +) Default value: 1
portIds	No	Array of String	List of port IDs. Maximum length: 100.
portName	No	String	Port name, up to 255 characters. Supports fuzzy matching, case-insensitive.
dcId	No	String	Data center four-letter code. Obtainable via the DescribeDataCenters API.
cityName	No	String	City name, up to 64 characters. Supports fuzzy matching, case-insensitive.
resourceGroupId	No	String	Resource group ID. If not specified, ports in all resource groups visible to the user are returned.
tagKeys	No	Array of String	Search by tag keys. Up to 20 tag keys.
tags	No	Array of Tag	Search by tags. Up to 20 tags.

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.
totalCount	Integer	Total number of records matching the criteria.
dataSet	Array of PortInfo	The result set of the port list.

4. Code Example

Example

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

Request: {
  "portIds": ["your-port-id"]
}

Response: {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "response": {
        "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
        "totalCount": 1,
        "dataSet": [
        {
            "portId":"your-port-id",
            "portName":"your-port-name",
            "portRemarks":"your-port-remark",
            "portType":"1G",
            "dcId":"SIN1",
            "dcName":"AP-Singapore1",
            "cityName":"Singapore",
            "areaName":"Asia Pacific",
            "businessEntityName":"your-business-entity-name",
            "connectionStatus":"ACTIVE",
            "portStatus":"RUNNING",
            "loaStatus":"LOA_NOT_UPLOAD",
            "loaDownloadUrl":"your-loa-download-url",
            "createdTime":"YYYY-MM-ddTHH:mm:ssZ",
            "expiredTime":"YYYY-MM-ddTHH:mm:ssZ",
            "period":12,
            "isCreateBusinessAllowed":true
        }]
    }
}

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