Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Application/ Performing Operations on Components Based on the Application ID
Updated on 2026-04-10 GMT+08:00

Performing Operations on Components Based on the Application ID

Function

This API is used to perform operations on components based on the application ID.

Authorization Information

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

URI

POST /v3/{project_id}/cas/applications/{application_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

Request

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

Operation type of the batch operation component.

Range

  • start
  • stop
  • restart

Default Value

N/A

parameters

Yes

Object

Definition

Action configuration. See Table 4.

Table 4 parameters

Parameter

Mandatory

Type

Description

components

Yes

Array of objects

Definition

Component list. See Table 5.

Table 5 components

Parameter

Mandatory

Type

Description

id

Yes

String

Definition

Component ID.

Range

N/A

Default Value

N/A

Response

None

Example Request

None

Example Response

None

Status Code

Status Code

Description

204

OK

400

Bad Request

404

Not Found

409

Conflict

500

Internal Server Error

Error Code

See ServiceStage Error Codes.