Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Component/ Delivering Component Tasks in Batches Based on the Component ID
Updated on 2025-12-16 GMT+08:00
View PDF
Share

Delivering Component Tasks in Batches Based on the Component ID

Function

This API is used to deliver component tasks in batches based on the component 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.

  • 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

    servicestage:app:modify

    -

URI

POST /v3/{project_id}/cas/components/action

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

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 the token, see Authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Requested action.

  • query
  • sync_workload

components

No

List<Object>

Component information. See Table 6.
Table 4 Component details parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Component ID.

application_id

Yes

String

Application ID.

Response

Table 5 Response parameters

Parameter

Type

Description

laneId

String

Lane ID.

job_id

String

Asynchronous job ID.

components

List<Object>

Component information. See Table 6.
Table 6 Component information parameters

Parameter

Type

Description

id

String

Component ID.

application_id

String

Application ID.

Example Request

{
	"action": "sync_workload",
	"components": [
		{
			"id": "b458a122-f21f-4e45-9815-eb0651849be3",
			"application_id": "84ce8cda-561b-423d-a921-aa79a246ba07"
		}
	]
}

Example Response

{
    "laneId": null,
    "components": null,
    "job_id": "JOB74c8c7d7-f045-41d0-ad7a-7d4274d044e2"
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

See ServiceStage Error Codes.

Parent topic: Component