更新时间:2024-10-24 GMT+08:00
分享

修改应用版本

功能介绍

修改应用版本

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v1/{project_id}/v2x-edge-apps/{edge_app_id}/versions/{version}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。

取值范围:仅支持数字,a到f的小写字母组合,长度32。

edge_app_id

String

参数说明:用户自定义应用唯一ID。

取值范围:长度不大于32,只允许字母、数字、下划线(_)、连接符(-)、美元符号($)的组合。

version

String

参数说明:应用版本,应用内版本唯一。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

String

参数说明:实例ID。DRIS物理实例的唯一标识,获取方法请参见“API参考 > 附录 > 获取Instance-Id”。

取值范围:仅支持数字,小写字母和连接符(-)的组合,长度36。

X-Auth-Token

String

参数说明:用户Token,Token认证鉴权时必选。通过调用IAM服务 “获取IAM用户Token”接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见“API参考 > API > 应用侧API参考 > 如何调用API > 认证鉴权 > Token认证”。

表3 请求Body参数

参数

是否必选

参数类型

描述

description

String

参数说明:应用描述。

取值范围:只允许中文、字母、数字、下划线(_)、中文分号(;)、中文冒号(:)、中文问号(?)、中文感叹号(!)中文逗号(,)、中文句号(。)、英文引号(;)、英文冒号(:)、英文逗号(,)、英文句号(.)、英文问号(?)、英文感叹号(!)、顿号(、)、连接符(-)、空格的组合。

container_settings

ContainerSettingsDTO object

参数说明:容器配置。

command

Array of strings

参数说明:启动命令。

args

Array of strings

参数说明:启动参数。

表4 ContainerSettingsDTO

参数

是否必选

参数类型

描述

configs

ContainerConfigsDTO object

参数说明:容器特殊参数。

image_url

String

参数说明:镜像存储地址。

envs

Object

参数说明:环境变量。

volumes

Array of VolumeDTO objects

参数说明:卷配置。

resources

ResourceDTO object

参数说明:资源配额。

ext_devices

Array of ExtDevice objects

参数说明:外挂设备配置。

表5 ContainerConfigsDTO

参数

是否必选

参数类型

描述

privileged

Boolean

参数说明:开启容器特权模式。

host_network

Boolean

参数说明:是否使用主机网络模式。

restart_policy

String

参数说明:重启策略,容器执行健康检查后失败后的策略。

container_port_list

Array of ContainerPortDTO objects

参数说明:容器端口映射值。

表6 ContainerPortDTO

参数

是否必选

参数类型

描述

container_port

Integer

参数说明:构成一对映射的容器端口。

host_port

Integer

参数说明:构成一对映射的物理机对应网卡端口。

host_ip

String

参数说明:对应网卡地址。

表7 VolumeDTO

参数

是否必选

参数类型

描述

name

String

参数说明:卷名称。

type

String

参数说明:挂载类型。

source

String

参数说明:源路径。只允许输入数字、大写字母、小写字母、下划线(_)、横杠(-)、斜线(/)

destination

String

参数说明:卷挂载路径。

read_only

Boolean

参数说明:只读,默认只读。

表8 ResourceDTO

参数

是否必选

参数类型

描述

limits

ResourceConfigDTO object

参数说明:允许容器使用的最大资源。

requests

ResourceConfigDTO object

参数说明:容器需要使用的最小资源。

表9 ResourceConfigDTO

参数

是否必选

参数类型

描述

cpu

Float

参数说明:cpu个数。

memory

Float

参数说明:内存大小。

gpu

Float

参数说明:gpu个数。

npu

Float

参数说明:npu个数。

表10 ExtDevice

参数

是否必选

参数类型

描述

source

String

参数说明:源路径。

destination

String

参数说明:卷挂载路径。

cgroup_permissions

String

参数说明:只读,默认MRW。

响应参数

状态码: 200

表11 响应Body参数

参数

参数类型

描述

edge_app_id

String

参数说明:用户自定义应用唯一ID。

取值范围:只允许字母、数字、下划线(_)、连接符(-)、美元符号($)的组合。

version

String

参数说明:应用版本。

description

String

参数说明:应用描述。

取值范围:只允许中文、字母、数字、下划线(_)、中文分号(;)、中文冒号(:)、中文问号(?)、中文感叹号(!)中文逗号(,)、中文句号(。)、英文引号(;)、英文冒号(:)、英文逗号(,)、英文句号(.)、英文问号(?)、英文感叹号(!)、顿号(、)、连接符(-)的组合。

created_time

String

参数说明:创建时间。

last_modified_time

String

参数说明:最后一次修改时间。

state

String

参数说明:应用版本状态。

取值范围

  • DRAFT:草稿

  • PUBLISHED:发布

  • OFF_SHELF:下线

command

Array of strings

参数说明:启动命令。

args

Array of strings

参数说明:启动参数。

container_settings

ContainerSettingsDTO object

参数说明:容器配置。

publish_time

String

参数说明:发布时间。

off_shelf_time

String

参数说明:下线时间。

表12 ContainerSettingsDTO

参数

参数类型

描述

configs

ContainerConfigsDTO object

参数说明:容器特殊参数。

image_url

String

参数说明:镜像存储地址。

envs

Object

参数说明:环境变量。

volumes

Array of VolumeDTO objects

参数说明:卷配置。

resources

ResourceDTO object

参数说明:资源配额。

ext_devices

Array of ExtDevice objects

参数说明:外挂设备配置。

表13 ContainerConfigsDTO

参数

参数类型

描述

privileged

Boolean

参数说明:开启容器特权模式。

host_network

Boolean

参数说明:是否使用主机网络模式。

restart_policy

String

参数说明:重启策略,容器执行健康检查后失败后的策略。

container_port_list

Array of ContainerPortDTO objects

参数说明:容器端口映射值。

表14 ContainerPortDTO

参数

参数类型

描述

container_port

Integer

参数说明:构成一对映射的容器端口。

host_port

Integer

参数说明:构成一对映射的物理机对应网卡端口。

host_ip

String

参数说明:对应网卡地址。

表15 VolumeDTO

参数

参数类型

描述

name

String

参数说明:卷名称。

type

String

参数说明:挂载类型。

source

String

参数说明:源路径。只允许输入数字、大写字母、小写字母、下划线(_)、横杠(-)、斜线(/)

destination

String

参数说明:卷挂载路径。

read_only

Boolean

参数说明:只读,默认只读。

表16 ResourceDTO

参数

参数类型

描述

limits

ResourceConfigDTO object

参数说明:允许容器使用的最大资源。

requests

ResourceConfigDTO object

参数说明:容器需要使用的最小资源。

表17 ResourceConfigDTO

参数

参数类型

描述

cpu

Float

参数说明:cpu个数。

memory

Float

参数说明:内存大小。

gpu

Float

参数说明:gpu个数。

npu

Float

参数说明:npu个数。

表18 ExtDevice

参数

参数类型

描述

source

String

参数说明:源路径。

destination

String

参数说明:卷挂载路径。

cgroup_permissions

String

参数说明:只读,默认MRW。

请求示例

PUT https://{endpoint}/v1/{project_id}/v2x-edge-apps/{edge_app_id}/versions/{version}
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********

{
  "description" : "this is a test app version",
  "container_settings" : {
    "configs" : {
      "privileged" : false,
      "host_network" : true,
      "restart_policy" : "Never"
    },
    "image_url" : "example.com/huawei/edge:1.0.0",
    "volumes" : [ {
      "name" : "newconfig",
      "destination" : "newDestination",
      "source" : "/user"
    } ]
  }
}

响应示例

状态码: 200

OK

{
  "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

错误码

请参见错误码

相关文档