# 重新部署普通任务组件 - RedeployJobComponent #### 功能介绍 此API用于重新部署状态为执行完成或者失败的普通任务组件。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-servicestage/servicestage_06_0183.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | servicestage:app:modifyComponent | write | app \* | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) - [g:ResourceTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | servicestage:app:modify | - aom:discoveryRule:list - aom:discoveryRule:set - as:scalingConfig:create - as:scalingConfig:delete - as:scalingConfig:get - as:scalingConfig:list - as:scalingPolicy:get - as:scalingPolicy:list - as:scalingPolicy:update - cce:cluster:get - dcs:instance:get - dns:recordset:create - dns:recordset:delete - dns:recordset:get - ecs:cloudServers:get - elb:l7policies:get - elb:l7policies:list - elb:l7policies:update - elb:listeners:get - elb:listeners:list - elb:listeners:update - elb:members:get - elb:members:list - elb:members:update - rds:instance:get - vpc:addressGroups:get - vpc:networks:get - vpc:routeTables:get - vpc:securityGroupRules:get - vpc:securityGroups:get - vpc:subnets:get - vpc:subnets:get - vpc:vpcs:get | #### URI PUT /v3/{project_id}/cas/applications/{application_id}/components/{component_id}/redeployment 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户项目ID。获取方法，请参考[获取项目ID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0164.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | application_id | 是 | String | **参数解释：** 应用ID。获取方法，请参考[获取所有应用 - ObtainAllApplications](https://support.huaweicloud.com/api-servicestage/servicestage_06_0068.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | component_id | 是 | String | **参数解释：** 组件ID。获取方法，请参考[获取应用所有组件 - ObtainAllComponentsOfAnApplication](https://support.huaweicloud.com/api-servicestage/servicestage_06_0077.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求消息 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及 **取值范围：** application/json;charset=utf8 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考[认证鉴权](https://support.huaweicloud.com/api-servicestage/servicestage_06_0010.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释：** 应用组件名称。 **约束限制：** 不可修改。 **取值范围：** 由英文字母、数字、中划线（-）、下划线（_）组成，并以英文字母开头，英文字母或者数字结尾，长度为2\~64个字符。 **默认取值：** 不涉及 | | labels | 否 | Array of objects | **参数解释：** 标签。容器部署可通过标签查询对应工作负载，虚机部署可配置对应的微服务名称的标签来使用优雅上下线功能，请参考[表4]。 | | runtime_stack | 是 | Object | **参数解释：** 运行时，不可修改，请参考[表27]，可通过查询[查询技术栈 - QueryTechnologyStack](https://support.huaweicloud.com/api-servicestage/servicestage_06_0085.html)接口返回的信息获取。 | | description | 否 | String | **参数解释：** 描述。 **取值范围：** 最大长度为128个字符。 | | source | 是 | Object | **参数解释：** 代码/软件包来源，请参考[表28]。 | | build | 否 | Object | **参数解释：** 组件构建，请参考[表29]。 | | 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 | **参数解释：** 环境变量列表，请参考[表25]。 | | replica | 是 | Integer | **参数解释：** 实例数，仅在使用扩缩容功能时支持进行修改。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | storages | 否 | Array of objects | **参数解释：** 存储，请参考[表5]。 | | deploy_strategy | 否 | Object | **参数解释：** 组件部署，请参考[表8]。 | | command | 否 | Object | **参数解释：** 启动命令，请参考[表9]。 | | post_start | 否 | Object | **参数解释：** 启动后处理，请参考[表10]。 | | pre_stop | 否 | Object | **参数解释：** 停止前处理，请参考[表10]。 | | mesher | 否 | Object | **参数解释：** 多语言接入服务网格，当技术栈选择Nodejs且绑定微服务引擎CSE时为必选，请参考[表11]。 | | timezone | 否 | String | **参数解释：** 指定组件运行的时区，比如Asia/Shanghai。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | jvm_opts | 否 | String | **参数解释：** jvm参数，例如-Xms256m -Xmx1024m，多个参数以空格间隔，不填则使用默认值。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | tomcat_opts | 否 | Object | **参数解释：** tomcat参数，技术栈选择tomcat时生效，请参考[表12]。 | | host_aliases | 否 | Array of objects | **参数解释：** 主机别名，请参考[表13]。 | | dns_policy | 否 | String | **参数解释：** DNS策略。 **取值范围：** - Default：继承pod所在节点域名解析配置。 - ClusterFirst：追加域名解析配置。 - ClusterFirstWithHostNet：仅对以hostNetWork方式运行的pod生效。 - None：替换域名解析策略。 **默认取值：** 不涉及 | | dns_config | 否 | Object | **参数解释：** DNS配置，请参考[表14]。 | | workload_kind | 否 | String | **参数解释：** 工作负载类型，固定为job，表示普通任务。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | security_context | 否 | Object | **参数解释：** 安全策略，请参考[表16]。 | | logs | 否 | Array of objects | **参数解释：** 日志采集，请参考[表18]。 | | custom_metric | 否 | Object | **参数解释：** 自定义指标监控，请参考[表19]。 | | affinity | 否 | Array of objects | **参数解释：** 亲和性，请参考[表20]。 | | anti_affinity | 否 | Array of objects | **参数解释：** 反亲和性，请参考[表20]。 | | liveness_probe | 否 | Object | **参数解释：** 组件存活探针，请参考[表22]。 | | readiness_probe | 否 | Object | **参数解释：** 组件业务探针，请参考[表22]。 | | startup_probe | 否 | Object | **参数解释：** 组件启动探针，请参考[表22]。 | | refer_resources | 否 | Array of objects | **参数解释：** 关联资源，请参考[表23]。 | | external_accesses | 否 | Array of objects | **参数解释：** 外部访问，请参考[表31]。 | | container_name | 否 | String | **参数解释：** 容器名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | multi_containers | 否 | Array of objects | **参数解释：** 多容器配置，请参考[表33]。 | | workload_content | 否 | String | **参数解释：** 工作负载内容。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | configs | 否 | Array of objects | **参数解释：** 组件统一配置，请参考[表34]。 | | config_mode | 否 | String | **参数解释：** 工作负载配置模式。 **取值范围：** 固定为ui，表示基于UI页面配置部署。 **默认取值：** 不涉及 | | enable_sermant_injection | 否 | Boolean | **参数解释：** 是否开启Sermant。 **取值范围：** - true：开启 - false：不开启 **默认取值：** 不涉及 | | enable_sermant_spring_register | 否 | Boolean | **参数解释：** Spring Cloud Huawei框架的微服务是否需要Sermant帮助注册到注册中心。 **取值范围：** - true：注册 - false：不注册 **默认取值：** 不涉及 | | enable_sermant_dubbo_register | 否 | Boolean | **参数解释：** Dubbo框架的微服务是否需要Sermant帮助注册到注册中心。 **取值范围：** - true：注册 - false：不注册 **默认取值：** 不涉及 | | enable_sermant_config | 否 | Boolean | **参数解释：** 是否开启Sermant动态配置插件能力。 **取值范围：** - true：开启 - false：不开启 **默认取值：** 不涉及 | | 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\ | **参数解释：** 使用压缩包在虚拟机环境下部署组件配置项。 | | image_pull_secrets | 否 | Array of strings | **参数解释：** 镜像拉取密钥列表。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | template_source | 否 | Object | **参数解释：** 组件模板包来源，请参考[表35]。 | | input_values | 否 | Map\ | **参数解释：** 模板包输入信息。 | | auto_lts_config | 否 | Object | **参数解释：** LTS自动配置，请参考[表32]。 | | task_setting | 否 | Object | **参数解释：** job类型工作负载的任务设置，请参考[表38]。 | | vmapp_config_mode | 否 | String | **参数解释：** 虚拟机部署方式部署组件的目录类型。 **取值范围：** - system：内置系统级配置。 - custom_system：自定义系统级配置。 **默认取值：** 不涉及 | | vmapp_config | 否 | Object | **参数解释：** 虚拟机部署方式部署组件的目录配置，请参考[表39]。 | 表4labels | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 标签名称。 **取值范围：** 1到36个字符，只能包含数字、英文字母、下划线（_）、中划线（-）或中文。 说明： Key的取值不能是系统内置的app、casid或version，否则会导致创建并部署组件时报错。 **默认取值：** 不涉及 | | value | 是 | String | **参数解释：** 标签值。 **取值范围：** 0到43个字符，只能包含数字、英文字母、下划线（_）、点（.）、中划线（-）或中文。 **默认取值：** 不涉及 | 表5storages | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 数据存储类型。 **取值范围：** - HostPath：本地磁盘主机路径挂载。 - EmptyDir：本地磁盘临时路径挂载。 - ConfigMap：本地磁盘配置项挂载。 - Secret：本地磁盘密钥挂载。 - PersistentVolumeClaim：云存储挂载。 **默认取值：** 不涉及 | | name | 是 | String | **参数解释：** 存储盘名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | parameters | 是 | Object | **参数解释：** 对应各种数据存储类型的信息参数，请参考[表6]。 | | mounts | 是 | Array of objects | **参数解释：** 数据存储挂载路径，请参考[表7]。 | 表6component_storage_parameters | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | path | 否 | String | **参数解释：** 主机路径， 适用于HostPath的存储类型。当数据存储类型为HostPath时为必选参数。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | name | 否 | String | **参数解释：** 配置项、密钥或者PVC的名字， 适用于ConfigMap、Secret和PersistentVolumeClaim的存储类型。当数据存储类型为ConfigMap、Secret和PersistentVolumeClaim时为必选参数。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | default_mode | 否 | Integer | **参数解释：** 挂载的权限，十进制格式，例如：384。适用于ConfigMap和Secret的存储类型。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | medium | 否 | String | **参数解释：** 适用于EmptyDir类型的存储。 **取值范围：** - 不传参数为默认的磁盘介质 - 传参为memory则开启内存存储 **默认取值：** 不涉及 | 表7mounts | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | path | 是 | String | **参数解释：** 挂载路径，数据存储挂载到应用上的路径。例如，/tmp。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sub_path | 是 | String | **参数解释：** 挂载路径的子路径。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | read_only | 是 | Boolean | **参数解释：** 是否只读。 **取值范围：** - true：只读，只能读应用路径中的数据存储。 - false：读写，可修改应用路径中的数据存储，应用迁移时新写入的数据不会随之迁移，会造成数据丢失。 **默认取值：** 不涉及 | 表8deploy_strategy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 部署类型。 **取值范围：** OneBatchRelease：单批部署。 **默认取值：** 不涉及 | 表9command | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | command | 否 | Array of strings | **参数解释：** 运行命令，控制容器运行的输入命令。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | args | 否 | Array of strings | **参数解释：** 运行参数，控制容器运行命令的输入参数。例如：-port=8080，多条参数以换行分隔。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表10component_lifecycle | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 处理方式。 **取值范围：** - http：http请求方式。 - command：命令行方式。 **默认取值：** 不涉及 | | scheme | 否 | String | **参数解释：** http请求类型。 type为http类型时生效。 **取值范围：** - HTTP - HTTPS **默认取值：** 不涉及 | | host | 否 | String | **参数解释：** 指定自定义的IP。 type为http类型时生效。 **取值范围：** 不涉及 **默认取值：** 默认为POD的IP。 | | port | 否 | Integer | **参数解释：** 端口号，type为http类型时生效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | path | 否 | String | **参数解释：** 请求路径，type为http类型时生效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | command | 否 | Array of strings | **参数解释：** 命令列表，type为command类型时生效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表11mesher | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | port | 是 | Integer | **参数解释：** 进程侦听端口。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表12tomcat_opt | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | server_xml | 是 | String | **参数解释：** 1. 侦听端口以server.xml配置的为准，如果之前在公网访问配置了侦听端口，请保持一致。 2. 自定义的Tomcat配置可能存在端口冲突，请检查自定义的端口是否被占用。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表13host_aliases | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ip | 是 | String | **参数解释：** IP地址。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | hostnames | 是 | Array of strings | **参数解释：** 主机别名。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表14dns_config | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | nameservers | 否 | Array of strings | **参数解释：** Pod的DNS服务器的IP地址列表。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | searches | 否 | Array of strings | **参数解释：** 可选，用于在Pod中查找主机名的DNS搜索域的列表。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | options | 否 | Array of objects | **参数解释：** 可选的对象列表，其中每个对象可能具有name属性（必需）和value属性（可选）。 此属性中的内容将合并到从指定的DNS策略生成的选项。 重复的条目将被删除。请参考[表15]。 | 表15options | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释：** 操作名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | value | 否 | String | **参数解释：** 操作值。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表16security_context | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | run_as_user | 否 | Integer | **参数解释：** 运行用户，容器以当前用户权限运行，如以root权限运行则填写root用户ID：0。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | run_as_group | 否 | Integer | **参数解释：** 运行属组，指定所有容器中的进程都以属组运行。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | capabilities | 否 | Object | **参数解释：** 能力集，请参考[表17]。 | 表17capabilities | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | add | 否 | Array of strings | **参数解释：** 为运行用户添加Linux权限。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | drop | 否 | Array of strings | **参数解释：** 移除运行用户Linux权限。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表18logs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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的名称和容器名称扩展主机路径。 **默认取值：** 不涉及 | 表19custom_metric | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | path | 是 | String | **参数解释：** 采集路径，例如：/metrics。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | port | 是 | Integer | **参数解释：** 采集端口，例如：9090。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | dimensions | 是 | String | **参数解释：** 监控维度，例如："cpu_usage,mem_usage"。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表20component_affinity | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | kind | 否 | String | **参数解释：** 对象类型。 **取值范围：** - node：节点。 - pod：工作负载。 **默认取值：** 不涉及 | | condition | 否 | String | **参数解释：** 策略满足类型。 **取值范围：** - required：必须满足。 - preferred：尽量满足。 **默认取值：** 不涉及 | | match_expressions | 否 | Array of objects | **参数解释：** 调度策略规则，请参考[表21]。 | | weight | 否 | String | **参数解释：** 权重。 **取值范围：** - "condition"选择"required"时，固定为100。 - "condition"选择"preferred"时，可输入1到100之间的整数。 **默认取值：** 不涉及 | | topology_key | 否 | String | **参数解释：** 拓扑域。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表21match_expressions | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 匹配标签key值。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | operation | 是 | String | **参数解释：** 匹配条件。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | value | 是 | String | **参数解释：** 匹配标签value值。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表22component_probe | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 类型。 **取值范围：** - http：HTTP请求检查 - tcp：TCP端口检查 - command：执行命令检查 **默认取值：** 不涉及 | | delay | 是 | Integer | **参数解释：** 启动后多久开始探测。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | timeout | 是 | Integer | **参数解释：** 探测超时时间。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | scheme | 否 | String | **参数解释：** 请求类型。type为http类型时生效。 **取值范围：** - HTTP - HTTPS **默认取值：** 不涉及 | | host | 否 | String | **参数解释：** 指定自定义的IP。type为http类型时生效。 **取值范围：** 不涉及 **默认取值：** 默认为POD的IP。 | | port | 否 | Integer | **参数解释：** 端口号，type为http和tcp类型时生效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | path | 否 | String | **参数解释：** 请求路径，type为http类型时生效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | command | 否 | Array of strings | **参数解释：** 命令列表，type为command类型时生效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表23refer_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 | **参数解释：** 资源参数，当资源类型为cce时必选，请参考[表24]。 | 表24refer_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：标准存储，拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 - WARM：低频访问存储，适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 - COLD：归档存储，适用于很少访问（平均一年访问一次）数据的业务场景。 **默认取值：** 默认为STANDARD标准存储类型。 | | access_mode | 否 | String | **参数解释：** 存储卷访问模式。 **取值范围：** - ReadWriteOnce：卷可以被一个节点以读写方式挂载。 - ReadWriteMany：卷可以被多个节点以读写方式挂载。 **默认取值：** 不涉及 | | availableZone | 否 | String | **参数解释：** 可用区。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | volume_type | 否 | String | **参数解释：** 存储卷类型。 **取值范围：** - SATA：普通IO，是指由SATA存储提供资源的磁盘类型。 - SAS：高IO，是指由SAS存储提供资源的磁盘类型。 - SSD：超高IO，是指由SSD存储提供资源的磁盘类型。 **默认取值：** 不涉及 | 表25envs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释：** 变量名。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | value | 否 | String | **参数解释：** 变量值。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | value_from | 否 | Object | **参数解释：** 变量引用，请参考[表26]。 | 表26value_from | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | reference_type | 是 | String | **参数解释：** 引用类型。 **取值范围：** - configMapKey：配置项导入。 - secretKey：密钥导入。 **默认取值：** 不涉及 | | name | 是 | String | **参数解释：** 配置项或密钥的名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | key | 否 | String | **参数解释：** 配置项或密钥的键值。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | optional | 否 | Boolean | **参数解释：** 配置项或密钥的key是否必须存在。 **取值范围：** - true：必须存在 - false：非必须存在 **默认取值：** 不涉及 | 表27runtime_stack | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释：** 技术栈名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | type | 是 | String | **参数解释：** 技术栈类型。 **取值范围：** - 部署模式为虚机部署时，支持Java、Tomcat、Nodejs。 - 部署模式为容器部署时，支持Java、Tomcat、Nodejs、Php、Docker、Python。 **默认取值：** 不涉及 | | version | 是 | String | **参数解释：** 技术栈版本。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | deploy_mode | 是 | String | **参数解释：** 部署模式。 **取值范围：** - container：容器部署。 - virtualmachine：虚机部署。 **默认取值：** 不涉及 | 表28source | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | kind | 是 | String | **参数解释：** 组件来源类型。 **取值范围：** - code：源码。 - package：软件包。 - image：镜像包。 **默认取值：** 不涉及 | | version | 否 | String | **参数解释：** 版本号。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | url | 否 | String | **参数解释：** 包地址，类型为package和image时需要添加。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | storage | 否 | String | **参数解释：** 存储方式。组件来源包类型为package和image时需要添加。 **取值范围：** - devcloud：CodeArts软件发布库。 - obs：OBS对象存储。 - http：自定义文件地址。 - swr：镜像仓库。 **默认取值：** 不涉及 | | http_username | 否 | String | **参数解释：** 在"storage"为"http"时需要填写，支持用户名、密码认证，这里填写用户名。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | http_password | 否 | String | **参数解释：** 在"storage"为"http"时需要填写，支持用户名、密码认证，这里填写密码。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | http_command | 否 | String | **参数解释：** 在"storage"为"http"时需要填写，这里是用户定义软件包的地址。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | http_headers | 否 | Map\ | **参数解释：** 在"storage"为"http"时需要填写，支持用户自定义请求头，支持填写一个key，value，例如{"key":"xx","value":"xx""}，其中的key和value关键字固定。 | | auth | 否 | String | **参数解释：** 认证方式。 **取值范围：** - iam：IAM认证 - none：无认证 **默认取值：** iam | | repo_auth | 否 | String | **参数解释：** 授权名称，在授权列表获取，请参考[获取仓库授权列表 - ObtainGitRepositoryAuthorizationList](https://support.huaweicloud.com/api-servicestage/servicestage_06_0092.html)。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 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个字符，以小写字母或数字开头。 **默认取值：** 不涉及 | 表29build | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | parameters | 否 | Object | **参数解释：** 只在没有ID，新创建构建时提供。请参考[表30]。 | 表30parameters | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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\ | **参数解释：** key是标签的键，value是标签的值。 | | environment_id | 否 | String | **参数解释：** 环境ID。获取方法，请参考[获取所有环境 - ObtainAllEnvironments](https://support.huaweicloud.com/api-servicestage/servicestage_06_0057.html)。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表31external_accesses | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | protocol | 否 | String | **参数解释：** 外部访问类型。 **取值范围：** - http：超文本传输协议 - https：超文本传输安全协议 **默认取值：** 不涉及 | | address | 否 | String | **参数解释：** 外部访问地址。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | forward_port | 否 | Integer | **参数解释：** 外部访问端口。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表32auto_lts_config | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enable | 是 | Boolean | **参数解释：** 是否开启LTS自动配置。 **取值范围：** - true：开启 - false：不开启 **默认取值：** 不涉及 | | lts_log_path | 否 | Array of strings | **参数解释：** 接入配置日志路径。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表33multi_containers | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | container_name | 是 | String | **参数解释：** 容器名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | source | 是 | Object | **参数解释：** 代码/软件包来源，请参考[表28]，多容器模式下仅支持镜像。 | | limit_cpu | 否 | Number | **参数解释：** 最大CPU限制，单位为Core。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | limit_memory | 否 | Number | **参数解释：** 最大内存限制，单位为GiB。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | request_cpu | 否 | Number | **参数解释：** 申请CPU资源，单位为Core。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | request_memory | 否 | Number | **参数解释：** 申请内存资源，单位为GiB。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | envs | 否 | Array of objects | **参数解释：** 环境变量列表，请参考[表25]。 | | liveness_probe | 否 | Object | **参数解释：** 容器存活探针，请参考[表22]。 | | readiness_probe | 否 | Object | **参数解释：** 容器业务探针，请参考[表22]。 | | startup_probe | 否 | Object | **参数解释：** 容器启动探针，请参考[表22]。 | | command | 否 | Object | **参数解释：** 启动命令，请参考[表9]。 | | post_start | 否 | Object | **参数解释：** 启动后处理，请参考[表10]。 | | pre_stop | 否 | Object | **参数解释：** 停止前处理，请参考[表10]。 | | logs | 否 | Array of objects | **参数解释：** 日志采集，请参考[表18]。 | | storages | 否 | Array of objects | **参数解释：** 存储，请参考[表5]。 | | security_context | 否 | Object | **参数解释：** 安全策略，请参考[表16]。 | 表34configs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | config_id | 是 | String | **参数解释：** 统一配置ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | mount_path | 是 | String | **参数解释：** 挂载路径。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表35template_source | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | storage | 是 | String | **参数解释：** 组件模板包存储方式。 **取值范围：** - devcloud，CodeArts软件发布库。 - obs，OBS对象存储。 - http，自定义文件地址。 - devcloud_repository，CodeArts私有依赖库。 **默认取值：** 不涉及 | | url | 是 | String | **参数解释：** 组件模板包地址。 组件模板包存储方式为自定义文件地址时有效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | http_username | 否 | String | **参数解释：** 用户名。 组件模板包存储方式为自定义文件地址且安全认证方式为用户名密码认证时有效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | http_password | 否 | String | **参数解释：** 密码。 组件模板包存储方式为自定义文件地址且安全认证方式为用户名密码认证时有效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | http_headers | 否 | Array of objects | **参数解释：** 请求头，请参考[表36]。 组件模板包存储方式为自定义文件地址且安全认证方式为自定义Header认证时有效。 | 表36http_headers | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 请求key。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | value | 是 | String | **参数解释：** 请求value。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表37config_encryption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key_id | 是 | String | **参数解释：** DEW服务中用户密钥ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表38task_setting | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | parallelism | 是 | Integer | **参数解释：** 并行数。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | active_deadline_seconds | 否 | Integer | **参数解释：** 超时时间（秒）。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | completion_mode | 是 | String | **参数解释：** 完成模式。 **取值范围：** - NonIndexed：非索引模式 - Indexed：索引模式 **默认取值：** 不涉及 | | suspend | 是 | Boolean | **参数解释：** 是否挂起任务。 选择挂起任务后，任务创建后处于挂起状态；将其关闭后，任务继续执行。 **取值范围：** - true：挂起任务 - false：不挂起任务 **默认取值：** false，默认任务创建后被立即执行。 | 表39vmapp_config | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | run_as_user | 是 | String | **参数解释：** 运行用户。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | app_home | 是 | Object | **参数解释：** 部署目录配置，请参考[表40]。 | | log_home | 是 | Object | **参数解释：** 日志目录配置，请参考[表40]。 | 表40log_config | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | path | 是 | String | **参数解释：** 目录配置路径。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | user | 是 | String | **参数解释：** 目录配置路径所属用户。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | group | 是 | String | **参数解释：** 目录配置路径所属用户组。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | mode | 是 | String | **参数解释：** 目录配置路径权限。 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应消息 表41响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及 | #### 请求示例 重新部署名为mycomponent的普通任务类型组件，修改组件任务设置。 ``` { "name": "mycomponent", "description": "", "labels": [ { "key": "com-key", "value": "com-value" } ], "version": "2025.0323.15181", "runtime_stack": { "name": "OpenJDK8", "version": "1.1.1", "type": "Java", "deploy_mode": "virtualmachine" }, "source": { "kind": "package", "url": "obs://bucket0001/weather-1.0.0.jar", "version": "", "storage": "obs" }, "tomcat_opts": { "server_xml": "" }, "refer_resources": [ { "id": "67835bb3-1235-4cc9-be71-becbb2b4ca0d", "type": "ecs" } ], "task_setting": { "parallelism": 1, "active_deadline_seconds": null, "completion_mode": "Indexed", "suspend": false }, "replica": 1, "external_accesses": [] } ``` #### 响应示例 ``` { "job_id": "JOB1c8e20ec-1b30-4ee4-9a36-35a18b5e8b7e" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功。 | | 400 | 错误的请求。 | | 404 | 请求对象不存在。 | | 500 | 内部错误。 | #### 错误码 错误码说明请参考[ServiceStage错误码](https://support.huaweicloud.com/api-servicestage/servicestage_06_0162.html)。