文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 应用版本管理/ 创建应用版本

更新时间：2024-06-20 GMT+08:00

查看PDF

创建应用版本

功能介绍

创建应用版本

调试

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

URI

POST /v2/{project_id}/edge-apps/{edge_app_id}/versions

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID。最小长度：1 最大长度：64
edge_app_id	是	String	应用ID，应用唯一。最小长度：1 最大长度：32

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。最小长度：0 最大长度：20000

表3 请求Body参数
参数	是否必选	参数类型	描述
version	是	String	应用版本最小长度：1 最大长度：32
description	否	String	应用描述最小长度：0 最大长度：255
sdk_version	否	String	应用集成的边缘SDK版本最小长度：1 最大长度：32
deploy_type	否	String	应用部署类型，分为docker容器部署类型和process进程部署类型，兼容之前数据，此字段可以为空，为空情况为docker类型最小长度：0 最大长度：64 枚举值： docker process
deploy_multi_instance	否	Boolean	是否允许部署多实例缺省值：false
container_settings	是	ContainerSettingsDTO object	容器相关配置
liveness_probe	否	ProbeDTO object	工作负载存活探针
readiness_probe	否	ProbeDTO object	工作负载业务探针
arch	是	Object	架构
command	否	Object	启动命令
args	否	Object	启动参数
outputs	否	Object	应用输出路由端点
inputs	否	Object	应用输入路由
services	否	Object	应用实现的服务列表
supplier	否	String	驱动厂商最小长度：1 最大长度：128
tpl_id	否	String	模板id 最小长度：1 最大长度：64

表4 ContainerSettingsDTO
参数	是否必选	参数类型	描述
configs	否	ContainerConfigsDTO object	容器特殊参数
image_url	是	String	镜像存储地址最小长度：1 最大长度：10000
envs	否	Object	环境变量
volumes	否	Array of VolumeDTO objects	卷配置数组长度：0 - 40
npu_type	否	String	NPU类型最小长度：0 最大长度：16 枚举值： D310 D910 D310P
vnpu_template	否	String	NPU算力切分模板，可在对应芯片的机器上通过npu-smi info -t template-info命令查询其详细信息最小长度：0 最大长度：32 枚举值： vir01 vir02 vir04 vir08 vir02_1c vir04_3c vir04_3c_ndvpp vir04_4c_dvpp
resources	否	ResourceDTO object	资源配额
ext_devices	否	Array of ExtDevice objects	外挂设备配置数组长度：0 - 1000000

表5 ContainerConfigsDTO
参数	是否必选	参数类型	描述
privileged	否	Boolean	开启容器特权模式缺省值：false
host_network	否	Boolean	是否使用主机网络模式缺省值：true
restart_policy	是	String	重启策略，容器执行健康检查后失败后的策略最小长度：1 最大长度：256
container_port_list	否	Array of ContainerPortDTO objects	容器端口映射值数组长度：0 - 1000000

表6 ContainerPortDTO
参数	是否必选	参数类型	描述
container_port	否	Integer	构成一堆映射的容器端口最小值：1 最大值：65535
host_port	否	Integer	构成一对映射的物理机对应网卡端口最小值：1 最大值：65535
host_ip	否	String	对应网卡地址最小长度：0 最大长度：64

表7 VolumeDTO
参数	是否必选	参数类型	描述
name	是	String	卷名称最小长度：1 最大长度：63
type	否	String	挂载类型
source	是	String	源路径
destination	是	String	卷挂载路径
read_only	否	Boolean	只读，默认只读

表8 ResourceDTO
参数	是否必选	参数类型	描述
limits	否	ResourceConfigDTO object	允许容器使用的最大资源
requests	否	ResourceConfigDTO object	容器需要使用的最小资源

表9 ResourceConfigDTO
参数	是否必选	参数类型	描述
cpu	否	Float	cpu个数最小值：0.01 最大值：1000
memory	否	Float	内存大小最小值：0.01 最大值：1024000
gpu	否	Float	gpu内存大小，单位为M 最小值：0.01 最大值：1024000
npu	否	Float	使用npu加速卡个数最小值：0.01 最大值：1000

**表10** ExtDevice
参数	是否必选	参数类型	描述
source	是	String	源路径
destination	是	String	卷挂载路径
cgroup_permissions	否	String	只读，默认MRW

**表11** ProbeDTO
参数	是否必选	参数类型	描述
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

**表12** TcpSocketDTO
参数	是否必选	参数类型	描述
port	是	Integer	端口最小值：1 最大值：65535

**表13** HttpGetDTO
参数	是否必选	参数类型	描述
path	是	String	请求路径最小长度：2 最大长度：64
port	是	Integer	端口最小值：1 最大值：65535
host	否	String	主机地址最小长度：0 最大长度：64
scheme	是	String	协议类型最小长度：1 最大长度：64 枚举值： HTTP HTTPS

响应参数

状态码： 201

**表14** 响应Body参数
参数	参数类型	描述
edge_app_id	String	应用ID 最小长度：0 最大长度：32
name	String	应用名称最小长度：0 最大长度：64
deploy_type	String	部署类型docker\|process 最小长度：0 最大长度：64
deploy_multi_instance	Boolean	是否允许部署多实例缺省值：false
version	String	应用版本最小长度：0 最大长度：32
sdk_version	String	应用集成的边缘SDK版本最小长度：1 最大长度：32
description	String	应用描述最小长度：0 最大长度：256
create_time	String	创建时间最小长度：0 最大长度：256
update_time	String	最后一次修改时间最小长度：0 最大长度：256
state	String	应用版本状态最小长度：0 最大长度：64 枚举值： DRAFT PUBLISHED OFF_SHELF
liveness_probe	ProbeDTO object	工作负载存活探针
readiness_probe	ProbeDTO object	工作负载业务探针
arch	Array of strings	架构数组长度：1 - 1000000
command	Array of strings	启动命令数组长度：1 - 1000000
args	Array of strings	启动参数数组长度：1 - 1000000
container_settings	ContainerSettingsDTO object	容器相关配置
outputs	Array of strings	应用输出路由端点数组长度：1 - 1000000
inputs	Array of strings	应用输入路由数组长度：1 - 1000000
services	Array of strings	应用实现的服务列表数组长度：1 - 1000
publish_time	String	发布时间最小长度：0 最大长度：256
off_shelf_time	String	下线时间最小长度：0 最大长度：256
supplier	String	驱动厂商最小长度：1 最大长度：128
tpl_id	String	模板id 最小长度：1 最大长度：64

**表15** ProbeDTO
参数	参数类型	描述
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

**表16** TcpSocketDTO
参数	参数类型	描述
port	Integer	端口最小值：1 最大值：65535

**表17** HttpGetDTO
参数	参数类型	描述
path	String	请求路径最小长度：2 最大长度：64
port	Integer	端口最小值：1 最大值：65535
host	String	主机地址最小长度：0 最大长度：64
scheme	String	协议类型最小长度：1 最大长度：64 枚举值： HTTP HTTPS

**表18** ContainerSettingsDTO
参数	参数类型	描述
configs	ContainerConfigsDTO object	容器特殊参数
image_url	String	镜像存储地址最小长度：1 最大长度：10000
envs	Object	环境变量
volumes	Array of VolumeDTO objects	卷配置数组长度：0 - 40
npu_type	String	NPU类型最小长度：0 最大长度：16 枚举值： D310 D910 D310P
vnpu_template	String	NPU算力切分模板，可在对应芯片的机器上通过npu-smi info -t template-info命令查询其详细信息最小长度：0 最大长度：32 枚举值： vir01 vir02 vir04 vir08 vir02_1c vir04_3c vir04_3c_ndvpp vir04_4c_dvpp
resources	ResourceDTO object	资源配额
ext_devices	Array of ExtDevice objects	外挂设备配置数组长度：0 - 1000000

**表19** ContainerConfigsDTO
参数	参数类型	描述
privileged	Boolean	开启容器特权模式缺省值：false
host_network	Boolean	是否使用主机网络模式缺省值：true
restart_policy	String	重启策略，容器执行健康检查后失败后的策略最小长度：1 最大长度：256
container_port_list	Array of ContainerPortDTO objects	容器端口映射值数组长度：0 - 1000000

**表20** ContainerPortDTO
参数	参数类型	描述
container_port	Integer	构成一堆映射的容器端口最小值：1 最大值：65535
host_port	Integer	构成一对映射的物理机对应网卡端口最小值：1 最大值：65535
host_ip	String	对应网卡地址最小长度：0 最大长度：64

**表21** VolumeDTO
参数	参数类型	描述
name	String	卷名称最小长度：1 最大长度：63
type	String	挂载类型
source	String	源路径
destination	String	卷挂载路径
read_only	Boolean	只读，默认只读

**表22** ResourceDTO
参数	参数类型	描述
limits	ResourceConfigDTO object	允许容器使用的最大资源
requests	ResourceConfigDTO object	容器需要使用的最小资源

**表23** ResourceConfigDTO
参数	参数类型	描述
cpu	Float	cpu个数最小值：0.01 最大值：1000
memory	Float	内存大小最小值：0.01 最大值：1024000
gpu	Float	gpu内存大小，单位为M 最小值：0.01 最大值：1024000
npu	Float	使用npu加速卡个数最小值：0.01 最大值：1000

**表24** ExtDevice
参数	参数类型	描述
source	String	源路径
destination	String	卷挂载路径
cgroup_permissions	String	只读，默认MRW

请求示例

POST https://{endpoint}/v2/{project_id}/edge-apps/{edge_app_id}/versions

{
  "version" : "1.0.0",
  "description" : "string",
  "sdk_version" : "string",
  "deploy_type" : "docker",
  "deploy_multi_instance" : false,
  "container_settings" : {
    "configs" : {
      "privileged" : false,
      "host_network" : true,
      "restart_policy" : "string",
      "container_port_list" : [ {
        "container_port" : 65535,
        "host_port" : 65535,
        "host_ip" : "string"
      } ]
    },
    "image_url" : "string",
    "envs" : { },
    "volumes" : [ {
      "name" : "string",
      "type" : "string",
      "source" : "string",
      "destination" : "string",
      "read_only" : true
    } ],
    "npu_type" : "D310",
    "resources" : {
      "limits" : {
        "cpu" : 1000,
        "memory" : 1024000,
        "gpu" : 1024000,
        "npu" : 1000
      },
      "requests" : {
        "cpu" : 1000,
        "memory" : 1024000,
        "gpu" : 1024000,
        "npu" : 1000
      }
    },
    "ext_devices" : [ {
      "source" : "string",
      "destination" : "string",
      "cgroup_permissions" : "string"
    } ]
  },
  "liveness_probe" : {
    "exec_command" : "string",
    "tcp_socket" : {
      "port" : 65535
    },
    "http_get" : {
      "path" : "string",
      "port" : 65535,
      "host" : "string",
      "scheme" : "HTTP"
    },
    "initial_delay_seconds" : 3600,
    "timeout_seconds" : 3600,
    "period_seconds" : 30,
    "failure_threshold" : 3
  },
  "readiness_probe" : {
    "exec_command" : "string",
    "tcp_socket" : {
      "port" : 65535
    },
    "http_get" : {
      "path" : "string",
      "port" : 65535,
      "host" : "string",
      "scheme" : "HTTP"
    },
    "initial_delay_seconds" : 3600,
    "timeout_seconds" : 3600,
    "period_seconds" : 30,
    "failure_threshold" : 3
  },
  "arch" : { },
  "command" : { },
  "args" : { },
  "outputs" : { },
  "inputs" : { },
  "services" : { },
  "supplier" : "华为",
  "tpl_id" : "sys_general_opcua"
}

响应示例

状态码： 201

Created

{
  "edge_app_id" : "string",
  "name" : "string",
  "deploy_type" : "string",
  "deploy_multi_instance" : false,
  "version" : "string",
  "sdk_version" : "string",
  "description" : "string",
  "create_time" : "string",
  "update_time" : "string",
  "state" : "DRAFT",
  "liveness_probe" : {
    "exec_command" : "string",
    "tcp_socket" : {
      "port" : 65535
    },
    "http_get" : {
      "path" : "string",
      "port" : 65535,
      "host" : "string",
      "scheme" : "HTTP"
    },
    "initial_delay_seconds" : 3600,
    "timeout_seconds" : 3600,
    "period_seconds" : 30,
    "failure_threshold" : 3
  },
  "readiness_probe" : {
    "exec_command" : "string",
    "tcp_socket" : {
      "port" : 65535
    },
    "http_get" : {
      "path" : "string",
      "port" : 65535,
      "host" : "string",
      "scheme" : "HTTP"
    },
    "initial_delay_seconds" : 3600,
    "timeout_seconds" : 3600,
    "period_seconds" : 30,
    "failure_threshold" : 3
  },
  "arch" : "string",
  "command" : "string",
  "args" : "string",
  "container_settings" : {
    "configs" : {
      "privileged" : false,
      "host_network" : true,
      "restart_policy" : "string",
      "container_port_list" : {
        "container_port" : 65535,
        "host_port" : 65535,
        "host_ip" : "string"
      }
    },
    "image_url" : "string",
    "envs" : { },
    "volumes" : {
      "name" : "string",
      "type" : "string",
      "source" : "string",
      "destination" : "string",
      "read_only" : true
    },
    "resources" : {
      "limits" : {
        "cpu" : 1000,
        "memory" : 1024000,
        "gpu" : 1024000,
        "npu" : 1000
      },
      "requests" : {
        "cpu" : 1000,
        "memory" : 1024000,
        "gpu" : 1024000,
        "npu" : 1000
      }
    },
    "ext_devices" : {
      "source" : "string",
      "destination" : "string",
      "cgroup_permissions" : "string"
    }
  },
  "outputs" : "string",
  "inputs" : "string",
  "services" : "string",
  "publish_time" : { },
  "off_shelf_time" : { },
  "supplier" : "华为",
  "tpl_id" : "sys_general_opcua"
}

状态码

状态码	描述
201	Created
401	Bad Request
500	Internal Server Error

错误码

请参见错误码。

父主题： 应用版本管理

上一篇：应用版本管理

下一篇：查询应用版本列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建应用版本

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线