DescribeCloudRouters
1. 接口描述
调用本接口用于查询一个或多个指定三层网络的信息。用户可以根据 ID、名称等信息来进行搜索。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
参数名称
必选
类型
描述
cloudRouterIds
否
Array of String
三层网络的ID。 长度不能超过100个。
cloudRouterName
否
String
三层网络的名称。 该条件为模糊匹配。
cloudRouterStatus
否
String
三层网络的状态。 见:CloudRouterStatus
egdePointId
否
String
边缘连接点的ID。
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: DescribeCloudRouters
<Common Request Params>
Request:
{}
Response:
{
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"response": {
"requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
"dataSet": [
{
"resourceGroupName":"Default Resource Group",
"cloudRouterStatus":"RUNNING",
"edgePoints":[
{
"dataCenter":{
"dcId":"LAX5",
"cityName":"Los Angeles",
"areaName":"North America",
"dcName":"DRT",
"dcAddress":"600 West 7th Street Los Angeles, CA 90017",
"countryName":"United States"
},
"ipAddress":"4.4.4.4/24",
"portId":"your-portId",
"edgePointId":"the edge point id",
"bgpConnection":{
"password":"",
"peerIpAddress":"4.4.4.3",
"localAsn":62610,
"peerAsn":6543
},
"createTime":"2023-10-27T07:14:46Z",
"edgePointName":"LAX5-1698390478681",
"connectivityStatus":"DOWN",
"bandwidthMbps":1
},
{
"dataCenter":{
"dcId":"SOF1",
"cityName":"Sofia",
"areaName":"Europe",
"dcName":"Equinix_SO2",
"dcAddress":"N33 Nedelcho Bonchev str, Sofia, Bulgaria",
"countryName":"Bulgaria"
},
"vlanId":1061,
"ipAddress":"5.5.5.5/24",
"portId":"your port id",
"edgePointId":"the edge point id",
"bgpConnection":{
"password":"",
"peerIpAddress":"5.5.5.4",
"localAsn":62610,
"peerAsn":3456
},
"createTime":"2023-10-27T07:14:46Z",
"edgePointName":"SOF1-1698391290880",
"connectivityStatus":"DOWN",
"bandwidthMbps":1
}
],
"createTime":"2023-10-27T07:14:46Z",
"cloudRouterId":"cloud-router-id",
"resourceGroupId":"c91db3f4-b15e-4323-9a12-fd3f0330b74b",
"cloudRouterName":"Test",
"connectivityStatus":"ABNORMAL",
"cloudRouterDescription":"",
"cloudRouterChargeType":"POSTPAID"
}
],
totalCount: 1
}
}
5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。
6. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码
HTTP状态码
错误码
说明
最后更新于