api:tunnel:describe-node

获取节点信息-DescribeNode

1. 接口描述

指令接口名称:DescribeNode 获取云专线可到达的节点信息。

2. 输入参数

参数名称 必选 类型 描述
nodeIds.n String 节点ID,例如nodeIds.0代表希望获取信息的节点1,nodeIds.1代表节点2。 如果为空,则返回当前的所有符合条件的节点。每次请求的数量上限为100。
city String 所在城市,如北京、上海、杭州。必须省略“市”。
offset Int 初始行的偏移量,默认为0。
limit Int 每页行数,默认为20,最大支持50。
orderField String 按某个字段排序,目前仅支持createDate排序,默认按createDate排序
orderDirection String 升序(asc)还是降序(desc),默认:desc。

3. 输出参数

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

nodeSet

参数名称 类型 描述 必须 
nodeId String 节点ID
nodeCode String 节点编号
name String 云专线名称
city String 所在城市
property String 节点属性。值为:
cloud_node:云节点
accessin_node:接入节点
idc_node:IDC节点
vpn_node:VPN节点
ecp_node:互联云节点
exchange_node:交换节点
可以有多项以空格分割,例如:“idc_node ecp_node”

4. 示例

请求:

https://api.syscxp.com/?Action=DescribeNode
&nodeIds.0=node1
&nodeIds.1=node2
&offset=0
&limit=20
&<公共请求参数>

响应:

{
"code": 0,
"message": "",
    "totalCount": 2,
    "nodeSet": [
        {
            "nodeId": "node1",
            "nodeCode": "WH-NODE",
            "name": "武汉诚意接入机房",
            "city": "武汉",
            "property": "accessin_node exchange_node",
        }{
            "nodeId": "node2",
            "nodeCode": "SH-NODE",
            "name": "上海漕宝路机房",
            "city": "武汉",
            "property": "idc_node",
        }
    ]
}
如有疑问请联系 技术支持

页面工具