IOT边缘 IOTEDGE-修改应用版本:请求参数
下载IOT边缘 IOTEDGE用户手册完整版
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
description |
否 |
String |
应用描述 |
deploy_type |
否 |
String |
部署类型docker|process 最小长度：0 最大长度：64 |
deploy_multi_instance |
否 |
Boolean |
是否允许部署多实例 缺省值：false |
container_settings |
否 |
ContainerSettingsDTO object |
容器相关配置 |
liveness_probe |
否 |
ProbeDTO object |
工作负载存活探针 |
readiness_probe |
否 |
ProbeDTO object |
工作负载业务探针 |
sdk_version |
否 |
String |
应用集成的边缘SDK版本 最小长度：1 最大长度：32 |
arch |
否 |
Object |
架构 |
command |
否 |
Object |
启动命令 |
args |
否 |
Object |
启动参数 |
outputs |
否 |
Object |
应用输出路由端点 |
inputs |
否 |
Object |
应用输入路由 |
services |
否 |
Object |
应用实现的服务列表 |
tpl_id |
否 |
String |
模板id 最小长度：1 最大长度：64 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
configs |
否 |
ContainerConfigsDTO object |
容器特殊参数 |
image_url |
是 |
String |
镜像存储地址 最小长度：1 最大长度：10000 |
envs |
否 |
Object |
环境变量 |
volumes |
否 |
Array of VolumeDTO objects |
卷配置 数组长度：0 - 40 |
npu_type |
否 |
String |
NPU类型 最小长度：0 最大长度：16 枚举值：
|
vnpu_template |
否 |
String |
NPU算力切分模板，可在对应芯片的机器上通过npu-smi info -t template-info命令查询其详细信息 最小长度：0 最大长度：32 枚举值：
|
resources |
否 |
ResourceDTO object |
资源配额 |
ext_devices |
否 |
Array of ExtDevice objects |
外挂设备配置 数组长度：0 - 1000000 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
privileged |
否 |
Boolean |
开启容器特权模式 缺省值：false |
host_network |
否 |
Boolean |
是否使用主机网络模式 缺省值：true |
restart_policy |
是 |
String |
重启策略，容器执行健康检查后失败后的策略 最小长度：1 最大长度：256 |
container_port_list |
否 |
Array of ContainerPortDTO objects |
容器端口映射值 数组长度：0 - 1000000 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
container_port |
否 |
Integer |
构成一堆映射的容器端口 最小值：1 最大值：65535 |
host_port |
否 |
Integer |
构成一对映射的物理机对应网卡端口 最小值：1 最大值：65535 |
host_ip |
否 |
String |
对应网卡地址 最小长度：0 最大长度：64 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
name |
是 |
String |
卷名称 最小长度：1 最大长度：63 |
type |
否 |
String |
挂载类型 |
source |
是 |
String |
源路径 |
destination |
是 |
String |
卷挂载路径 |
read_only |
否 |
Boolean |
只读，默认只读 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limits |
否 |
ResourceConfigDTO object |
允许容器使用的最大资源 |
requests |
否 |
ResourceConfigDTO object |
容器需要使用的最小资源 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
cpu |
否 |
Float |
cpu个数 最小值：0.01 最大值：1000 |
memory |
否 |
Float |
内存大小 最小值：0.01 最大值：1024000 |
gpu |
否 |
Float |
gpu内存大小，单位为M 最小值：0.01 最大值：1024000 |
npu |
否 |
Float |
使用npu加速卡个数 最小值：0.01 最大值：1000 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
source |
是 |
String |
源路径 |
destination |
是 |
String |
卷挂载路径 |
cgroup_permissions |
否 |
String |
只读，默认MRW |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
exec_command |
否 |
String |
执行探测的命令行命令 最小长度：0 最大长度：256 |
tcp_socket |
否 |
TcpSocketDTO object |
执行tcp探测 |
http_get |
否 |
HttpGetDTO object |
执行http探测 |
initial_delay_seconds |
是 |
Integer |
表示从工作负载启动后从多久开始探测 最小值：0 最大值：3600 |
timeout_seconds |
是 |
Integer |
表示探测超时时间 最小值：1 最大值：3600 |
period_seconds |
否 |
Integer |
检查周期 最小值：5 最大值：3600 缺省值：30 |
failure_threshold |
否 |
Integer |
失败多少次算不健康 最小值：1 最大值：3600 缺省值：3 |
