DescribePorts
DescribePorts
1. 接口描述
本接口用于查询端口列表。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
参数名称
是否必选
类型
描述
portIds
否
Array of String
端口id列表。
最大支持长度为100。
portName
否
String
端口名称。
最长不超过255个字符。支持模糊匹配、忽略大小写。
portRemarks
否
String
端口备注信息。
最长不超过255个字符。支持模糊匹配、忽略大小写。
cityName
否
String
城市名称。
最长不超过64个字符。支持模糊匹配、忽略大小写。
3. 响应结果
参数名称
类型
描述
requestId
String
唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 requestId。
totalCount
Integer
符合条件的数据总数。
4. 代码示例
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",
"connectionStatus":"ACTIVE",
"portStatus":"RUNNING",
"loaStatus":"LOA_NOT_UPLOAD",
"createdTime":"YYYY-MM-DDThh:mm:ssZ",
"expiredTime":"YYYY-MM-DDThh:mm:ssZ",
"portChargeType":"POSTPAID"
}]
}
}
5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。
6. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码
HTTP状态码
错误码
说明
7105
SELF_SERVICE_PORT_NOT_FOUND
端口未找到。
最后更新于