查询边缘模块列表
功能介绍
用户通过Console接口查询指定边缘节点上边缘模块列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/edge-nodes/{edge_node_id}/modules
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 |
edge_node_id |
是 |
String |
边缘节点ID 最小长度：1 最大长度：64 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Integer |
查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：1000000 缺省值：0 |
limit |
否 |
Integer |
每页记录数，默认值为10，取值区间为1-1000 最小值：1 最大值：1000 缺省值：10 |
app_type |
否 |
String |
应用类型 最小长度：0 最大长度：64 枚举值：
|
function_type |
否 |
String |
功能类型 最小长度：0 最大长度：64 枚举值：
|
function_types |
否 |
Array |
功能类型列表 数组长度：0 - 1000 |
protocol_types |
否 |
Array |
协议类型列表 数组长度：0 - 100 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
count |
Long |
总记录数 最小值：0 最大值：1000000 |
page_info |
PageInfoDTO object |
分页信息 |
modules |
Array of EdgeModuleDTO objects |
每页记录数 数组长度：0 - 1000 |
参数 |
参数类型 |
描述 |
|---|---|---|
edge_app_id |
String |
应用ID 最小长度：0 最大长度：64 |
app_version |
String |
应用版本 最小长度：0 最大长度：64 |
state |
String |
模块运行状态 枚举值：
|
control_status |
String |
模块管控状态 |
node_id |
String |
边缘节点（同deviceID）ID 最小长度：0 最大长度：64 |
module_name |
String |
模块名称 最小长度：0 最大长度：256 |
module_id |
String |
模块ID 最小长度：0 最大长度：64 |
create_time |
String |
创建时间 最小长度：0 最大长度：256 |
update_time |
String |
最后一次修改时间 最小长度：0 最大长度：256 |
app_type |
String |
应用类型 枚举值：
|
function_type |
String |
功能类型 枚举值：
|
请求示例
GET https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/modules
响应示例
状态码： 200
OK
{
"count" : 1000000,
"page_info" : {
"offset" : 1000000,
"limit" : 1000
},
"modules" : [ {
"edge_app_id" : "test-app",
"app_version" : "1.0.0",
"state" : "PENDING",
"control_status" : "0000000000000000",
"node_id" : "test-node",
"module_name" : "edge_module",
"module_id" : "test-module-id",
"create_time" : "2020-05-28T11:31:29.740Z",
"update_time" : "2020-05-28T11:31:29.740Z",
"app_type" : "SYSTEM_REQUIRED",
"function_type" : "DATA_PROCESSING"
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
401 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。
