文档中心 API文档 节点列表查询

节点列表查询

更新时间:2022-11-23 21:09:26

适用产品

边缘云主机

接口描述

查询边缘计算平台有哪些节点可以提供服务。

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Params 参数

参数名称类型必填描述
sortKey
String排序的字段名称,可以有多个,取值:name、regionName、province
sortDir
String排序方向,必须跟在sortKey后面出现,取值:desc:降序,默认值 asc:升序
limit
Integer每个页面显示条数,默认是20
marker
String从marker指定的名称开始查询
regionName
String节点所属区域(详见附录)
province
String节点所属省份(详见附录)
carrier
String节点所属运营商(详见附录)
lineType
String线路类型:single -- 单线节点;double -- 双线节点;triple -- 三线节点;bgp -- BGP节点
ipv6Supported
String是否支持ipv6:True:支持ipv6 False:不支持ipv6
bmSupported
String该节点是否有裸机资源 True:有裸机资源 False:没有裸机资源,只有虚拟机资源

返回参数

Body 参数

参数名称类型描述
nodes
List节点信息数组
name
String节点名称,唯一
regionName
String节点所在区域
province
String节点所在省份
carrier
String节点所在运营商,如果是多线节点,则返回多个运营商,以'/'分隔
state
String节点状态:RUNNING ---节点可用;MAINTENANCE ---节点维护中,暂时不可用
lineType
String线路类型
ipv6Supported
String是否支持ipv6
bmSupported
String该节点是否有裸机资源

示例

JSON
JSON
请求示例
复制代码 复制成功
GET /nodes?province=jiangsu&carrier=wt
返回示例
复制代码 复制成功
{
    "nodes": [
        {
            "name": "JS-nantong3-DX",
            "regionName": "huadong",
            "province": "jiangsu",
            "carrier": "dx/wt",
            "state": "ACTIVE",
            "lineType": "double",
            "ipv6Supported": "False",
            "bmSupported": "False"
        }
    ]
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!