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	-

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

**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.

**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
action	Yes	String	Component task type. 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
parameters	No	Object	Task parameters. See Table 4.

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

**Table 5** Response parameters
Parameter	Type	Description
job_id	String	Job ID.
component_id	String	Component ID.

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

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.