api:tunnel:describe-tunnel

获取云专线信息-DescribeTunnel

1. 接口描述

指令接口名称:DescribeTunnel 获取云专线或云专线列表信息,并可根据云专线名称、云专线ID等参数进行过滤。

2. 输入参数

参数名称 必选 类型 描述
tunnelIds.n String 云专线的资源ID,例如tunnelIds.0代表希望获取信息的专线1,tunnelIds.1代表专线2。 如果为空,则返回当前的所有符合条件的云专线。每次请求的实例的上限为100。
offset Int 初始行的偏移量,默认为0。
limit Int 每页行数,默认为20,最大支持50。
orderField String 按某个字段排序,目前仅支持createDate排序,默认按createDate排序
orderDirection String 升序(asc)还是降序(desc),默认:desc。

3. 输出参数

参数名称 类型 描述 必须 
code Int 错误码,0: 成功,其他值: 失败。
message String 错误信息。
totalCount Int 查询结果总数量。
tunnelSet Array 云专线实例列表,每项参数可见下面 tunnelSet。

tunnelSet

参数名称 类型 描述 必须 
tunnelId String 云专线ID
name String 云专线名称
bandwidth Int 带宽
distance Int 专线公里数
state String 开通状况。可选值:
normal: 正常
applying: 申请中
deployed: 已开通
suspend: 中止
deleting: 删除中
error: 错误
unsupport: 暂无法开通
waiting: 等待中
status String 云专线状态。可选值:
normal: 正常
error: 中断
endpointAName String A节点名称
endpointBName String B节点名称
networkTypeName String 网络类型名称
createDate Int 创建时间,格式为Unix时间戳

4. 示例

请求:

https://api.syscxp.com/?Action=DescribeTunnel
&tunnelIds.0=tunnel1
&tunnelIds.1=tunnel2
&offset=0
&limit=20
&<公共请求参数>

响应:

{
"code": 0,
"message": "",
    "totalCount": 2,
    "tunnelSet": [
        {
            "tunnelId": "tunnel1",
            "name": "上海-香港-ecp-测试",
            "bandwidth": 1024000,
            "distance": 1000,
            "state": "normal",
            "status": "normal",
            "endpointAName": "D-东方广场数据中-HW",
            "endpointBName": "C-漕宝路数据中心-2",
            "networkTypeName": "专线网络",
            "createDate": 1234567890
        }{
            "tunnelId": "tunnel2",
            "name": "广州-北京-for-haproxy",
            "bandwidth": 1024000,
            "distance": 1000,
            "state": "normal",
            "status": "normal",
            "endpointAName": "D-东方广场数据中-HW",
            "endpointBName": "C-漕宝路数据中心-2",
            "networkTypeName": "专线网络",
            "createDate": 1254567890
        }
    ]
}
如有疑问请联系 技术支持

页面工具