DescribePrivateConnects
1. 接口描述
调用本接口用于查询一条或多条指定二层网络专线的信息。用户可以根据 ID、名称等信息来进行搜索。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
参数名称
必选
类型
描述
privateConnectIds
否
Array of String
二层网络专线ID列表。 最多支持100个ID查询。
privateConnectName
否
String
二层网络专线的名称。 该条件为模糊匹配。
resourceGroupId
否
String
资源组的ID。
如果不传,则返回该用户可见的所有资源组内的二层网络专线。
pageNum
否
Integer
返回的分页数。
默认为1。
pageSize
否
Integer
返回的分页大小。
默认为20,最大为1000。
3. 响应结果
参数名称
类型
描述
requestId
String
唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount
Integer
符合条件的二层网络专线总数量。
4. 代码示例
1. 获取二层网络专线列表
POST /api/v2/sdn HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribePrivateConnects
<Common Request Params>
Request:
{}
Response:
{
"requestId": "TDB181167-C39F-4C3E-8E88-B8FDE755FDC0",
"response": {
"requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
"dataSet": [
{
"endpointA":{
"endpointType":"PORT",
"dataCenter":{
"dcId":"SIN1",
"cityName":"Singapore",
"areaName":"Asia Pacific",
"dcName":"Equinix_SG1",
"dcAddress":"20 Ayer Rajah Crescent, Ayer Rajah Industrial Park, Singapore 139964",
"countryName":"Singapore"
},
"vlanId":"1001",
"endpointId":"endpoint A id",
"endpointName":"portName",
"connectivityStatus":"ACTIVE"
},
"resourceGroupName":"Default Resource Group",
"createTime":"2023-01-01T00:00:00Z",
"privateConnectStatus":"RUNNING",
"privateConnectName":"private-name",
"endpointZ":{
"endpointType":"PORT",
"dataCenter":{
"dcId":"SIN1",
"cityName":"Singapore",
"areaName":"Asia Pacific",
"dcName":"Equinix_SG1",
"dcAddress":"20 Ayer Rajah Crescent, Ayer Rajah Industrial Park, Singapore 139964",
"countryName":"Singapore"
},
"vlanId":1002,
"endpointId":"endpoint z id",
"endpointName":"SIN1-10G",
"connectivityStatus":"ACTIVE"
},
"resourceGroupId":"resource-group-id",
"privateConnectId":"private-connect-id",
"connectivityStatus":"ACTIVE",
"bandwidthMbps":10
}
],
"totalCount": 1
}
}
5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。
6. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码
HTTP状态码
错误码
说明
最后更新于