DescribePrivateConnectAvailablePorts

1. 接口描述

调用本接口用于查询可用于加入二层网络专线的物理端口列表。

注意事项

目前只允许连通性状态为ACTIVE的端口加入到二层网络专线中。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

portIds

否

Array of String

物理端口ID。

dcId

否

String

数据中心ID。

pageNum

否

Integer

返回的分页数。

默认为1。

pageSize

否

Integer

返回的分页大小。

默认为20，最大为100。

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

dataSet

Array of PortInfo

可加入二层网络专线的物理端口列表。

totalCount

Integer

符合条件的物理端口总数量。

4. 代码示例

1. 获取可加入二层网络的端口列表。

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

Request：
{}

Response：
{   
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
     "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",
            "connectionStatus":"ACTIVE",
            "portStatus":"RUNNING",
            "loaStatus":"LOA_NOT_UPLOAD",
            "createdTime":"YYYY-MM-DDThh:mm:ssZ",
            "expiredTime":"YYYY-MM-DDThh:mm:ssZ",
            "portChargeType":"POSTPAID"
        }
     ],
     "totalCount": 1
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

最后更新于1年前