文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API(v3版本)/ 发布管理/ 旧版发布管理/ 根据发布单ID获取发布单信息 - ObtainInformationAboutReleaseTaskBasedOnTheReleaseTaskID
更新时间:2026-02-28 GMT+08:00
分享

根据发布单ID获取发布单信息 - ObtainInformationAboutReleaseTaskBasedOnTheReleaseTaskID

功能介绍

此API用来根据发布单ID获取发布单信息。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    servicestage::getReleasePlan

    read

    -

    -

    servicestage:app:get

    -

URI

GET /v3/{project_id}/cas/release-plans/{release_plan_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户项目ID。获取方法,请参考获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

release_plan_id

String

参数解释:

发布单ID。获取方法,请参考获取发布单列表 - ObtainReleaseTaskList

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

不涉及

取值范围:

application/json;charset=utf8

默认取值:

不涉及

X-Auth-Token

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应消息

表3 响应参数

参数

参数类型

描述

id

String

发布单ID。

action

String

发布单类型。

  • clone:克隆。
  • upgrade:升级。
  • create:部署。

swimlane_id

String

泳道ID。

desc

String

描述。

components

Array of objects

组件列表,请参考表4

name

String

发布单名称。

fail_strategy

String

失败策略。

  • continue:继续。
  • stop:停止。

status

String

发布单状态。

  • SUCCESS,成功。
  • CREATED,已创建。
  • FAILED,失败。
  • PARTIALLY_FAILED,部分失败。
  • ROLLBACK_FAILED,回滚失败。
  • ROLLBACK_SUCCEED,回滚成功。
  • ABORTED,操作中止。

create_time

Integer

创建时间。

modify_time

Integer

更新时间。

execute_time

Integer

执行时间。

creator

String

创建人。

表4 components

参数

参数类型

描述

seq

Integer

发布批次。

component_id

String

应用组件ID。

name

String

应用组件名称。

由英文字母、数字、中划线(-)、下划线(_)组成,并以英文字母开头,英文字母或者数字结尾,长度为2~64个字符。

workload_name

String

工作负载名称。

labels

Array of objects

标签。容器部署可通过标签查询对应工作负载;虚拟机部署可配置对应的微服务名称的标签来使用优雅上下线功能。请参考表5

create_mode

String

组件创建方式,默认不传此参数表示创建并部署组件。

runtime_stack

Object

运行时,请参考表31,可通过查询查询技术栈 - QueryTechnologyStack接口返回的信息获取。

environment_id

String

环境ID。

description

String

描述。

最大长度为128个字符。

source

Object

代码/软件包来源,请参考表32

build

Object

组件构建,容器部署并没有使用镜像时必传,请参考表33

limit_cpu

Number

最大CPU限制,单位为Core。

limit_memory

Number

最大内存限制,单位为GiB。

request_cpu

Number

申请CPU资源,单位为Core。

request_memory

Number

申请内存资源,单位为GiB。

version

String

组件版本号,最大长度32,规则为:

^([0-9]+)(\.[0-9]+){2,3}$

envs

Array of objects

环境变量列表,请参考表29

replica

Integer

实例数。

storages

Array of objects

存储,请参考表6

deploy_strategy

Object

组件部署,请参考表9

command

Object

启动命令,请参考表13

post_start

Object

启动后处理,请参考表14

pre_stop

Object

停止前处理,请参考表14

mesher

Object

多语言接入服务网格,当技术栈选择Node.js且绑定微服务引擎时为必选,请参考表15

timezone

String

指定组件运行的时区。

jvm_opts

String

jvm参数,例如-Xms256m -Xmx1024m,多个参数以空格间隔,不填则使用默认值。

tomcat_opts

Object

tomcat参数,技术栈选择tomcat时生效,请参考表16

host_aliases

Array of objects

主机别名,请参考表17

dns_policy

String

DNS策略。

  • Default,继承pod所在节点域名解析配置。
  • ClusterFirst,追加域名解析配置。
  • ClusterFirstWithHostNet,仅对以hostNetWork方式运行的pod生效。
  • None,替换域名解析策略。

dns_config

Object

DNS配置,请参考表18

workload_kind

String

工作负载类型。

  • deployment,无状态工作负载。
  • statefulset,有状态工作负载。
  • daemonset,守护进程集。
  • job,普通任务。

security_context

Object

安全策略,请参考表20

logs

Array of objects

日志采集,请参考表22

custom_metric

Object

自定义指标监控,请参考表23

affinity

Array of objects

亲和性,请参考表24

anti_affinity

Array of objects

反亲和性,请参考表24

liveness_probe

Object

组件存活探针,请参考表26

readiness_probe

Object

组件业务探针,请参考表26

startup_probe

Object

组件启动探针,请参考表26

refer_resources

Array of objects

关联资源,请参考表27

external_accesses

Array of objects

外部访问,请参考表35

tolerations

Array of objects

容忍度策略,请参考表36

container_name

String

容器名称。

update_strategy

Object

组件升级策略,请参考表39

multi_containers

Array of objects

多容器配置,请参考表37

service_name

String

有状态负载的实例间发现服务配置Service名称。

ports

Array of objects

有状态负载的实例间发现服务配置端口配置,请参考表38

workload_content

String

工作负载内容。

configs

Array of objects

组件统一配置,请参考表40

enable_sermant_injection

Boolean

是否开启Sermant。

enable_sermant_spring_register

Boolean

Spring Cloud Huawei框架的微服务是否需要Sermant帮助注册到注册中心。

enable_sermant_dubbo_register

Boolean

Dubbo框架的微服务是否需要Sermant帮助注册到注册中心。

enable_sermant_config

Boolean

是否开启Sermant动态配置插件能力。

cell_id

String

部署单元ID。

swimlane_id

String

泳道ID。

sermantAgentInjectActionFlag

Boolean

JDK17以及JDK21是否自动添加以下JVM环境变量。

JDK17:

--add-opens java.base/java.lang=ALL-UNNAMED
--add-opens java.base/java.net=ALL-UNNAMED
--add-opens java.base/java.math=ALL-UNNAMED
--add-opens java.base/sun.net.www=ALL-UNNAMED
--add-opens java.base/sun.net.www.protocol.http=ALL-UNNAMED

JDK21:

--add-opens java.base/java.lang=ALL-UNNAMED
--add-opens java.base/java.net=ALL-UNNAMED
--add-opens java.base/java.math=ALL-UNNAMED
--add-opens java.base/sun.net.www=ALL-UNNAMED
--add-opens java.base/sun.net.www.protocol.http=ALL-UNNAMED
-Dnet.bytebuddy.experimental=true

sys_config

Map<String, String>

使用压缩包在虚拟机环境下部署组件配置项。

image_pull_secrets

Array of strings

镜像拉取密钥列表。

auto_lts_config

Object

LTS自动配置,请参考表41

config_encryption

Object

单容器组件配置加密密钥时需设置,请参考表42

task_setting

Object

job类型工作负载的任务设置,请参考表43

表5 labels

参数

参数类型

描述

key

String

参数解释:

标签名称。

取值范围:

不涉及

value

String

参数解释:

标签值。

取值范围:

不涉及

表6 storages

参数

参数类型

描述

type

String

数据存储类型。

  • HostPath,本地磁盘主机路径挂载。
  • EmptyDir,本地磁盘临时路径挂载。
  • ConfigMap, 本地磁盘配置项挂载。
  • Secret,本地磁盘密钥挂载。
  • PersistentVolumeClaim, 云存储挂载。

name

String

存储盘名称。

parameters

Object

对应各种数据存储类型的信息参数,请参考表7

mounts

Array of objects

数据存储挂载路径,请参考表8

表7 component_storage_parameters

参数

参数类型

描述

path

String

参数解释:

主机路径, 适用于HostPath的存储类型。

取值范围:

不涉及

name

String

参数解释:

配置项、密钥或者PVC的名字, 适用于ConfigMap、Secret和PersistentVolumeClaim的存储类型。

取值范围:

不涉及

default_mode

Integer

参数解释:

挂载的权限,十进制格式,例如:384。适用于ConfigMap和Secret的存储类型。

取值范围:

不涉及

medium

String

参数解释:

适用于EmptyDir类型的存储,例如:memory。

取值范围:

不涉及

表8 mounts

参数

参数类型

描述

path

String

参数解释:

挂载路径。

取值范围:

不涉及

sub_path

String

参数解释:

挂载路径的子路径。

取值范围:

不涉及

read_only

Boolean

参数解释:

是否只读。

取值范围:

  • true:只读,只能读应用路径中的数据存储。
  • false:读写,可修改应用路径中的数据存储,应用迁移时新写入的数据不会随之迁移,会造成数据丢失。
表9 deploy_strategy

参数

参数类型

描述

type

String

部署类型。

  • OneBatchRelease,单批升级。
  • RollingRelease,滚动部署升级。
  • GrayRelease,灰度发布升级。

rolling_release

Object

滚动部署参数,部署类型为RollingRelease时为必选,请参考表10

gray_release

Object

灰度发布升级,部署类型为GrayRelease时为必选,请参考表11

表10 rolling_release

参数

参数类型

描述

batches

Integer

分批部署批次。

表11 gray_release

参数

参数类型

描述

type

String

灰度策略。

  • WEIGHT,按灰度流量进行升级。
  • CONTENT,按内容进行灰度。

first_batch_weight

Integer

首批灰度流量比例,灰度策略为WEIGHT时为必选。

first_batch_replica

Integer

首批灰度实例数量,灰度策略为WEIGHT时为必选。

remaining_batch

Integer

剩余实例部署批次,首批灰度发布成功之后,剩余实例滚动升级分多少批次完成。

例如:剩余实例数是5,剩余部署批次是3,那么升级剩余实例会按照2:2:1个实例分批升级。

灰度策略为WEIGHT时为必选。

deployment_mode

Integer

部署模型。

  • 1,上游是微服务网关。
  • 3,上游是微服务。
  • 4,上游是ELB。

replica_surge_mode

String

灰度实例新增模式,灰度策略为CONTENT时为必选。

  • MIRROR,蓝绿。
  • EXTRA,金丝雀(先增后减)。
  • NOSURGE,金丝雀(先减后增)。

rule_match_mode

String

灰度规则生效方式,灰度策略为CONTENT时为必选。

  • ALL,满足所有条件。
  • ANY,满足任一条件。

rules

Object

灰度规则,参数表12,灰度策略为CONTENT时为必选。

表12 gray_rules

参数

参数类型

描述

type

String

参数解释:

匹配类型。

取值范围:

HEADER:请求头

key

String

参数解释:

参数名称。

取值范围:

不涉及

value

String

参数解释:

条件值。

取值范围:

不涉及

condition

String

参数解释:

条件类型。

取值范围:

  • EQUAL:相等。
  • MATCH:匹配。
  • IN:枚举。
表13 command

参数

参数类型

描述

command

Array of strings

参数解释:

运行命令,控制容器运行的输入命令。

取值范围:

不涉及

args

Array of strings

参数解释:

运行参数,控制容器运行命令的输入参数。例如:-port=8080,多条参数以换行分隔。

取值范围:

不涉及

表14 component_lifecycle

参数

参数类型

描述

type

String

参数解释:

处理方式。

取值范围:

  • http,http请求方式。
  • command,命令行方式。

scheme

String

参数解释:

http请求类型。type为http类型时生效。

取值范围:

  • HTTP
  • HTTPS

host

String

参数解释:

默认为POD的IP,可以指定自定义的IP。type为http类型时生效。

取值范围:

不涉及

port

Integer

参数解释:

端口号,type为http类型时生效。

取值范围:

不涉及

path

String

参数解释:

请求路径,type为http类型时生效。

取值范围:

不涉及

command

Array of strings

参数解释:

命令列表,type为command类型时生效。

取值范围:

不涉及

表15 mesher

参数

参数类型

描述

port

Integer

参数解释:

进程监听端口。

取值范围:

不涉及

表16 tomcat_opt

参数

参数类型

描述

server_xml

String

参数解释:

  1. 监听端口以server.xml配置的为准,如果之前在公网访问配置了监听端口,请保持一致。
  2. 自定义的Tomcat配置可能存在端口冲突,请检查自定义的端口是否被占用。

取值范围:

不涉及

表17 host_aliases

参数

参数类型

描述

ip

String

参数解释:

IP地址。

取值范围:

不涉及

hostname

Array of strings

参数解释:

主机别名。

取值范围:

不涉及

表18 dns_config

参数

参数类型

描述

nameservers

Array of strings

Pod的DNS服务器的IP地址列表。

searches

Array of strings

可选,用于在Pod中查找主机名的DNS搜索域的列表。

options

Array of objects

可选,对象列表。其中每个对象可能具有name属性(必需)和value属性(可选)。 此属性中的内容将合并到从指定的DNS策略生成的选项,重复的条目将被删除,请参考表19

表19 options

参数

参数类型

描述

name

String

参数解释:

操作名称。

取值范围:

不涉及

value

String

参数解释:

操作值。

取值范围:

不涉及

表20 security_context

参数

参数类型

描述

run_as_user

Integer

运行用户,容器以当前用户权限运行,如以root权限运行则填写root用户ID 0。

run_as_group

Integer

运行属组,指定所有容器中的进程都以属组运行。

capabilities

Object

能力集,请参考表21

表21 capabilities

参数

参数类型

描述

add

Array of strings

参数解释:

为运行用户添加Linux权限。

取值范围:

不涉及

drop

Array of strings

参数解释:

移除运行用户Linux权限。

取值范围:

不涉及

表22 logs

参数

参数类型

描述

log_path

String

参数解释:

容器中日志路径。

取值范围:

不涉及

rotate

String

参数解释:

日志转储周期。

取值范围:

不涉及

host_path

String

参数解释:

挂载的主机路径。

取值范围:

不涉及

host_extend_path

String

参数解释:

主机扩展路径,通过扩展主机路径,实现同一个主机路径下区分来自不同容器的挂载。

取值范围:

  • None:不使用扩展路径。
  • PodUID:通过POD的ID扩展主机路径。
  • PodName:通过POD的名称扩展主机路径。
  • PodUID/ContainerName:通过POD的ID和容器名称扩展主机路径。
  • PodName/ContainerName:通过POD的名称和容器名称扩展主机路径。
表23 custom_metric

参数

参数类型

描述

path

String

参数解释:

采集路径,例如:/metrics。

取值范围:

不涉及

port

Integer

参数解释:

采集端口,例如:9090。

取值范围:

不涉及

dimensions

String

参数解释:

监控维度,例如:"cpu_usage,mem_usage"。

取值范围:

不涉及

表24 component_affinity

参数

参数类型

描述

kind

String

对象类型。

  • node:节点。
  • pod:工作负载。

condition

String

策略满足类型。

  • required:必须满足。
  • preferred:尽量满足。

match_expressions

Array of objects

调度策略规则,请参考表25

weight

String

权重。

  • “condition”选择“required”时,固定为100。
  • “condition”选择“preferred”时,可输入1到100之间的整数。
表25 match_expressions

参数

参数类型

描述

key

String

参数解释:

匹配标签key值。

取值范围:

不涉及

operation

String

参数解释:

匹配条件。

取值范围:

不涉及

value

String

参数解释:

匹配标签value值。

取值范围:

不涉及

表26 component_probe

参数

参数类型

描述

type

String

参数解释:

类型。

取值范围:

  • http:HTTP请求检查
  • tcp:TCP端口检查
  • command:执行命令检查

delay

Integer

参数解释:

启动后多久开始探测。

取值范围:

不涉及

timeout

Integer

参数解释:

探测超时时间

取值范围:

不涉及

scheme

String

参数解释:

请求类型。type为http类型时生效。

取值范围:

  • HTTP
  • HTTPS

host

String

参数解释:

默认为POD的IP,可以指定自定义的IP。type为http类型时生效。

取值范围:

不涉及

port

Integer

参数解释:

端口号,type为http和tcp类型时生效。

取值范围:

不涉及

path

String

参数解释:

请求路径,type为http类型时生效。

取值范围:

不涉及

command

Array of strings

参数解释:

命令列表,type为command类型时生效。

取值范围:

不涉及

表27 refer_resources

参数

参数类型

描述

id

String

资源ID。

type

String

资源类型:

  • elb:弹性负载均衡
  • cce:云容器引擎
  • ecs:弹性云服务器
  • as: 弹性伸缩组
  • cse:ServiceComb引擎
  • nacos:注册配置中心
  • dcs:分布式缓存服务
  • rds:云数据库RDS
  • gaussdb:云数据库GaussDB
  • dms_rocketmq:分布式消息服务RocketMQ
  • customServer:自定义服务器
  • pvc:存储卷声明
  • css_es:云搜索服务Elasticsearch
  • custom_k8s:自定义kubernetes集群

parameters

Object

资源参数,请参考表28

表28 refer_resource_parameter

参数

参数类型

描述

namespace

String

命名空间。

name

String

资源名。

capacity

Integer

存储容量,单位GiB。

type

String

存储卷声明类型。

  • efs,极速文件存储。
  • obs,对象存储。
  • sfs,文件存储。
  • evs,云硬盘。

class

String

存储卷声明子类型。

  • csi-sfsturbo,type为efs时固定指定。
  • csi-obs,type为obs时固定指定。
  • csi-nas,type为sfs时固定指定。
  • csi-disk,type为evs时固定指定。

obs_volume_type

String

OBS存储卷类型,默认为STANDARD标准存储类型。

  • STANDARD:标准存储,拥有低访问时延和较高的吞吐量,适用于有大量热点对象(平均一个月多次)或小对象(<1MB),且需要频繁访问数据的业务场景。
  • WARM:低频访问存储,适用于不频繁访问(平均一年少于12次)但在需要时也要求能够快速访问数据的业务场景。
  • COLD:归档存储,适用于很少访问(平均一年访问一次)数据的业务场景。

access_mode

String

存储卷访问模式。

  • ReadWriteOnce:卷可以被一个节点以读写方式挂载。
  • ReadWriteMany:卷可以被多个节点以读写方式挂载。

availableZone

String

可用区。

volume_type

String

存储卷类型。

  • SATA:普通IO,是指由SATA存储提供资源的磁盘类型。
  • SAS:高IO,是指由SAS存储提供资源的磁盘类型。
  • SSD:超高IO,是指由SSD存储提供资源的磁盘类型。
表29 envs

参数

参数类型

描述

name

String

变量名。

value

String

变量值。

value_from

Object

变量引用,请参考表30

表30 value_from

参数

参数类型

描述

reference_type

String

参数解释:

引用类型。

取值范围:

  • configMapKey:配置项导入。
  • secretKey:密钥导入。

name

String

参数解释:

配置项或密钥的名称。

取值范围:

不涉及

key

String

参数解释:

配置项或密钥的键值。

取值范围:

不涉及

optional

Boolean

参数解释:

配置项或密钥的key是否必须存在。

取值范围:

  • true:必须存在
  • false:非必须存在
表31 runtime_stack

参数

参数类型

描述

name

String

参数解释:

技术栈名称,例如:OpenJDK8。

取值范围:

不涉及

type

String

参数解释:

技术栈类型。

取值范围:

  • 部署模式为虚机部署时,支持Java、Tomcat、Nodejs。
  • 部署模式为容器部署时,支持Java、Tomcat、Nodejs、Php、Docker、Python。

version

String

参数解释:

技术栈版本,例如:1.1.4。

取值范围:

不涉及

deploy_mode

String

参数解释:

部署模式。

取值范围:

  • container:容器部署
  • virtualmachine:虚机部署
表32 source

参数

参数类型

描述

kind

String

参数解释:

组件来源类型。

取值范围:

  • code:源码。
  • package:软件包。
  • image:镜像包。

version

String

参数解释:

版本号。

取值范围:

不涉及

url

String

参数解释:

包地址,类型为package和image时需要添加。

取值范围:

不涉及

storage

String

参数解释:

存储方式。

取值范围:

  • devcloud:CodeArts软件发布库。
  • obs:OBS对象存储。
  • http:自定义文件地址。
  • swr:镜像仓库。

组件来源包类型为package和image时需要添加。

auth

String

参数解释:

认证方式。

取值范围:

  • iam:IAM认证
  • none:无认证

repo_auth

String

参数解释:

授权名称,在授权列表获取,请参考获取仓库授权列表 - ObtainGitRepositoryAuthorizationList

取值范围:

不涉及

repo_namespace

String

参数解释:

代码仓库命名空间。

取值范围:

不涉及

repo_ref

String

参数解释:

代码分支或者Tag,默认是master。

取值范围:

不涉及

repo_type

String

参数解释:

代码仓类型。

取值范围:

  • DevCloud,codearts制品仓。
  • Gitee,开源中国推出代码托管平台。
  • GitHub,开源代码仓。
  • GitLab,开源代码仓。
  • Bitbucket,源代码托管网站。

web_url

String

参数解释:

代码跳转链接,例如:https://github.com/example/demo.git。

取值范围:

不涉及

repo_url

String

参数解释:

代码仓url,例如:https://github.com/example/demo.git。

取值范围:

不涉及

commit_id

String

参数解释:

代码仓库中,commit id是每次提交的唯一标识符,用于识别和引用特定的提交。

取值范围:

长度为8到40个字符,以小写字母或数字开头。

http_username

String

参数解释:

“storage”“http”时需要填写,支持用户名、密码认证,这里填写用户名。

取值范围:

不涉及

http_password

String

参数解释:

“storage”“http”时需要填写,支持用户名、密码认证,这里填写密码。

取值范围:

不涉及

http_command

String

参数解释:

“storage”“http”时需要填写,这里是用户定义软件包的地址。

取值范围:

不涉及

http_headers

Map<String, String>

参数解释:

“storage”“http”时需要填写,支持用户自定义请求头,支持填写一个key,value,例如{"key":"xx","value":"xx""},其中的key和value关键字固定。

取值范围:

不涉及

表33 build

参数

参数类型

描述

parameters

Object

只在没有ID,新创建构建时提供,请参考表34

表34 parameters

参数

参数类型

描述

build_cmd

String

参数解释:

编译命令。默认:

  1. 根目录存在build.sh:./build.sh
  2. 根据运行系统,示例如下:
    • Java和Tomcat:mvn clean package
    • Nodejs: npm build

取值范围:

不涉及

dockerfile_path

String

参数解释:

dockerfile地址,默认是根目录./。

取值范围:

不涉及

artifact_namespace

String

参数解释:

构建归档组织,默认cas_{project_id}。

取值范围:

不涉及

cluster_id

String

参数解释:

指定构建集群的id。

取值范围:

不涉及

node_label_selector

Map<String, String>

参数解释:

key是标签的键,value是标签的值。

取值范围:

不涉及

environment_id

String

参数解释:

环境ID。

取值范围:

不涉及

表35 external_accesses

参数

参数类型

描述

protocol

String

参数解释:

外部访问类型。

取值范围:

  • http:超文本传输协议
  • https:超文本传输安全协议

address

String

参数解释:

外部访问地址。

取值范围:

不涉及

forward_port

Integer

参数解释:

外部访问端口。

取值范围:

不涉及

表36 tolerations

参数

参数类型

描述

key

String

参数解释:

污点键。

取值范围:

不涉及

operator

String

参数解释:

操作符。

取值范围:

  • Equal:设置此操作符表示准确匹配指定污点键(必填)和污点值的节点。如果不填写污点值,则表示可以与所有污点键相同的污点匹配。
  • Exists:设置此操作符表示匹配存在指定污点键的节点,此时容忍度不能指定污点值。若不填写污点键则可以容忍全部污点。

value

String

参数解释:

污点值。“operator”“Equal”时,需要填写污点值。

取值范围:

不涉及

effect

String

参数解释:

污点策略。

取值范围:

  • NoScheduler:表示匹配污点效果为NoSchedule的污点。
  • PreferNoSchedule:表示匹配污点效果为PreferNoSchedule的污点。
  • NoExecute:表示匹配污点效果为NoExecute的污点。
  • 不设置该参数:表示匹配所有污点效果。

toleration_seconds

Integer

参数解释:

容忍时间窗。

“effect”“NoExecute”时支持配置。在容忍时间窗内,Pod还会在拥有污点的节点上运行,超出时间后会被驱逐。

取值范围:

不涉及

表37 multi_containers

参数

参数类型

描述

container_name

String

容器名称。

source

Object

代码/软件包来源,请参考表32,多容器模式下仅支持镜像。

limit_cpu

Number

最大CPU限制,单位为Core。

limit_memory

Number

最大内存限制,单位为GiB。

request_cpu

Number

申请CPU资源,单位为Core。

request_memory

Number

申请内存资源,单位为GiB。

envs

Array of objects

环境变量列表,请参考表29

liveness_probe

Object

容器存活探针,请参考表26

readiness_probe

Object

容器业务探针,请参考表26

startup_probe

Object

容器启动探针,请参考表26

command

Object

启动命令,请参考表13

post_start

Object

启动后处理,请参考表14

pre_stop

Object

停止前处理,请参考表14

logs

Array of objects

日志采集,请参考表22

storages

Array of objects

存储,请参考表6

security_context

Object

安全策略,请参考表20

config_encryption

Object

多容器组件配置加密密钥时需设置,请参考表42

表38 ports

参数

参数类型

描述

name

String

参数解释:

端口名称。

取值范围:

不涉及

port

String

参数解释:

访问端口。

取值范围:

不涉及

target_port

String

参数解释:

容器端口。

取值范围:

不涉及

表39 update_strategy

参数

参数类型

描述

type

String

参数解释:

组件升级类型:

取值范围:

  • RollingUpdate:滚动升级,即逐步创建新实例再删除旧实例,为默认策略。
  • Recreate:替换升级,即先把当前实例删掉再重新创建实例。

max_unavailable

  • String
  • Integer

参数解释:

最大无效实例数。与replica相比,可以有多少个实例失效,也就是删除的比例,默认值是25%。workload_kind为deployment时支持设置。

取值范围:

  • 若下发百分比则为String类型,即与实例数相比无效实例数在实例数中的最大百分比。
  • 若下发整数则为Integer类型,即与实例数相比最多可以有多少个无效实例数。

max_surge

  • String
  • Integer

参数解释:

最大浪涌。与replica相比,可以有多少个实例存在,默认值是25%。仅workload_kind为deployment时支持设置。

取值范围:

  • 若下发百分比则为String类型。
  • 若下发整数则为Integer类型。

termination_period_seconds

Integer

参数解释:

缩容时间窗。工作负载停止前命令的执行时间窗,默认值为30秒。

取值范围:

不涉及

min_ready_seconds

Integer

参数解释:

实例可用最短时间。指定新创建的实例在没有任意容器崩溃情况下的最小就绪时间,只有超出这个时间实例才被视为可用。

默认值为0。

取值范围:

不涉及

progress_deadline_seconds

Integer

参数解释:

升级最大时长。指定系统在报告组件升级失败之前等待组件取得进展的秒数。

如果指定,则此字段值需要大于min_ready_seconds取值。

取值范围:

不涉及

revision_history_limit

Integer

参数解释:

最大保留版本数。用来设定出于回滚目的所要保留的旧实例数量。默认情况下,系统保留10个旧实例。

取值范围:

不涉及

表40 configs

参数

参数类型

描述

config_id

String

参数解释:

统一配置ID。

取值范围:

不涉及

mount_path

String

参数解释:

挂载路径。

取值范围:

不涉及

表41 auto_lts_config

参数

参数类型

描述

enable

Boolean

参数解释:

是否开启LTS自动配置。

取值范围:

  • true:开启
  • false:不开启

lts_log_path

Array of strings

参数解释:

接入配置日志路径。

取值范围:

不涉及

表42 config_encryption

参数

参数类型

描述

key_id

String

参数解释:

DEW服务中用户密钥ID。

取值范围:

不涉及

表43 task_setting

参数

参数类型

描述

parallelism

Integer

参数解释:

并行数。

取值范围:

不涉及

active_deadline_seconds

Integer

参数解释:

超时时间(秒)。

取值范围:

不涉及

completion_mode

String

参数解释:

完成模式

取值范围:

  • NonIndexed:非索引模式。
  • Indexed:索引模式。

suspend

Boolean

参数解释:

是否挂起任务。

默认任务创建后被立即执行。

选择挂起任务后,任务创建后处于挂起状态;将其关闭后,任务继续执行。

取值范围:

  • true:挂起任务
  • false:不挂起任务

请求示例

响应示例

{
    "desc": "",
    "components": [
        {
            "runtime_stack": {
                "type": "Docker",
                "name": "Docker",
                "deploy_mode": "container",
                "version": ""
            },
            "source": {
                "kind": "image",
                "url": "swr.cn-north-4.myhuaweicloud.com/cae-group1/sch:v1",
                "storage": "swr",
                "auth": "iam"
            },
            "replica": 1,
            "version": "2024.0802.18390",
            "envs": [
                {
                    "name": "MOCK_ENABLED",
                    "value": "true"
                }
            ],
            "storages": [],
            "update_strategy": {
                "type": "RollingUpdate",
                "max_unavailable": "25%",
                "max_surge": "25%",
                "termination_period_seconds": 30
            },
            "command": {
                "command": [],
                "args": []
            },
            "jvm_opts": "",
            "tomcat_opts": {
                "server_xml": ""
            },
            "logs": [],
            "custom_metric": {
                "path": null,
                "port": 0,
                "dimensions": null
            },
            "affinity": [],
            "anti_affinity": [],
            "tolerations": [
                {
                    "key": "node.kubernetes.io/not-ready",
                    "operator": "Exists",
                    "value": null,
                    "effect": "NoExecute",
                    "toleration_seconds": 300
                },
                {
                    "key": "node.kubernetes.io/unreachable",
                    "operator": "Exists",
                    "value": null,
                    "effect": "NoExecute",
                    "toleration_seconds": 300
                }
            ],
            "liveness_probe": {
                "type": null,
                "delay": 0,
                "timeout": 0,
                "scheme": null,
                "host": null,
                "port": 0,
                "path": null,
                "command": null
            },
            "readiness_probe": {
                "type": null,
                "delay": 0,
                "timeout": 0,
                "scheme": null,
                "host": null,
                "port": 0,
                "path": null,
                "command": null
            },
            "startup_probe": {
                "type": null,
                "delay": 0,
                "timeout": 0,
                "scheme": null,
                "host": null,
                "port": 0,
                "path": null,
                "command": null
            },
            "refer_resources": [
                {
                    "id": "7bc15618-f875-11ee-9505-0255ac100b08",
                    "type": "cce",
                    "parameters": {
                        "name": "cce-lianghuanyu",
                        "namespace": "default",
                        "type": "VirtualMachine"
                    }
                },
                {
                    "id": "ebeb26bd-3e27-49d6-bf70-bb1fa07a0500",
                    "type": "cse",
                    "parameters": null
                }
            ],
            "workload_kind": "deployment",
            "enable_sermant_injection": false,
            "enable_sermant_spring_register": false,
            "enable_sermant_dubbo_register": false,
            "enable_sermant_config": false,
            "sys_config": {},
            "swimlane_id": "180c158a-0b45-41b4-a8da-767e8fb8e156",
            "container_name": "sch-env-apitest-ss-lb0i2d",
            "seq": 1,
            "environment_id": "48874c71-4898-442f-87fc-afff135d65d1",
            "name": "sch"
        }
    ],
    "name": "release-jxams3",
    "fail_strategy": "stop",
    "action": "clone",
    "swimlane_id": "180c158a-0b45-41b4-a8da-767e8fb8e156",
    "id": "716eda33-dbc6-47f3-953f-29119edd5e5c",
    "create_time": 1722933924775,
    "modify_time": 0,
    "status": "SUCCESS",
    "execute_time": 1722933924876,
    "creator": "wzh"
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

请参考ServiceStage错误码

相关文档