IOT边缘 IOTEDGE-修改边缘模块:请求参数

时间:2024-01-17 14:02:20

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:20000

表3 请求Body参数

参数

是否必选

参数类型

描述

app_version

String

边缘应用版本

最小长度:0

最大长度:64

module_name

String

边缘模块名称

最小长度:0

最大长度:256

desired_state

String

模块期望状态: RUNNING(升级后期望模块运行),STOPPED(升级后期望模块停止),空值默认继承升级前模块期望状态

最小长度:0

最大长度:64

枚举值:

  • RUNNING

  • STOPPED

container_settings

ContainerSettingsReqDTO object

容器设置

表4 ContainerSettingsReqDTO

参数

是否必选

参数类型

描述

configs

ContainerConfigsReqDTO object

容器相关配置

custom_envs

Object

自定义环境变量

extra_hosts

Object

域名解析配置集合

数组长度:0 - 20

表5 ContainerConfigsReqDTO

参数

是否必选

参数类型

描述

container_port_list

Array of ContainerPortDTO objects

容器端口映射值

数组长度:0 - 1000000

表6 ContainerPortDTO

参数

是否必选

参数类型

描述

container_port

Integer

构成一堆映射的容器端口

最小值:1

最大值:65535

host_port

Integer

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

最小值:1

最大值:65535

host_ip

String

对应网卡地址

最小长度:0

最大长度:64

表7 DNSConfigDTO

参数

是否必选

参数类型

描述

hostname

String

域名

最小长度:1

最大长度:1024

ip

String

域名解析对应IP

最小长度:1

最大长度:64

support.huaweicloud.com/api-iotedge/UpdateModule.html