- 最新动态
- 产品介绍
- 快速入门
- 用户指南
- 开发指南
- 最佳实践
- API参考
- SDK参考
- 场景代码示例
-
常见问题
- 概念相关
-
节点管理
- 安装专业版节点异常如何处理?
- 安装专业版节点,执行安装命令时失败,一直提示“edgedaemon not found"?
- 安装专业版节点失败,提示“edge_core has existed”,该如何处理?
- 专业版节点所在机器断网/断电一段时间后恢复,节点模块一直处于“部署中”怎么处理?
- 专业版节点欠费充值后,部署、升级模块仍然报错?
- MQTT设备无法接入边缘节点如何处理?专业版节点所在机器断网/断电一段时间后恢复,节点模块一直处于“部署中”怎么处理?
- 误删除IoTDA上的edge_node/modbus_server产品后,在边缘服务创建节点/添加Modbus设备失败,该怎么处理?
- 边缘节点离线排查指南
- 修改专业版(Docker)或基础版节点的云端日志级别,但没有生效?
- ubuntu系统下节点shell命令兼容性导致的安装失败
- 子设备管理
- 应用管理
- 账号与权限
- Module-SDK
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询边缘模块
功能介绍
用户通过Console接口查询指定边缘节点上指定边缘模块
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见 获取项目ID。 |
edge_node_id |
是 |
String |
边缘节点ID |
module_id |
是 |
String |
边缘模块ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
edge_app_id |
String |
应用ID |
app_version |
String |
应用版本 |
state |
String |
模块运行状态 |
control_status |
String |
模块管控状态 |
node_id |
String |
边缘节点(同deviceID)ID |
module_name |
String |
模块名称 |
module_id |
String |
模块ID |
create_time |
String |
创建时间 |
update_time |
String |
最后一次修改时间 |
app_type |
String |
应用类型 |
function_type |
String |
功能类型 |
container_settings |
容器相关配置 |
参数 |
参数类型 |
描述 |
---|---|---|
configs |
ContainerConfigsResDTO object |
容器相关配置 |
custom_envs |
Object |
自定义环境变量 |
extra_hosts |
Array of DNSConfigDTO objects |
域名解析配置集合 |
参数 |
参数类型 |
描述 |
---|---|---|
host_network |
Boolean |
是否使用主机网络模式 |
container_port_list |
Array of ContainerPortDTO objects |
容器端口映射值 |
请求示例
GET https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}
响应示例
状态码:200
OK
{
"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",
"container_settings" : {
"configs" : {
"host_network" : false,
"container_port_list" : [ {
"container_port" : 65535,
"host_port" : 65535,
"host_ip" : "string"
} ]
}
}
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。