修改边缘模块
功能介绍
用户通过Console接口查询指定边缘节点上指定边缘模块
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
PUT /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认证。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app_version |
否 |
String |
边缘应用版本 |
|
module_name |
否 |
String |
边缘模块名称 |
|
desired_state |
否 |
String |
模块期望状态: RUNNING(升级后期望模块运行)，STOPPED(升级后期望模块停止)，空值默认继承升级前模块期望状态 |
|
container_settings |
否 |
ContainerSettingsReqDTO object |
容器设置 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
configs |
否 |
ContainerConfigsReqDTO object |
容器相关配置 |
|
custom_envs |
否 |
Object |
自定义环境变量 |
|
extra_hosts |
否 |
Object |
域名解析配置集合 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
container_port_list |
否 |
Array of ContainerPortDTO objects |
容器端口映射值 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
container_port |
否 |
Integer |
构成一堆映射的容器端口 |
|
host_port |
否 |
Integer |
构成一对映射的物理机对应网卡端口 |
|
host_ip |
否 |
String |
对应网卡地址 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
hostname |
否 |
String |
域名 |
|
ip |
否 |
String |
域名解析对应IP |
响应参数
状态码：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 |
功能类型 |
请求示例
PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}
{
"app_version" : "1.1.0",
"module_name" : "edge_module",
"container_settings" : {
"configs" : {
"container_port_list" : [ {
"container_port" : 65535,
"host_port" : 65535,
"host_ip" : "string"
} ]
}
},
"desired_state" : "RUNNING"
}
响应示例
状态码：200
OK
{
"edge_app_id" : "test-app",
"app_version" : "1.1.0",
"state" : "RUNNING",
"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 |
错误码
请参见错误码。
