更新时间:2022-05-05 GMT+08:00
分享

查询边缘节点列表

功能介绍

查询边缘节点列表

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/edge-nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见 获取项目ID

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

name

String

节点名称

最小长度:1

最大长度:64

state

String

节点状态,OFFLINE|ONLINE|UNINSTALLED|INSTALLED|DELETING|UPGRADING|FROZEN

最小长度:1

最大长度:32

type

String

节点所属资源类型,advanced|standard

最小长度:1

最大长度:32

instance_id

String

实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。

最小长度:1

最大长度:36

space_id

String

资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,可以携带该参数查询指定资源空间下的设备列表,不携带该参数则会查询该用户下所有设备列表。

最小长度:1

最大长度:36

node_ids

Array

节点id列表,查询ID在给的节点ID列表内的节点信息

offset

Integer

查询的起始位置,取值范围为非负整数,默认为0

最小值:0

最大值:1000000

缺省值:0

limit

Integer

每页记录数,默认值为10,取值区间为1-1000

最小值:1

最大值:1000

缺省值:10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

最小长度:0

最大长度:20000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Long

总记录数

最小值:0

最大值:1000000

page_info

PageInfoDTO object

分页信息

nodes

Array of EdgeNodeDTO objects

节点列表

表5 PageInfoDTO

参数

参数类型

描述

offset

Integer

页码

最小值:0

最大值:1000000

limit

Integer

每页记录数

最小值:1

最大值:1000

表6 EdgeNodeDTO

参数

参数类型

描述

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

name

String

边缘节点名称

最小长度:1

最大长度:64

state

String

边缘节点状态UNINSTALLED|INSTALLED|OFFLINE|ONLINE|DELETING|FROZEN

最小长度:4

最大长度:32

instance_id

String

实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。

最小长度:1

最大长度:36

space_id

String

资源空间id,对应IOTDA云服务接口参数中的app_id。

最小长度:1

最大长度:64

type

String

节点所属资源类型:advanced|standard

最小长度:4

最大长度:16

resource_ids

Array of strings

节点所购买的资源类型的列表

最小长度:4

最大长度:16

resource_spec_types

Array of strings

节点所购买的资源类型的列表

最小长度:4

最大长度:16

ips

Array of strings

边缘节点ip列表

create_time

String

边缘节点创建时间

最小长度:0

最大长度:256

请求示例

GET https://{endpoint}/v2/{project_id}/edge-nodes

响应示例

状态码

状态码

描述

200

Ok

401

Bad Request

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close