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

查询边缘模块

功能介绍

用户通过Console接口查询指定边缘节点上指定边缘模块

调试

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

URI

GET /v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:64

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

module_id

String

边缘模块ID

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:20000

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

edge_app_id

String

应用ID

最小长度:0

最大长度:64

app_version

String

应用版本

最小长度:0

最大长度:64

state

String

模块运行状态

枚举值:

  • PENDING

  • PENDING_DELETE

  • DELETE_FAILED

  • RUNNING

  • FAILED

  • SUCCEEDED

  • UNKNOWN

  • DELETE_SUCCESS

  • STOPPED

control_status

String

模块管控状态

node_id

String

边缘节点(同deviceID)ID

最小长度:0

最大长度:64

module_name

String

模块名称

最小长度:0

最大长度:64

module_id

String

模块ID

最小长度:0

最大长度:64

create_time

String

创建时间

最小长度:0

最大长度:256

update_time

String

最后一次修改时间

最小长度:0

最大长度:256

app_type

String

应用类型

枚举值:

  • SYSTEM_REQUIRED

  • SYSTEM_OPTIONAL

  • USER

function_type

String

功能类型

枚举值:

  • DATA_PROCESSING

  • PROTOCOL_PARSING

  • ON_PREMISE_INTEGRATION

  • GATEWAY_MANAGER

  • COMPOSITE_APPLICATION

  • DATA_COLLECTION

container_settings

ModuleContainerSettingsResDTO object

表4 ModuleContainerSettingsResDTO

参数

参数类型

描述

configs

ContainerConfigsResDTO object

表5 ContainerConfigsResDTO

参数

参数类型

描述

host_network

Boolean

是否使用主机网络模式

缺省值:false

container_port_list

Array of ContainerPortDTO objects

容器端口映射值

表6 ContainerPortDTO

参数

参数类型

描述

container_port

Integer

构成一堆映射的容器端口

最小值:1

最大值:65535

host_port

Integer

构成一对映射的物理机对应网卡端口

最小值:1

最大值:65535

host_ip

String

对应网卡地址

最小长度:0

最大长度:64

请求示例

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

响应示例

状态码

状态码

描述

200

OK

401

Bad Request

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close