Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Component/ Delivering a Component Task Based on the Component ID
Updated on 2024-10-16 GMT+08:00

Delivering a Component Task Based on the Component ID

Function

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

URI

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.

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 a token, see Obtaining a User Token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Component task type.

  • start
  • stop
  • restart
  • scale
  • rollback
  • continue_deploy
  • check_gray_release
  • modify_gray_rule

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.

Response

Table 5 Response parameters

Parameter

Type

Description

job_id

String

Job ID.

result

String

Task status.

Example Request

Start a component.

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

Example Response

{
  "job_id": "string",
  "result": "succeeded"
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

The error code format is SVCSTG.00100.[Error_ID], for example, SVCSTG.00100400. For details, see ServiceStage Error Codes.