Updated on 2025-09-19 GMT+08:00

Delivering Cluster Upgrade Operations

Function

This API is used to deliver cluster upgrade operations.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/clusters/{cluster_id}/upgrade-management/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Definition

Operation to be performed on the current cluster.

Range

N/A

item_id

Yes

String

Definition

Upgrade item ID.

Range

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Cluster upgrade task ID.

Range

N/A

Example Requests

GET https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/c719b1a7-c85c-4cb5-a721-7694908c2c11/upgrade-management/action

{
  "item_id" : "xx",
  "action" : "update"
}

Example Responses

Status code: 200

Request submitted.

{
  "job_id" : "2c90807d89a6f9540189a9bef01f042b"
}

Status Codes

Status Code

Description

200

Request submitted.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

500

Internal server error.

503

Service unavailable.