创建边缘模块
功能介绍
用户通过Console接口在指定边缘节点上创建边缘模块
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/edge-nodes/{edge_node_id}/modules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 |
|
edge_node_id |
是 |
String |
边缘节点ID 最小长度：1 最大长度：64 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
edge_app_id |
是 |
String |
边缘应用名称 最小长度：0 最大长度：32 |
|
app_version |
是 |
String |
边缘应用版本 最小长度：0 最大长度：64 |
|
module_name |
否 |
String |
边缘模块名称 最小长度：0 最大长度：256 |
|
container_settings |
否 |
ContainerSettingsReqDTO object |
容器相关配置 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
configs |
否 |
ContainerConfigsReqDTO object |
容器相关配置 |
|
custom_envs |
否 |
Object |
自定义环境变量 |
|
extra_hosts |
否 |
Object |
域名解析配置集合 数组长度：0 - 20 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
container_port_list |
否 |
Array of ContainerPortDTO objects |
容器端口映射值 数组长度：0 - 1000000 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
container_port |
否 |
Integer |
构成一堆映射的容器端口 最小值：1 最大值：65535 |
|
host_port |
否 |
Integer |
构成一对映射的物理机对应网卡端口 最小值：1 最大值：65535 |
|
host_ip |
否 |
String |
对应网卡地址 最小长度：0 最大长度：64 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
hostname |
否 |
String |
域名 最小长度：1 最大长度：1024 |
|
ip |
否 |
String |
域名解析对应IP 最小长度：1 最大长度：64 |
响应参数
状态码： 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
功能类型 枚举值：
|
|
container_settings |
容器相关配置 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
configs |
ContainerConfigsResDTO object |
容器相关配置 |
|
custom_envs |
Object |
自定义环境变量 |
|
extra_hosts |
Array of DNSConfigDTO objects |
域名解析配置集合 数组长度：0 - 20 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_network |
Boolean |
是否使用主机网络模式 缺省值：false |
|
container_port_list |
Array of ContainerPortDTO objects |
容器端口映射值 数组长度：0 - 1000000 |
请求示例
POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/modules
{
"edge_app_id" : "test-app",
"app_version" : "1.0.0",
"module_name" : "edge_module",
"container_settings" : {
"configs" : {
"container_port_list" : [ {
"container_port" : 65535,
"host_port" : 65535,
"host_ip" : "string"
} ]
}
}
}
响应示例
状态码： 201
create
{
"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" : {
"container_port_list" : [ {
"container_port" : 65535,
"host_port" : 65535,
"host_ip" : "string"
} ]
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
create |
|
401 |
Bad Request |
|
500 |
Internal Server Error |
错误码
请参见错误码。
