Help Center/ Data Warehouse Service/ API Reference/ API Description/ Upgrade Management/ Querying Cluster Upgrade Records
Updated on 2026-10-21 GMT+08:00
View PDF

Querying Cluster Upgrade Records

Function

This API is used to query the upgrade records of a cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/clusters/{cluster_id}/upgrade-management/records

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
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Page offset, which starts from 0 (page number minus 1).

Constraints

N/A

Range

Greater than or equal to 0

Default Value

0

limit

No

Integer

Definition

Size of a single page.

Constraints

N/A

Range

Greater than 0

Default Value

10

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

Definition

Total number of cluster upgrade records.

Range

N/A

records

Array of ClusterUpdateRecordResp objects

Definition

List of cluster upgrade records.

Range

N/A
Table 4 ClusterUpdateRecordResp

Parameter

Type

Description

item_id

String

Definition

Upgrade project ID.

Range

N/A

status

String

Definition

Upgrade status.

Range

  • Waiting: The upgrade is to be performed.

  • Update_Running: The upgrade is in progress.

  • Update_Success: The upgrade is successful.

  • Update_Failure: The upgrade fails.

  • Rollback_Running: The rollback is in progress.

  • Rollback_Failure: The rollback fails.

  • Commit_Running: The task is being committed.

  • Commit_Failure: The task fails to be committed.

  • Completed: The upgrade is complete.

  • Disable: Upgrade is not supported.

  • Install_Running: The hot patch is being installed.

  • Uninstall_Failure: The hot patch fails to be uninstalled.

  • Commit_HotPatch_Failure: The hot patch fails to be committed.

  • UpdateCompleted_Success: The upgrade is complete.

record_type

String

Definition

Upgrade type.

Range

N/A

from_version

String

Definition

Source version.

Range

N/A

to_version

String

Definition

Target version.

Range

N/A

start_time

String

Definition

Start time.

Range

N/A

end_time

String

Definition

End time.

Range

N/A

job_id

String

Definition

Upgrade task ID.

Range

N/A

failed_reason

String

Definition

Failure cause.

Range

N/A

Example Requests

Query cluster upgrade records.

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

Example Responses

Status code: 200

{
  "records" : [ {
    "item_id" : "930d2820-fc17-4a42-9a50-eb695bf05e83",
    "status" : "UpdateCompleted_Success",
    "record_type" : "update-cluster",
    "from_version" : "8.2.0",
    "to_version" : "8.2.0.100",
    "start_time" : "2023-08-04T06:46:46",
    "end_time" : "2023-08-04T06:54:59",
    "job_id" : "2c90804789bf441e0189bf4c78fd0001",
    "failed_reason" : null
  } ],
  "count" : 1
}

Status Codes

Status Code

Description

200

Query succeeded.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

500

Internal server error.

503

Service unavailable.
Parent Topic: Upgrade Management