Help Center> ServiceStage> API Reference> Application Management V2 APIs> Instance> Querying the Operations Performed on a Component Instance
Updated on 2023-07-19 GMT+08:00

Querying the Operations Performed on a Component Instance

Function

This API is used to query the operations performed on a component instance.

URI

POST /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances/{instance_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.

instance_id

Yes

String

Component instance ID. See Obtaining All Component Instances.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type or format.

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

Operation. Value: start, stop, restart, scale, or rollback.

  • start
  • stop
  • restart
  • scale
  • rollback

parameters

No

Object

Operation parameter, which is mandatory when action is set to scale or rollback. See Table 4.

Table 4 parameters description

Parameter

Mandatory

Type

Description

replica

No

Integer

Number of instances, which is mandatory when action is set to scale.

hosts

No

Array

ECS ID list. This parameter specifies the ECS deployed during VM scaling, and is mandatory for scaling.

version

No

String

Version number, which is mandatory when action is set to rollback. You can obtain the version number by using the API in Obtaining Component Instance Snapshots.

Response

Table 5 Response parameters

Parameter

Type

Description

job_id

String

Job ID.

Example Request

Scale component instances and change the number of component instances to 4.

{
  "action": "scale",
  "parameters": {
    "replica": 4
  }
}

Example Response

{
    "job_id": "JOB66761060-f209-407c-a093-4df6f531b9dc"
}

Status Code

Table 6 Status codes

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