计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

更新应用部署

更新时间:2024-04-22 GMT+08:00

功能介绍

该API用于修改一个应用部署。

URI

PUT /v3/{project_id}/edgemgr/deployments/{deployment_id}

表1 Path参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见获取项目ID

deployment_id

String

应用部署ID

请求参数

表2 请求Header参数

参数

是否必选

类型

描述

Content-Type

String

消息体的类型(格式)

推荐您使用默认值application/json。

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

ief-instance-id

String

铂金版实例ID,专业版实例为空值

表3 请求Body参数

参数

是否必选

参数类型

描述

deployment

UpdatePodDeployment object

应用部署全量替换修改,应用更新时调用

description

String

应用部署描述修改,只修改描述不需要传入deployment参数

表4 UpdatePodDeployment

参数

是否必选

参数类型

描述

replicas

Integer

应用部署副本数,只能为1

template

PodRequest object

应用部署模板

表5 PodRequest

参数

是否必选

参数类型

描述

configs

PodConfigs object

应用实例配置

affinity

affinity object

应用部署亲和性规则,仅铂金版支持

init_containers

Array of ContainerDef objects

应用部署init业务容器

containers

Array of ContainerDef objects

应用部署业务容器

表6 ContainerDef

参数

是否必选

参数类型

描述

name

String

容器名称,只允许英文小写字母、数字、中划线,最大长度32,英文小写字母或数字开头和结尾

image_url

String

容器镜像URL

args

Array of strings

容器启动参数,字符总长度最大为65536

command

Array of strings

容器启动命令,字符总长度最大为65536

resources

ResQuest object

容器资源量

envs

Array of Env objects

容器环境变量键值对

ports

Array of HostContainerPortMapping objects

容器端口映射

privileged

Boolean

是否启用特权容器,默认值false

readiness_probe

Probe object

工作负载业务探针配置

liveness_probe

Probe object

工作负载存活探针配置

version

String

容器版本,最大长度128个字符

volumes

Array of Volume objects

容器挂载卷

npu_type

String

npu类型,支持D310类型。

  • D310表示D310类型
  • 不填表示为D310类型
表7 Volume

参数

是否必选

参数类型

描述

name

String

卷名称,小写字母或数字,最长63个字符

type

String

卷的类型,支持configMap、secret、emptyDir、hostPath

read_only

Boolean

读写权限,默认读

source

String

卷来源,type为hostPath时输入路径,要求以/开头,后面可包含中划线、反斜杠、下划线、点号、字母、数字。

secret时输入secret名称,configMap时输入configMap名称,emptyDir时输入disk或memory

destination

String

卷挂载路径,必须是合法的路径

表8 Probe

参数

是否必选

参数类型

描述

http_get

HttpGet object

http健康检查,与exec二选一

exec

表10 object

执行命令检查,与http_get二选一

initial_delay_seconds

Long

表示从工作负载启动后从多久开始探测,大于0且不大于3600的整数,默认为10

timeout_seconds

Long

表示探测超时时间,大于0且不大于3600的整数,默认为1

表9 HttpGet

参数

是否必选

参数类型

描述

path

String

必须要以/开头,构造结果为:协议类型://主机地址:端口路径

port

Integer

探测的http端口,1到65535之间的整数

host

String

请求的主机地址,默认为容器IP

scheme

String

协议类型,HTTP或HTTPS,默认HTTP

表10 Exec

参数

是否必选

参数类型

描述

command

String

探针执行命令,最大长度10240个字符

表11 HostContainerPortMapping

参数

是否必选

参数类型

描述

container_port

Long

容器端口,1到65535之间的整数

host_port

Long

主机端口,1到65535之间的整数

host_ip

String

对应主机网卡地址

host_port_range

HostPortRange object

主机端口范围,在范围内为应用实例自动分配主机端口;与主机端口参数二选一;仅支持铂金版

表12 HostPortRange

参数

是否必选

参数类型

描述

min_port

Long

主机端口下限制,1到65535之间的整数

max_port

Long

主机端口上限值,1到65535之间的整数;max_port需大于min_port

表13 Env

参数

是否必选

参数类型

描述

name

String

环境变量的key,由大小写字母或下划线开头,由数字、大小写字母、下划线组成,最大长度2048个字符,不允许重复

value

String

环境变量的value,最大长度20480个字符。value、value_from和field_path必须三选一使用。

value_from

表17 object

环境变量可使用配置项和密钥导入

field_path

String

该参数目前只支持赋值“status.hostIP”,即引用边缘节点的IP地址作为环境变量。

表14 ResQuest

参数

是否必选

参数类型

描述

limits

Res object

资源限制量

requests

Res object

资源申请量;不允许大于资源限制量

表15 Res

参数

是否必选

参数类型

描述

cpu

String

cpu核数,大于等于0.01,最大1000;请求不需要带单位

memory

String

内存大小,单位兆,大于等于0.01,最大1024000。注意:内存的limits值最小为4;请求不需要带单位

gpu

String

Gpu显存大小,单位兆,大于等于0.01,最大1024000;请求不需要带单位

npu

String

Npu个数,大于0,最大1000;请求不需要带单位

表16 PodConfigs

参数

是否必选

参数类型

描述

host_network

Boolean

应用实例是否启用主机网络,不启用则使用端口映射,默认值false

host_pid

Boolean

应用实例是否与主机共PID命名空间,默认值false。

migration

Boolean

应用实例故障是否迁移,指定节点组部署时必选,默认值false

restart_policy

String

应用实例重启策略,可选值Always、OnFailure、Never。

说明:

restart_policy不支持更新。

toleration_seconds

Integer

应用实例故障容忍时间,容忍时间到达后迁移应用实例,只在指定节点组部署时生效。

表17 ValueFrom

参数

是否必选

参数类型

描述

secret

表18 object

环境变量引用密钥时使用。使用ValueFrom时,secret与configmap必须二选一。

configmap

表19 object

环境变量引用配置项时使用。

表18 secret

参数

是否必选

参数类型

描述

name

String

密钥的名称

key

String

密钥的属性名

表19 configmap

参数

是否必选

参数类型

描述

name

String

配置项的名称

key

String

配置项的属性名

响应参数

状态码为 200 时:

表20 响应Body参数

参数

参数类型

描述

id

String

应用部署uuid

name

String

应用部署名称,只允许英文小写字母、数字、中划线,最大长度32,英文小写字母或数字开头和结尾

replicas

Integer

应用部署总副本数

ready_replicas

Integer

应用部署正常副本数

description

String

应用部署描述,最大长度255,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \

group_id

String

应用部署到指定节点组,与node_ids二选一

node_ids

Array of strings

应用部署到指定节点,当前只支持一个边缘节点

tags

Array of Attribute objects

-

api_version

String

应用部署版本

source

String

应用部署来源:自定义(userdefined)

project_id

String

项目ID

created_at

String

应用部署创建时间

updated_at

String

应用部署更新时间

template

PodRequest object

应用部署模板

state

String

应用状态,仅包括冻结(FREEZE)、删除中(PENDING_DELETE)、删除失败(DELETE_FAILED),保留字段

source_id

String

保留字段

表21 PodRequest

参数

参数类型

描述

configs

PodConfigs object

应用实例配置

affinity

affinity object

应用部署亲和性规则,仅铂金版支持

init_containers

Array of ContainerDef objects

应用部署init业务容器

containers

Array of ContainerDef objects

应用部署业务容器

表22 ContainerDef

参数

参数类型

描述

name

String

容器名称,只允许英文小写字母、数字、中划线,最大长度32,英文小写字母或数字开头和结尾

image_url

String

容器镜像URL

args

Array of strings

容器启动参数

command

Array of strings

容器启动命令

resources

ResQuest object

容器资源量

envs

Array of Env objects

容器环境变量键值对

ports

Array of HostContainerPortMapping objects

容器端口映射

privileged

Boolean

是否启用特权容器,默认值false

readiness_probe

Probe object

工作负载业务探针配置

liveness_probe

Probe object

工作负载存活探针配置

version

String

容器版本

volumes

Array of Volume objects

容器挂载卷

npu_type

String

npu类型,支持D310类型。

  • D310表示D310类型
  • 不填表示为D310类型
表23 Volume

参数

参数类型

描述

name

String

卷名称,小写字母或数字,最长63个字符

type

String

卷的类型,支持configMap、secret、emptyDir、hostPath

read_only

Boolean

读写权限,默认读

source

String

卷来源,type为hostPath时输入路径,要求以/开头,后面可包含中划线,反斜杠,下划线,点号,字母,数字。

secret时输入secret名称,configMap时输入configMap名称,emptyDir时输入disk或memory。

destination

String

卷挂载路径,必须是合法的路径

表24 Probe

参数

参数类型

描述

http_get

HttpGet object

http健康检查

exec

表26 object

执行命令检查

initial_delay_seconds

Long

表示从工作负载启动后从多久开始探测,大于0且不大于3600的整数,默认为10

timeout_seconds

Long

表示探测超时时间,大于0且不大于3600的整数,默认为1

表25 HttpGet

参数

参数类型

描述

path

String

必须要以/开头,构造结果为:协议类型://主机地址:端口路径

port

Integer

探测的http端口,1到65535之间的整数

host

String

主机地址,默认为容器IP

scheme

String

协议类型,HTTP或HTTPS,默认HTTP

表26 Exec

参数

参数类型

描述

command

String

探针执行命令,最大长度10240个字符

表27 HostContainerPortMapping

参数

参数类型

描述

container_port

Long

容器端口,1到65535之间的整数

host_port

Long

主机端口,1到65535之间的整数

host_ip

String

对应主机网卡地址

host_port_range

HostPortRange object

主机端口范围,在范围内为应用实例自动分配主机端口;与主机端口参数二选一

表28 HostPortRange

参数

参数类型

描述

min_port

Long

主机端口下限制,1到65535之间的整数

max_port

Long

主机端口上限值,1到65535之间的整数;max_port需大于min_port

表29 Env

参数

参数类型

描述

name

String

环境变量的key,由大小写字母或下划线开头,由数字、大小写字母、下划线组成,最大长度2048个字符,不允许重复

value

String

环境变量的value,最大长度20480个字符。value、value_from和field_path必须三选一使用。

value_from

表34 object

环境变量可使用配置项和密钥导入

field_path

String

该参数目前只支持赋值“status.hostIP”,即引用边缘节点的IP地址作为环境变量。

表30 ResQuest

参数

参数类型

描述

limits

Res object

资源限制量

requests

Res object

资源申请量

表31 Res

参数

参数类型

描述

cpu

String

cpu核数,大于0.01,最大1000

memory

String

内存大小,单位兆,大于等于0.01,最大1024000。注意:内存的limits值最小为4

gpu

String

Gpu显存大小个数,单位兆,大于等于0.01,最大1024000

npu

String

Npu个数,大于0,最大1000

表32 PodConfigs

参数

参数类型

描述

host_network

Boolean

应用实例是否启用主机网络,不启用则使用端口映射,默认值false

host_pid

Boolean

应用实例是否与主机共PID命名空间,默认值false

migration

Boolean

应用实例故障是否迁移,指定节点组部署时必选,默认值false

restart_policy

String

应用实例重启策略,可选值Always、OnFailure、Never

toleration_seconds

Integer

应用实例故障容忍时间,容忍时间到达后迁移应用实例,只在指定节点组部署时生效

表33 Attribute

参数

参数类型

描述

key

String

数量不超过10个;不允许重复;只允许大小写字母、数字、下划线和中划线,不允许为空,最大长度为36个字符

value

String

只允许大小写字母、数字、下划线、中划线和点,最大长度为43个字符

表34 ValueFrom

参数

参数类型

描述

secret

表35 object

环境变量引用密钥时使用。使用ValueFrom时,secret与configmap必须二选一。

configmap

表36 object

环境变量引用配置项时使用。

表35 secret

参数

参数类型

描述

name

String

密钥的名称

key

String

密钥的属性名

表36 configmap

参数

参数类型

描述

name

String

配置项的名称

key

String

配置项的属性名

状态码为 400 时:

表37 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述信息

状态码为 500 时:

表38 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述信息

请求示例

{
    "deployment": {
        "replicas": 1,
        "template": {
            "configs": {
                "host_network": true,
                "host_pid": true,
                "migration": true,
                "restart_policy": "Always",
                "toleration_seconds": 300
            },
            "containers": [
                {
                    "name": "container-0",
                    "image_url": "",
                    "args": [
                        "-c",
                        "sleep 1000"
                    ],
                    "command": [
                        "/bin/bash"
                    ],
                    "resources": {
                        "limits": {
                            "cpu": "0.25",
                            "memory": "500",
                            "gpu": "500"
                        },
                        "requests": {
                            "cpu": "0.25",
                            "memory": "500",
                            "gpu": "500"
                        }
                    },
                    "envs": [
                        {
                            "name": "CERT_PATH",
                            "value": "/opt/cert"
                        }
                    ],
                    "ports": [
                        {
                            "container_port": 80,
                            "host_port": 80
                        }
                    ],
                    "privileged": true,
                    "readiness_probe": {
                        "http_get": {
                            "path": "/",
                            "port": 80,
                            "scheme": "HTTP"
                        },
                        "initial_delay_seconds": 10,
                        "timeout_seconds": 10
                    },
                    "liveness_probe": {
                        "http_get": {
                            "path": "/",
                            "port": 80,
                            "scheme": "HTTP"
                        },
                        "initial_delay_seconds": 10,
                        "timeout_seconds": 10
                    },
                    "version": "1.0"
                }
            ]
        }
    },
    "description": "this is a test app"
}

响应示例

状态码为 200 时:

{
    "id": "3e64d98a-37c5-43a6-9bfe-052b9083e362",
    "name": "app-test",
    "replicas": 1,
    "ready_replicas": 1,
    "description": "this is a test app",
    "group_id": "",
    "node_ids": [
        "29d20c18-c20c-4a45-a087-42c766fc5d97"
    ],
    "tags": [
        {
            "key": "app",
            "value": "test"
        }
    ],
    "api_version": "v3",
    "source": "userdefine",
    "project_id": "bcd83056c918480f8f190844bd425b23",
    "created_at": "2019-10-10T02:21:38.489Z",
    "updated_at": "2019-10-10T02:21:38.489Z",
    "template": {
        "configs": {
            "host_network": true,
            "host_pid": true,
            "migration": true,
            "restart_policy": "Always",
            "toleration_seconds": 300
        },
        "init_containers": []
        "containers": [
            {
                "name": "container-0",
                "image_url": "",
                "npu_type": "",
                "args": [
                    "-c",
                    "sleep 1000"
                ],
                "command": [
                    "/bin/bash"
                ],
                "resources": {
                    "limits": {
                        "cpu": "0.25",
                        "memory": "500",
                        "gpu": 500"
                    },
                    "requests": {
                        "cpu": "0.25",
                        "memory": "500",
                        "gpu": "500"
                    }
                },
                "envs": [
                    {
                        "name": "CERT_PATH",
                        "value": "/opt/cert"
                    }
                ],
                "ports": [
                    {
                        "container_port": 80,
                        "host_port": 80
                    }
                ],
                "privileged": true,
                "readiness_probe": {
                    "http_get": {
                        "path": "/",
                        "port": 80,
                        "scheme": "HTTP"
                    },
                    "initial_delay_seconds": 10,
                    "timeout_seconds": 10
                },
                "liveness_probe": {
                    "http_get": {
                        "path": "/",
                        "port": 80,
                        "scheme": "HTTP"
                    },
                    "initial_delay_seconds": 10,
                    "timeout_seconds": 10
                },
                "version": "1.0"
            }
        ]
    }
}

状态码为 400 时:

{
	"error_code" : "IEF.100001",
	"error_msg" : "PROJECT_ID not found"
}

状态码为 500 时:

{
	"error_code" : "IEF.100158",
	"error_msg" : "Fail to extract gpu information"
}

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容