Updated on 2026-04-10 GMT+08:00

Delivering a Component Task Based on the Component ID

This API is used to deliver a component task based on the component ID.

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:app:modifyComponent	write	app *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	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

POST /v3/{project_id}/cas/applications/{application_id}/components/{component_id}/action

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Tenant's project ID. See Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
application_id	Yes	String	Definition Application ID. See Obtaining All Applications. Constraints N/A Range N/A Default Value N/A
component_id	Yes	String	Definition Component ID. See Obtaining All Components of an Application. Constraints N/A Range N/A Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition Message body type (or format). Constraints N/A Range application/json;charset=utf8 Default Value N/A
X-Auth-Token	Yes	String	Definition 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. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Definition Component task type. Range start stop restart scale rollback rollback_current: roll back to the previous version. continue_deploy check_gray_release modify_gray_rule sync_workload sync_import: Compare workload information before and after workload import. abort_job: Abort a component deployment or upgrade task. redeployment Default Value N/A
parameters	No	Object	Definition Task parameters. See Table 4.

**Table 4** parameters
Parameter	Mandatory	Type	Description
replica	No	Integer	Definition Number of component instances. Range N/A Default Value N/A
version	No	String	Definition Version number. Range N/A Default Value N/A
hosts	No	Array of strings	Definition Host ID list, which is mandatory when component scaling is deployed on a VM. Range N/A Default Value N/A

**Table 5** Response parameters
Parameter	Type	Description
job_id	String	Definition Task ID. Range N/A
component_id	String	Definition Component ID. Range N/A

Start a component.

{
  "action": "start",
  "parameters": {
    "replica": 0,
    "hosts": [
      "string"
    ],
    "version": "string"
  }
}

{
    "job_id": "JOBa6346016-b97d-4311-9e4c-9a40bd39ead8",
    "component_id": "29e7ea25-ce11-4cf9-9a04-3226fb26d60e"
}

Parent topic: Component