网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
更新时间:2024-04-14 GMT+08:00
分享

创建部署

功能介绍

创建部署

调试

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

URI

POST /v3/{project_id}/edgemgr/deployments

表1 路径参数

参数

是否必选

参数类型

描述

project_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参数

参数

是否必选

参数类型

描述

name

String

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

description

String

部署描述

source

String

应用部署来源:边缘市场(iem)或自定义()

group_id

String

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

node_ids

Array of strings

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

tags

Array of Attributes objects

节点属性

deployment

CreateAppsInDeploymentV3 object

部署参数配置

表4 Attributes

参数

是否必选

参数类型

描述

key

String

节点属性的key值,长度取值范围为1~128, 仅允许大小写英文字母、数字、下划线、中划线

value

String

节点属性的value值,长度取值范围为1~256, 仅允许大小写英文字母、数字、下划线、中划线

表5 CreateAppsInDeploymentV3

参数

是否必选

参数类型

描述

replicas

Integer

副本数量

template

PodRequest object

应用部署模板

annotations

Annotations object

应用扩展功能配置选项

表6 PodRequest

参数

是否必选

参数类型

描述

configs

PodConfigs object

应用实例配置

affinity

Affinity object

应用实例亲和性规则,仅铂金版支持

init_containers

Array of ContainerDef objects

应用部署init业务容器

containers

Array of ContainerDef objects

应用部署业务容器

表7 PodConfigs

参数

是否必选

参数类型

描述

host_network

Boolean

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

host_pid

Boolean

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

migration

Boolean

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

restart_policy

String

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

toleration_seconds

Integer

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

dns_policy

String

应用实例DNS策略,可选值Default、ClusterFirst、ClusterFirstWithHostNet,默认为Default。应用实例启用主机网络时只能选填Default、ClusterFirstWithHostNet,不启用主机网络时只能选填Default、ClusterFirst

表8 Affinity

参数

是否必选

参数类型

描述

nodeAffinity

nodeAffinity object

节点亲和规则

podAffinity

podAffinity object

Pod亲和规则

podAntiAffinity

podAntiAffinity object

Pod反亲和规则

表9 nodeAffinity

参数

是否必选

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of PreferredSchedulingTerm objects

优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。

requiredDuringSchedulingIgnoredDuringExecution

RequiredDuringScheduling object

强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。

表10 PreferredSchedulingTerm

参数

是否必选

参数类型

描述

preference

preference object

与相应权重关联的节点选择器项。

weight

Integer

权重,范围为1-100

表11 preference

参数

是否必选

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

表12 RequiredDuringScheduling

参数

是否必选

参数类型

描述

nodeSelectorTerms

Array of MatchExpressions objects

节点选择规则

表13 MatchExpressions

参数

是否必选

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

表14 podAffinity

参数

是否必选

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of WeightPodAffinityTerms objects

优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。

requiredDuringSchedulingIgnoredDuringExecution

Array of PodAffinityTerm objects

强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。

表15 podAntiAffinity

参数

是否必选

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of WeightPodAffinityTerms objects

优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。

requiredDuringSchedulingIgnoredDuringExecution

Array of PodAffinityTerm objects

强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。

表16 WeightPodAffinityTerms

参数

是否必选

参数类型

描述

podAffinityTerm

podAffinityTerm object

Pod亲和规则

weight

Integer

权重,范围为1-100

表17 podAffinityTerm

参数

是否必选

参数类型

描述

labelSelector

LabelSelector object

标签选择器

namespaces

Array of strings

命名空间

topologyKey

String

拓扑标签。先圈定topologyKey指定的范围,然后再选择labelSelector定义的内容,即亲和调度只会在有topologyKey指定的标签节点上调度。

表18 LabelSelector

参数

是否必选

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

matchLabels

Map<String,String>

匹配的标签,格式为key:value键值对。 单个键值对相当于matchExpressions的一个元素,key字段为key,操作符为In,values数组中只有value。

表19 PodAffinityTerm

参数

是否必选

参数类型

描述

labelSelector

labelSelector object

标签选择器

namespaces

Array of strings

命名空间

topologyKey

String

拓扑标签。先圈定topologyKey指定的范围,然后再选择labelSelector定义的内容,即亲和调度只会在有topologyKey指定的标签节点上调度。

表20 labelSelector

参数

是否必选

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

matchLabels

Map<String,String>

匹配的标签,格式为key:value键值对。 单个键值对相当于matchExpressions的一个元素,key字段为key,操作符为In,values数组中只有value。

表21 MatchExpression

参数

是否必选

参数类型

描述

key

String

规则的标签

operator

String

操作符,取值如下:

  • In:标签值需要在values的列表中

  • NotIn:标签的值不在某个列表中

  • Exists:某个标签存在

  • DoesNotExist:某个标签不存在

  • Gt:标签的值大于某个值(字符串比较)

  • Lt:标签的值小于某个值(字符串比较)

values

Array of strings

一组标签值。

  • 如果运算符为In或NotIn,则值数组必须非空。

  • 如果运算符为Exists 或DoesNotExist,则值数组必须为空。

  • 如果运算符是Gt或Lt,则值数组必须具有单个元素,该元素将被解释为整数。

表22 ContainerDef

参数

是否必选

参数类型

描述

name

String

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

image_url

String

容器镜像URL

args

Array of strings

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

command

Array of strings

容器启动命令,字符总长度最大为65536。 command支持使用数组定义多条命令,但在IEF控制台界面只会显示第一条命令。

resources

DeploymentResources object

创建容器时使用的资源

envs

Array of Env objects

环境变量

ports

Array of HostContainerPortMapping objects

容器端口映射值

privileged

Boolean

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

run_as_user

Integer

容器运行用户ID,输入范围为0~65534的整数

readiness_probe

Probe object

探针配置

liveness_probe

Probe object

探针配置

version

String

容器镜像版本

volumes

Array of Volumes objects

卷配置

npu_type

String

NPU类型,支持D310、D310B,支持填写:

  • D310:D310类型

  • D310B:D310B类型

  • 空值:D310类型。

表23 DeploymentResources

参数

是否必选

参数类型

描述

limits

Map<String,String>

  • 允许容器使用的最大资源,key值支持填写:cpu, memory, gpu, npu。

  • 申请NPU资源时可填写指定的NPU芯片类型,支持填写:D310、D310B。注意:key值填写为npu时,默认使用npu_type字段指定的芯片类型。如果npu_type字段为空,默认使用D310芯片类型。

requests

Map<String,String>

  • 容器需要使用的最小资源,key值支持填写:cpu, memory, gpu, npu

  • 申请NPU资源时可填写指定的NPU芯片类型,支持填写:D310、D310B。注意:key值填写为npu时,默认使用npu_type字段指定的芯片类型。如果npu_type字段为空,默认使用D310芯片类型。

表24 Env

参数

是否必选

参数类型

描述

name

String

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

value

String

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

value_from

ValueFrom object

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

field_path

String

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

表25 ValueFrom

参数

是否必选

参数类型

描述

secret

Secrets object

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

configmap

ConfigsMap object

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

表26 Secrets

参数

是否必选

参数类型

描述

name

String

密钥的名称

key

String

密钥的属性名

表27 ConfigsMap

参数

是否必选

参数类型

描述

name

String

配置项的名称

key

String

配置项的属性名

表28 HostContainerPortMapping

参数

是否必选

参数类型

描述

container_port

Integer

构成一堆映射的容器端口

host_port

Integer

构成一对映射的物理机对应网卡端口

host_ip

String

对应网卡地址

host_port_range

HostPortRange object

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

表29 HostPortRange

参数

是否必选

参数类型

描述

min_port

Integer

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

max_port

Integer

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

表30 Probe

参数

是否必选

参数类型

描述

exec

Exec object

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

http_get

HttpGetDetail object

执行http探测

initial_delay_seconds

Integer

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

timeout_seconds

Integer

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

表31 Exec

参数

是否必选

参数类型

描述

command

String

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

表32 HttpGetDetail

参数

是否必选

参数类型

描述

path

String

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

port

Integer

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

host

String

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

scheme

String

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

表33 Volumes

参数

是否必选

参数类型

描述

name

String

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

type

String

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

source

String

卷来源,type为hostPath时输入路径,要求以/开头,后面可包含中划线,反斜杠,下划线,点号,字母,数字; secret时输入secret名称,configMap时输入configMap名称,emptyDir时输入disk或memory

destination

String

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

read_only

Boolean

读写权限,configMap和secret类型只支持读权限

default_mode

Integer

挂载的文件权限,仅configMap和secret类型生效,默认为0644,支持填写十进制和八进制参数

表34 Annotations

参数

是否必选

参数类型

描述

ring_controller

String

生成ranktablefile。该参数目前只支持赋值"ascend-1980"。

autonomy_edge_selector

String

离线自愈功能配置字段,须填写调度的节点组id

响应参数

状态码: 201

表35 响应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 Attributes objects

节点属性

api_version

String

应用部署版本

source

String

应用部署来源:边缘市场(iem)或自定义(userdefined)

project_id

String

项目ID

created_at

String

应用部署创建时间

updated_at

String

应用部署更新时间

template

PodRequest object

应用部署模板

state

String

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

source_id

String

预留字段

annotations

Annotations object

应用扩展功能配置选项

表36 Attributes

参数

参数类型

描述

key

String

节点属性的key值,长度取值范围为1~128, 仅允许大小写英文字母、数字、下划线、中划线

value

String

节点属性的value值,长度取值范围为1~256, 仅允许大小写英文字母、数字、下划线、中划线

表37 PodRequest

参数

参数类型

描述

configs

PodConfigs object

应用实例配置

affinity

Affinity object

应用实例亲和性规则,仅铂金版支持

init_containers

Array of ContainerDef objects

应用部署init业务容器

containers

Array of ContainerDef objects

应用部署业务容器

表38 PodConfigs

参数

参数类型

描述

host_network

Boolean

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

host_pid

Boolean

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

migration

Boolean

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

restart_policy

String

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

toleration_seconds

Integer

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

dns_policy

String

应用实例DNS策略,可选值Default、ClusterFirst、ClusterFirstWithHostNet,默认为Default。应用实例启用主机网络时只能选填Default、ClusterFirstWithHostNet,不启用主机网络时只能选填Default、ClusterFirst

表39 Affinity

参数

参数类型

描述

nodeAffinity

nodeAffinity object

节点亲和规则

podAffinity

podAffinity object

Pod亲和规则

podAntiAffinity

podAntiAffinity object

Pod反亲和规则

表40 nodeAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of PreferredSchedulingTerm objects

优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。

requiredDuringSchedulingIgnoredDuringExecution

RequiredDuringScheduling object

强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。

表41 PreferredSchedulingTerm

参数

参数类型

描述

preference

preference object

与相应权重关联的节点选择器项。

weight

Integer

权重,范围为1-100

表42 preference

参数

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

表43 RequiredDuringScheduling

参数

参数类型

描述

nodeSelectorTerms

Array of MatchExpressions objects

节点选择规则

表44 MatchExpressions

参数

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

表45 podAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of WeightPodAffinityTerms objects

优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。

requiredDuringSchedulingIgnoredDuringExecution

Array of PodAffinityTerm objects

强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。

表46 podAntiAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of WeightPodAffinityTerms objects

优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。

requiredDuringSchedulingIgnoredDuringExecution

Array of PodAffinityTerm objects

强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。

表47 WeightPodAffinityTerms

参数

参数类型

描述

podAffinityTerm

podAffinityTerm object

Pod亲和规则

weight

Integer

权重,范围为1-100

表48 podAffinityTerm

参数

参数类型

描述

labelSelector

LabelSelector object

标签选择器

namespaces

Array of strings

命名空间

topologyKey

String

拓扑标签。先圈定topologyKey指定的范围,然后再选择labelSelector定义的内容,即亲和调度只会在有topologyKey指定的标签节点上调度。

表49 LabelSelector

参数

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

matchLabels

Map<String,String>

匹配的标签,格式为key:value键值对。 单个键值对相当于matchExpressions的一个元素,key字段为key,操作符为In,values数组中只有value。

表50 PodAffinityTerm

参数

参数类型

描述

labelSelector

labelSelector object

标签选择器

namespaces

Array of strings

命名空间

topologyKey

String

拓扑标签。先圈定topologyKey指定的范围,然后再选择labelSelector定义的内容,即亲和调度只会在有topologyKey指定的标签节点上调度。

表51 labelSelector

参数

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

matchLabels

Map<String,String>

匹配的标签,格式为key:value键值对。 单个键值对相当于matchExpressions的一个元素,key字段为key,操作符为In,values数组中只有value。

表52 MatchExpression

参数

参数类型

描述

key

String

规则的标签

operator

String

操作符,取值如下:

  • In:标签值需要在values的列表中

  • NotIn:标签的值不在某个列表中

  • Exists:某个标签存在

  • DoesNotExist:某个标签不存在

  • Gt:标签的值大于某个值(字符串比较)

  • Lt:标签的值小于某个值(字符串比较)

values

Array of strings

一组标签值。

  • 如果运算符为In或NotIn,则值数组必须非空。

  • 如果运算符为Exists 或DoesNotExist,则值数组必须为空。

  • 如果运算符是Gt或Lt,则值数组必须具有单个元素,该元素将被解释为整数。

表53 ContainerDef

参数

参数类型

描述

name

String

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

image_url

String

容器镜像URL

args

Array of strings

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

command

Array of strings

容器启动命令,字符总长度最大为65536。 command支持使用数组定义多条命令,但在IEF控制台界面只会显示第一条命令。

resources

DeploymentResources object

创建容器时使用的资源

envs

Array of Env objects

环境变量

ports

Array of HostContainerPortMapping objects

容器端口映射值

privileged

Boolean

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

run_as_user

Integer

容器运行用户ID,输入范围为0~65534的整数

readiness_probe

Probe object

探针配置

liveness_probe

Probe object

探针配置

version

String

容器镜像版本

volumes

Array of Volumes objects

卷配置

npu_type

String

NPU类型,支持D310、D310B,支持填写:

  • D310:D310类型

  • D310B:D310B类型

  • 空值:D310类型。

表54 DeploymentResources

参数

参数类型

描述

limits

Map<String,String>

  • 允许容器使用的最大资源,key值支持填写:cpu, memory, gpu, npu。

  • 申请NPU资源时可填写指定的NPU芯片类型,支持填写:D310、D310B。注意:key值填写为npu时,默认使用npu_type字段指定的芯片类型。如果npu_type字段为空,默认使用D310芯片类型。

requests

Map<String,String>

  • 容器需要使用的最小资源,key值支持填写:cpu, memory, gpu, npu

  • 申请NPU资源时可填写指定的NPU芯片类型,支持填写:D310、D310B。注意:key值填写为npu时,默认使用npu_type字段指定的芯片类型。如果npu_type字段为空,默认使用D310芯片类型。

表55 Env

参数

参数类型

描述

name

String

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

value

String

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

value_from

ValueFrom object

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

field_path

String

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

表56 ValueFrom

参数

参数类型

描述

secret

Secrets object

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

configmap

ConfigsMap object

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

表57 Secrets

参数

参数类型

描述

name

String

密钥的名称

key

String

密钥的属性名

表58 ConfigsMap

参数

参数类型

描述

name

String

配置项的名称

key

String

配置项的属性名

表59 HostContainerPortMapping

参数

参数类型

描述

container_port

Integer

构成一堆映射的容器端口

host_port

Integer

构成一对映射的物理机对应网卡端口

host_ip

String

对应网卡地址

host_port_range

HostPortRange object

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

表60 HostPortRange

参数

参数类型

描述

min_port

Integer

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

max_port

Integer

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

表61 Probe

参数

参数类型

描述

exec

Exec object

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

http_get

HttpGetDetail object

执行http探测

initial_delay_seconds

Integer

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

timeout_seconds

Integer

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

表62 Exec

参数

参数类型

描述

command

String

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

表63 HttpGetDetail

参数

参数类型

描述

path

String

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

port

Integer

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

host

String

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

scheme

String

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

表64 Volumes

参数

参数类型

描述

name

String

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

type

String

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

source

String

卷来源,type为hostPath时输入路径,要求以/开头,后面可包含中划线,反斜杠,下划线,点号,字母,数字; secret时输入secret名称,configMap时输入configMap名称,emptyDir时输入disk或memory

destination

String

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

read_only

Boolean

读写权限,configMap和secret类型只支持读权限

default_mode

Integer

挂载的文件权限,仅configMap和secret类型生效,默认为0644,支持填写十进制和八进制参数

表65 Annotations

参数

参数类型

描述

ring_controller

String

生成ranktablefile。该参数目前只支持赋值"ascend-1980"。

autonomy_edge_selector

String

离线自愈功能配置字段,须填写调度的节点组id

状态码: 400

表66 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述信息

状态码: 500

表67 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述信息

请求示例

创建部署,应用部署到指定节点,容器网络为主机网络。

{
  "name" : "app",
  "description" : "this is a test app",
  "node_ids" : [ "9ebd8efb-9fdd-44a1-abda-9cdbc287a867" ],
  "tags" : [ {
    "key" : "app",
    "value" : "test"
  } ],
  "deployment" : {
    "replicas" : 1,
    "template" : {
      "configs" : {
        "host_network" : true,
        "host_pid" : true,
        "restart_policy" : "Always",
        "toleration_seconds" : 300
      },
      "containers" : [ {
        "name" : "container-0",
        "image_url" : "nginx:alpine",
        "resources" : {
          "limits" : {
            "cpu" : "0.25",
            "memory" : "500"
          },
          "requests" : {
            "cpu" : "0.25",
            "memory" : "500"
          }
        }
      } ]
    }
  }
}

响应示例

状态码: 201

ok

{
  "created_at" : "2020-09-23 02:38:17.894471458 +0000 UTC",
  "replicas" : 1,
  "ready_replicas" : 0,
  "description" : "this is a test app",
  "group_id" : "",
  "node_ids" : [ "9ebd8efb-9fdd-44a1-abda-9cdbc287a867" ],
  "id" : "66a7fe7e-699a-41b2-9119-f9468a5ed78e",
  "name" : "app",
  "source" : "",
  "template" : {
    "configs" : {
      "host_network" : true,
      "host_pid" : true,
      "restart_policy" : "Always",
      "migration" : false,
      "toleration_seconds" : 300
    },
    "init_containers" : [ ],
    "containers" : [ {
      "name" : "container-0",
      "image_url" : "nginx:alpine",
      "npu_type" : "",
      "resources" : {
        "limits" : {
          "cpu" : "0.25",
          "memory" : "500"
        },
        "requests" : {
          "cpu" : "0.25",
          "memory" : "500"
        }
      },
      "privileged" : false,
      "version" : ""
    } ]
  },
  "state" : "",
  "project_id" : "05e1aef9040010e22fccc009adecb056",
  "updated_at" : "2020-09-23 02:38:17.894471458 +0000 UTC",
  "api_version" : "v3",
  "source_id" : ""
}

状态码: 400

error

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

状态码: 500

error

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

状态码

状态码

描述

201

ok

400

error

500

error

错误码

请参见错误码

相关文档