Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Component/ Redeploying a Job Component

Updated on 2025-09-25 GMT+08:00

View PDF

Redeploying a Job Component

Function

This API is used to redeploy a job component that has been executed or failed.

URI

PUT /v3/{project_id}/cas/applications/{application_id}/components/{component_id}/redeployment

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID. See Obtaining a Project ID.
application_id	Yes	String	Application ID. See Obtaining All Applications.
component_id	Yes	String	Component ID. See Obtaining All Components of an Application.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default value: application/json;charset=utf8.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Application component name. This value cannot be modified. The value contains 2 to 64 characters consisting of letters, digits, hyphens (-), and underscores (_). It starts with a letter and ends with a letter or digit.
labels	No	Array of objects	Label. For container-deployed components, you can query a workload by label. For VM-deployed components, you can configure a label of the corresponding microservice name to use graceful startup and shutdown. See Table 4.
runtime_stack	Yes	Object	Runtime. This value cannot be modified. See Table 28. The value can be obtained from the response of the API for Querying a Technology Stack.
description	No	String	Description. Enter up to 128 characters.
source	Yes	Object	Source of the code or software package. See Table 29.
build	No	Object	Component build. See Table 30.
limit_cpu	No	Number	Maximum CPU limit. Unit: core.
limit_memory	No	Number	Maximum memory size. Unit: GiB.
request_cpu	No	Number	Requested CPU resources. Unit: core.
request_memory	No	Number	Requested memory. Unit: GiB.
version	Yes	String	Component version number. The value can contain up to 32 characters. It needs to meet the following rule: ^([0-9]+)(.[0-9]+){2,3}$
envs	No	Array of objects	Environment variable list. See Table 26.
replica	Yes	Integer	Number of instances. This parameter can be modified only when the scaling function is used.
storages	No	Array of objects	Storage. See Table 5.
deploy_strategy	No	Object	Component deployment. See Table 8.
command	No	Object	Startup command. See Table 10.
post_start	No	Object	Post-start processing. See Table 11.
pre_stop	No	Object	Pre-stop processing. See Table 11.
mesher	No	Object	Multi-language access service mesh. This parameter is mandatory when Node.js is selected for the technology stack and the CSE engine is bound. See Table 12.
timezone	No	String	Time zone where the component runs. Example: Asia/Shanghai.
jvm_opts	No	String	JVM parameter. Example: -Xms256m -Xmx1024m. If there are multiple parameters, separate them by spaces. If the parameter is left blank, the default value is used.
tomcat_opts	No	Object	Tomcat parameter. This parameter is valid when you use the Tomcat technology stack. See Table 13.
host_aliases	No	Array of objects	Host alias. See Table 14.
dns_policy	No	String	DNS policy. Default: inherits the domain name resolution configuration of the node where the pod is located. ClusterFirst: adds the domain name resolution configuration. ClusterFirstWithHostNet: takes effect only for pods running in hostNetWork mode. None: replaces the domain name resolution policy.
dns_config	No	Object	DNS configuration. See Table 15.
workload_kind	No	String	Workload type. The value is fixed at job.
security_context	No	Object	Security policy. See Table 17.
logs	No	Array of objects	Log collection. See Table 19.
custom_metric	No	Object	Custom metrics. See Table 20.
affinity	No	Array of objects	Affinity. See Table 21.
anti_affinity	No	Array of objects	Anti-affinity. See Table 21.
liveness_probe	No	Object	Component liveness probe. See Table 23.
readiness_probe	No	Object	Component service probe. See Table 23.
startup_probe	No	Object	Component startup probe. See Table 23.
refer_resources	No	Array of objects	Associated resource. See Table 24.
external_accesses	No	Array of objects	External access. See Table 32.
container_name	No	String	Container name.
multi_containers	No	Array of Objects	Multi-container configuration. See Table 34.
workload_content	No	String	Workload content.
configs	No	Array of Objects	Unified component configuration. See Table 35.
config_mode	No	String	Workload configuration mode. The value is fixed at ui, indicating that the deployment is configured based on the UI.
enable_sermant_injection	No	Boolean	Whether to enable Sermant.
enable_sermant_spring_register	No	Boolean	Whether Spring Cloud Huawei microservices need to be registered with registry centers through Sermant.
enable_sermant_dubbo_register	No	Boolean	Whether Dubbo microservices need to be registered with registry centers through Sermant.
enable_sermant_config	No	Boolean	Whether to enable the Sermant dynamic configuration plug-in.
cell_id	No	String	Deployment cell ID.
swimlane_id	No	String	Lane ID.
sermantAgentInjectActionFlag	No	Boolean	Whether JDK 17 and JDK 21 automatically add the following JVM environment variables: JDK 17: --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 JDK 21: --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	No	Map<String, String>	Uses a compressed package to deploy component configuration items in the VM environment.
image_pull_secrets	No	Array of String	List of image pull secrets.
template_source	No	Object	Source of the component template package. See Table 36.
input_values	No	Map<String, String>	Template package input information.
auto_lts_config	No	Object	Automatic LTS configuration. See Table 33.
task_setting	No	Object	Task settings for a job workload. See Table 39.
vmapp_config_mode	No	String	Directory type of a VM-deployed component. system: built-in system configuration custom_system: custom system configuration
vmapp_config	No	Object	Directory configuration of a VM-deployed component. See Table 40.

**Table 4** labels
Parameter	Mandatory	Type	Description
key	Yes	String	Label name.
value	Yes	String	Label value.

**Table 5** storages
Parameter	Mandatory	Type	Description
type	Yes	String	Data storage type. HostPath: host path for local disk mounting. EmptyDir: temporary directory for local disk mounting. ConfigMap: configuration item for local disk mounting. Secret: secret for local disk mounting. PersistentVolumeClaim: cloud storage mounting.
name	Yes	String	Name of the storage disk.
parameters	Yes	Object	For details about the parameters of each data storage type, see Table 6.
mounts	Yes	Array of objects	Mount path of data storage. See Table 7.

**Table 6** component_storage_parameters
Parameter	Mandatory	Type	Description
path	No	String	Host path. This parameter is applicable to the HostPath storage type. This parameter is mandatory when type is set to HostPath.
name	No	String	Name of a configuration item, secret, or PVC, which is applicable to ConfigMap, Secret, or PersistentVolumeClaim storage, respectively. This parameter is mandatory when type is set to ConfigMap, Secret, or PersistentVolumeClaim.
default_mode	No	Integer	Mounting permission. The value is in decimal format. Example: 384. This parameter is applicable to ConfigMap and secret storage.
medium	No	String	This parameter is applicable to EmptyDir storage. If it is not specified, the default disk medium is used. If it is set to memory, memory storage is enabled.

**Table 7** mounts
Parameter	Mandatory	Type	Description
path	Yes	String	Mount path.
sub_path	Yes	String	Subpath of the mount path.
read_only	Yes	Boolean	Read only or not.

**Table 8** deploy_strategy
Parameter	Mandatory	Type	Description
type	Yes	String	Deployment type. OneBatchRelease

**Table 9** rolling_release
Parameter	Mandatory	Type	Description
batches	Yes	Integer	Deployment batches.

**Table 10** command
Parameter	Mandatory	Type	Description
command	No	Array of String	Command for controlling container running.
args	No	Array of String	Parameter for controlling container running. Example: -port=8080. If there are multiple parameters, separate them by line breaks.

**Table 11** component_lifecycle
Parameter	Mandatory	Type	Description
type	Yes	String	Processing method. http command
scheme	No	String	HTTP request type. Value: HTTP or HTTPS. This parameter is valid only when type is set to http.
host	No	String	Custom IP address. If this parameter is left blank, the pod IP address is used. This parameter is valid only when type is set to http.
port	No	Integer	Port. This parameter is valid only when type is set to http.
path	No	String	Request path. This parameter is valid only when type is set to http.
command	No	Array of String	Command list. This parameter is valid only when type is set to command.

**Table 12** mesher
Parameter	Mandatory	Type	Description
port	Yes	Integer	Process listening port.

**Table 13** tomcat_opt
Parameter	Mandatory	Type	Description
server_xml	Yes	String	Listening port in the server.xml file will take effect even if it has been configured in public network access. The custom Tomcat configuration may conflict with the existing port. Check whether the custom port is occupied.

**Table 14** host_aliases
Parameter	Mandatory	Type	Description
ip	Yes	String	IP address.
hostnames	Yes	Array of String	Host alias.

**Table 15** dns_config
Parameter	Mandatory	Type	Description
nameservers	No	Array of String	IP address list of the DNS server of the pod.
searches	No	Array of String	(Optional) List of DNS search domains used to search for host names in the pod.
options	No	Array of objects	(Optional) List of objects. Each object may have a name (mandatory) and a value (optional). This property is merged into the options generated from the specified DNS policy. Duplicate entries will be deleted. See Table 16.

**Table 16** options
Parameter	Mandatory	Type	Description
name	Yes	String	Operation name.
value	No	String	Operation value.

**Table 17** security_context
Parameter	Mandatory	Type	Description
run_as_user	No	Integer	User for running containers. Example: To run containers as user root, set the user ID to 0.
run_as_group	No	Integer	Owner group specified for running container processes.
capabilities	No	Object	Capability set. See Table 18.

**Table 18** capabilities
Parameter	Mandatory	Type	Description
add	No	Array of String	Grant the Linux permission to the running user.
drop	No	Array of String	Remove the Linux permission of the running user.

**Table 19** logs
Parameter	Mandatory	Type	Description
log_path	Yes	String	Container log path.
rotate	Yes	String	Interval for dumping logs.
host_path	Yes	String	Mounted host path.
host_extend_path	Yes	String	Host extension path. By extending the host path, you can distinguish mounting from different containers in the same host path. None: The extended path is not used. PodUID: extend the host path based on the pod ID. PodName: extend the host path based on the pod name. PodUID/ContainerName: extend the host path based on the pod ID and container name. PodName/ContainerName: extend the host path based on the pod name and container name.

**Table 20** custom_metric
Parameter	Mandatory	Type	Description
path	Yes	String	Collection path. Example: /metrics.
port	Yes	Integer	Collection port. Example: 9090.
dimensions	Yes	String	Monitoring dimension. Example: cpu_usage,mem_usage.

**Table 21** component_affinity
Parameter	Mandatory	Type	Description
kind	No	String	Object kind. node pod
condition	No	String	Policy type. required: The requirement must be met. preferred: The requirement is met as much as possible.
match_expressions	No	Array of objects	Scheduling policy rule. See Table 22.
weight	No	String	Weight. The value is 100 when condition is set to required. Enter an integer ranging from 1 to 100 when condition is set to preferred.
topology_key	No	String	Topology key.

**Table 22** match_expressions
Parameter	Mandatory	Type	Description
key	Yes	String	Key of the match tag.
operation	Yes	String	Match condition.
value	Yes	String	Value of the match tag.

**Table 23** component_probe
Parameter	Mandatory	Type	Description
type	Yes	String	Type. Value: http, tcp, or command.
delay	Yes	Integer	Interval between the startup and detection.
timeout	Yes	Integer	Detection timeout interval.
scheme	No	String	Request type. Value: HTTP or HTTPS. This parameter is valid only when type is set to http.
host	No	String	Custom IP address. If this parameter is left blank, the pod IP address is used. This parameter is valid only when type is set to http.
port	No	Integer	Port number. This parameter is valid only when type is set to http or tcp.
path	No	String	Request path. This parameter is valid only when type is set to http.
command	No	Array of String	Command list. This parameter is valid only when type is set to command.

**Table 24** refer_resources
Parameter	Mandatory	Type	Description
id	Yes	String	Resource ID.
type	Yes	String	Resource type. vpc eip elb cce ecs as cse: ServiceComb engine. nacos: registry/configuration center. dcs rds gaussdb dms_rocketmq css_es: Elasticsearch custom_k8s: custom Kubernetes cluster
parameters	No	Object	Resource parameter, which is mandatory when type is cce. See Table 25.

**Table 25** refer_resource_parameter
Parameter	Mandatory	Type	Description
namespace	No	String	Namespace.
name	No	String	Resource name.
capacity	No	Integer	Storage capacity, in GB.
type	No	String	Volume declaration type. efs obs sfs evs
class	No	String	Volume declaration subtype. csi-sfsturbo: fixed when type is set to efs. csi-obs: fixed when type is set to obs. csi-nas: fixed when type is set to sfs. csi-disk: fixed when type is set to evs.
obs_volume_type	No	String	OBS volume type. Default value: STANDARD.
access_mode	No	String	Storage volume access mode. ReadWriteOnce: A volume can be mounted as read-write by a single node. ReadWriteMany: A volume can be mounted as read-write by many nodes.
availableZone	No	String	AZ.
volume_type	No	String	Volume type.

**Table 26** envs
Parameter	Mandatory	Type	Description
name	Yes	String	Variable name.
value	No	String	Variable value.
value_from	No	Object	Variable reference. See Table 27.

**Table 27** value_from
Parameter	Mandatory	Type	Description
reference_type	Yes	String	Reference type. configMapKey secretKey
name	Yes	String	Name of the configuration item or secret.
key	No	String	Key of the configuration item or secret.
optional	No	Boolean	Whether the key of the configuration item or secret is mandatory. Value: true and false.

**Table 28** runtime_stack
Parameter	Mandatory	Type	Description
name	Yes	String	Technology stack name.
type	Yes	String	Technology stack type. Value: Java, Tomcat, Nodejs, Php, Docker, or Python. When deploy_mode is set to virtualmachine, only Java, Tomcat, and Node.js are supported. When deploy_mode is set to container, all of the preceding types are supported.
version	Yes	String	Technology stack version.
deploy_mode	Yes	String	Deployment mode. container virtualmachine

**Table 29** source
Parameter	Mandatory	Type	Description
kind	Yes	String	Component source kind. code package image
version	No	String	Version number.
url	No	String	Package address. This parameter is mandatory when kind is set to package or image.
storage	No	String	Storage mode. devcloud: CodeArts release repository obs http: custom file address swr This parameter is mandatory when kind is set to package or image.
auth	No	String	Authentication mode. Value: iam or none. Default value: iam.
repo_auth	No	String	Authorization name, which can be obtained from the authorization list.
repo_namespace	No	String	Namespace of the code repository.
repo_ref	No	String	Code branch or tag. Default value: master.
repo_type	No	String	Code repository type. Value: GitHub, BitBucket, or GitLab.
web_url	No	String	Code redirection URL. Example: https://github.com/example/demo.git.
repo_url	No	String	Code repository URL. Example: https://github.com/example/demo.git.
commit_id	No	String	In the code repository, commit ID is the unique identifier of each commit and is used to identify and reference a commit. The value contains 8 to 40 characters and starts with a lowercase letter or digit.
http_username	No	String	Username. This parameter is mandatory when storage is set to http. Username and password authentication is supported.
http_password	No	String	Password. This parameter is mandatory when storage is set to http. Username and password authentication is supported.
http_command	No	String	Address of the custom software package. This parameter is mandatory when storage is set to http.
http_headers	No	Map<String, String>	This parameter is mandatory when storage is set to http. You can customize request headers as key-value pairs, for example, {"key":"xx","value":"xx""}.

**Table 30** build
Parameter	Mandatory	Type	Description
parameters	No	Map<String, Object>	This parameter is provided only when no ID is available during build creation. See Table 31.

**Table 31** parameters
Parameter	Mandatory	Type	Description
build_cmd	No	String	Compilation command. By default: When build.sh exists in the root directory, the command is ./build.sh. When build.sh does not exist in the root directory, the command varies depending on the OS. Example: Java and Tomcat: mvn clean package Node.js: npm build
dockerfile_path	No	String	Address of the Docker file. By default, the Docker file is in the root directory (./).
artifact_namespace	No	String	Build archive organization. Default value: cas_{project_id}.
cluster_id	Yes	String	ID of the cluster to be built.
node_label_selector	No	Map<String, String>	key: key of the tag. value: value of the tag.
environment_id	No	String	Environment ID.

**Table 32** external_accesses
Parameter	Mandatory	Type	Description
protocol	No	String	External access type. Value: http or https.
address	No	String	External access address.
forward_port	No	Integer	External access port.

**Table 33** auto_lts_config
Parameter	Mandatory	Type	Description
enable	Yes	Boolean	Whether to enable automatic LTS configuration.
lts_log_path	No	Array of String	Access configuration log path.

**Table 34** multi_containers
Parameter	Mandatory	Type	Description
container_name	Yes	String	Container name.
source	Yes	Object	Source of the code or software package. See Table 29. In multi-container mode, only images are supported.
limit_cpu	No	Number	Maximum CPU limit. Unit: core.
limit_memory	No	Number	Maximum memory size. Unit: GiB.
request_cpu	No	Number	Requested CPU resources. Unit: core.
request_memory	No	Number	Requested memory. Unit: GiB.
envs	No	Array of objects	Environment variable list. See Table 26.
liveness_probe	No	Object	Container liveness probe. See Table 23.
readiness_probe	No	Object	Container service probe. See Table 23.
startup_probe	No	Object	Container startup probe. See Table 23.
command	No	Object	Startup command. See Table 10.
post_start	No	Object	Post-start processing. See Table 11.
pre_stop	No	Object	Pre-stop processing. See Table 11.
logs	No	Array of objects	Log collection. See Table 19.
storages	No	Array of objects	Storage. See Table 5.
security_context	No	Object	Security policy. See Table 17.

**Table 35** configs
Parameter	Mandatory	Type	Description
config_id	Yes	String	Unified configuration ID.
mount_path	Yes	String	Mount path.

**Table 36** template_source
Parameter	Mandatory	Type	Description
storage	Yes	String	Storage mode of the component template package. devcloud: CodeArts release repository obs http: custom file address devcloud_repository: CodeArts artifact
url	Yes	String	Address of the component template package. This parameter is valid only when the component template package storage mode is http.
http_username	No	String	Username. This parameter is valid only when the component template package storage mode is http and the security authentication mode is username and password authentication.
http_password	No	String	Password. This parameter is valid only when the component template package storage mode is http and the security authentication mode is username and password authentication.
http_headers	No	Array of objects	Request header. See Table 37. This parameter is valid only when the component template package storage mode is http and the security authentication mode is custom header authentication.

**Table 37** http_headers
Parameter	Mandatory	Type	Description
key	Yes	String	Request key.
value	Yes	String	Request value.

**Table 38** config_encryption
Parameter	Mandatory	Type	Description
key_id	Yes	String	User key ID in DEW.

**Table 39** task_setting
Parameter	Mandatory	Type	Description
parallelism	Yes	Integer	Number of parallel jobs.
active_deadline_seconds	No	Integer	Timeout interval, in seconds.
completion_mode	Yes	String	Completion mode. NonIndexed Indexed
suspend	Yes	Boolean	Whether to suspend a job. By default, a job is executed immediately after being created. The job's execution will be suspended if you enable this option, and resumed after you disable it.

**Table 40** vmapp_config
Parameter	Mandatory	Type	Description
run_as_user	Yes	String	Running user.
app_home	Yes	Object	Deployment directory settings. See Table 41.
log_home	Yes	Object	Log directory settings. See Table 41.

**Table 41** log_config
Parameter	Mandatory	Type	Description
path	Yes	String	Directory setting path.
user	Yes	String	User to which the directory setting path belongs.
group	Yes	String	User group to which the directory setting path belongs.
mode	Yes	String	Permission on the directory setting path.

Response

**Table 42** Response parameter
Parameter	Type	Description
job_id	String	Task ID.

Example Request

Redeploy a job component named mycomponent and modify its job settings.

{
    "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": []
}

Example Response

{
    "job_id": "JOB1c8e20ec-1b30-4ee4-9a36-35a18b5e8b7e"
}

Status Code

Status Code	Description
200	OK
400	Bad Request
404	Not Found
500	Internal Server Error

Error Code

See ServiceStage Error Codes.

Parent topic: Component

Previous topic: Parsing a Component Template Package

Next topic: Deployment Job

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot