功能介绍
● OFF_SHELF command Array of
1.1.8.3 修改应用版本
功能介绍
修改应用版本
URI
PUT /v1/{project_id}/v2x-edge-apps/{edge_app_id}/versions/{version}
表1-84 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 参数说明：项目ID。获取方法请 参见 获取项目ID。
取值范围：仅支持数字，a到f的 小写字母组合，长度32。
正则匹配：^[0-9a-f]{32}$
edge_app_id 是 String 参数说明：用户自定义应用唯一 ID。
取值范围：只允许字母、数字、
下划线（_）、连接符（-）、美 元符号（$）的组合。
最小长度：1 最大长度：32
version 是 String 参数说明：应用版本，应用内版
本唯一。
最小长度：1 最大长度：32
请求参数
表1-85 请求 Header 参数
参数 是否必选 参数类型 描述
Instance-Id 否 String 参数说明：实例ID。dris物理实 例的唯一标识。获取方法参见获
X-Auth-Token 否 String 参数说明：用户Token，Token 认证鉴权时必选。通过调用IAM 服务 获取IAM用户Token接口 获取，接口返回的响应消息头中
description 否 String 参数说明：应用描述。
取值范围：只允许中文、字母、
ings 是 ContainerSet
tingsDTO object
参数说明：容器配置。
表1-87 ContainerSettingsDTO
参数 是否必选 参数类型 描述
configs 否 ContainerCo nfigsDTO object
参数说明：容器特殊参数。
image_url 是 String 参数说明：镜像存储地址。
最小长度：1
最大长度：1000000
envs 否 Object 参数说明：环境变量。
volumes 否 Array of VolumeDTO objects
参数说明：卷配置。
resources 否 ResourceDTO
object 参数说明：资源配额。
ext_devices 否 Array of ExtDevice objects
参数说明：外挂设备配置。
表1-88 ContainerConfigsDTO
参数 是否必选 参数类型 描述
privileged 否 Boolean 参数说明：开启容器特权模式。
缺省值：false
host_network 否 Boolean 参数说明：是否使用主机网络模 式。
缺省值：true
restart_policy 是 String 参数说明：重启策略，容器执行 健康检查后失败后的策略。
t_list 否 Array of ContainerPor tDTO objects
参数说明：容器端口映射值。
表1-89 ContainerPortDTO
参数 是否必选 参数类型 描述
container_por
t 否 Integer 参数说明：构成一堆映射的容器
端口。
最小值：1 最大值：65535
host_port 否 Integer 参数说明：构成一对映射的物理 机对应网卡端口。
最小值：1 最大值：65535
host_ip 否 String 参数说明：对应网卡地址。
表1-90 VolumeDTO
参数 是否必选 参数类型 描述
name 是 String 参数说明：卷名称。
最小长度：1 最大长度：63
正则匹配：^[a-z0-9]*$
type 否 String 参数说明：挂载类型。
正则匹配：LOG|DB|CONFIG
source 是 String 参数说明：源路径。
正则匹配：^/(\w+/?)+$
destination 是 String 参数说明：卷挂载路径。
正则匹配：^/*(?!boot/|dev/|
etc/|lib/|pro/|sys/|usr/)(\w+/?)+
$
read_only 否 Boolean 参数说明：只读，默认只读。
表1-91 ResourceDTO
参数 是否必选 参数类型 描述
limits 否 ResourceConf
igDTO object 参数说明：允许容器使用的最大 资源。
表1-92 ResourceConfigDTO
参数 是否必选 参数类型 描述
cpu 否 Float 参数说明：cpu个数。
最小值：0.01 最大值：1000
memory 否 Float 参数说明：内存大小。
最小值：0.01 最大值：1024000
gpu 否 Float 参数说明：gpu个数。
最小值：0.01 最大值：1024000
npu 否 Float 参数说明：npu个数。
最小值：0.01 最大值：1000
表1-93 ExtDevice
参数 是否必选 参数类型 描述
source 是 String 参数说明：源路径。
正则匹配：^/([a-zA-Z_0-9-]
+/?)+$
destination 是 String 参数说明：卷挂载路径。
正则匹配：^/([a-zA-Z_0-9-]
+/?)+$
cgroup_permi
ssions 否 String 参数说明：只读，默认MRW。
最小长度：1 最大长度：63
响应参数
状态码： 200
表1-94 响应 Body 参数
参数 参数类型 描述
edge_app_id String 参数说明：用户自定义应用唯一ID。
取值范围：只允许字母、数字、下划线（_）、连 接符（-）、美元符号（$）的组合。
最小长度：0 最大长度：32
version String 参数说明：应用版本。
最小长度：0 最大长度：32
description String 参数说明：应用描述。
取值范围：只允许中文、字母、数字、下划线
（_）、中文分号（；）、中文冒号（：）、中文 问号（？）、中文感叹号（！）中文逗号
（，）、中文句号（。）、英文引号（;）、英文 冒号（:）、英文逗号（,）、英文句号（.）、英 文问号（?）、英文感叹号（!）、顿号（、）、
连接符（-）的组合。
最小长度：0 最大长度：255
正则匹配：^[a-zA-Z0-9_；：？！，;:、,.?!。\-\s
\u4e00-\u9fa5]*$
created_time String 参数说明：创建时间。
最小长度：0 最大长度：255 last_modified
_time String 参数说明：最后一次修改时间。
最小长度：0 最大长度：255
state String 参数说明：应用版本状态。
取值范围：
● DRAFT：草稿
● PUBLISHED：发布
● OFF_SHELF：下线 枚举值：
● DRAFT
● PUBLISHED
参数 参数类型 描述 args Array of
strings 参数说明：启动参数。
container_sett
ings ContainerSet tingsDTO object
参数说明：容器配置。
publish_time String 参数说明：发布时间。
最小长度：0 最大长度：255
off_shelf_time String 参数说明：下线时间。
最小长度：0 最大长度：255
表1-95 ContainerSettingsDTO
参数 参数类型 描述
configs ContainerCo nfigsDTO object
参数说明：容器特殊参数。
image_url String 参数说明：镜像存储地址。
最小长度：1
最大长度：1000000
envs Object 参数说明：环境变量。
volumes Array of VolumeDTO objects
参数说明：卷配置。
resources ResourceDTO
object 参数说明：资源配额。
ext_devices Array of ExtDevice objects
参数说明：外挂设备配置。
表1-96 ContainerConfigsDTO
参数 参数类型 描述
privileged Boolean 参数说明：开启容器特权模式。
缺省值：false
参数 参数类型 描述
host_network Boolean 参数说明：是否使用主机网络模式。
缺省值：true
restart_policy String 参数说明：重启策略，容器执行健康检查后失败 后的策略。
最小长度：1 最大长度：255
正则匹配：Always|OnFailure|Never container_por
t_list Array of ContainerPor tDTO objects
参数说明：容器端口映射值。
表1-97 ContainerPortDTO
参数 参数类型 描述
container_por
t Integer 参数说明：构成一堆映射的容器端口。
最小值：1 最大值：65535
host_port Integer 参数说明：构成一对映射的物理机对应网卡端 口。
最小值：1 最大值：65535
host_ip String 参数说明：对应网卡地址。
表1-98 VolumeDTO
参数 参数类型 描述
name String 参数说明：卷名称。
最小长度：1 最大长度：63
正则匹配：^[a-z0-9]*$
type String 参数说明：挂载类型。
正则匹配：LOG|DB|CONFIG source String
参数 参数类型 描述
destination String 参数说明：卷挂载路径。
正则匹配：^/*(?!boot/|dev/|etc/|lib/|pro/|sys/|
usr/)(\w+/?)+$
read_only Boolean 参数说明：只读，默认只读。
表1-99 ResourceDTO
参数 参数类型 描述
limits ResourceConf
igDTO object 参数说明：允许容器使用的最大资源。
requests ResourceConf
igDTO object 参数说明：容器需要使用的最小资源。
表1-100 ResourceConfigDTO
参数 参数类型 描述
cpu Float 参数说明：cpu个数。
最小值：0.01 最大值：1000
memory Float 参数说明：内存大小。
最小值：0.01 最大值：1024000
gpu Float 参数说明：gpu个数。
最小值：0.01 最大值：1024000
npu Float 参数说明：npu个数。
最小值：0.01 最大值：1000
表1-101 ExtDevice
参数 参数类型 描述
source String 参数说明：源路径。
正则匹配：^/([a-zA-Z_0-9-]+/?)+$
参数 参数类型 描述
destination String 参数说明：卷挂载路径。
正则匹配：^/([a-zA-Z_0-9-]+/?)+$
cgroup_permi
ssions String 参数说明：只读，默认MRW。
最小长度：1 最大长度：63
请求示例
PUT https://{endpoint}/v1/{project_id}/v2x-edge-apps/{edge_app_id}/versions/{version}
Content-Type:application/json X-Auth-Token:********
Instance-Id:********
{ "args" : [ "tets" ],
"description" : "this is a test app version", "command" : [ "tets" ],
"container_settings" : { "configs" : {
"privileged" : false, "host_network" : true, "restart_policy" : "Always", "container_port_list" : [ {
"image_url" : "www.baidu.com", "volumes" : [ {
"read_only" : false, "name" : "config",
"destination" : "/iot/opt/test", "source" : "/iot/opt/test"
{ "edge_app_id" : "12617852507412065303014562034843", "version" : "1.0.2",
"description" : "hello",
"created_time" : "2020-05-28T11:31:29.740Z", "last_modified_time" : "2020-05-28T11:31:29.740Z", "state" : "DRAFT",
"command" : null, "args" : null,
"container_settings" : null, "publish_time" : null,
"off_shelf_time" : "2020-05-28T11:31:29.740Z"
}
状态码
状态码 描述
200 OK
400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found
405 Method Not Allowed 409 Conflict
429 Too Many Requests 500 Internal Server Error
错误码
请参见错误码。