Skip to main content

GetUpgradeStatus

Description

call GetUpgradeStatus to query cluster upgrade status.

Request Method

POST

Request Path

/apsara/route/CS/GetUpgradeStatus

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
ClusterIdBODYstringYesc106f377e16f34eb1808d6b9362c9****cluster ID.
regionIdBODYstringYesNo sample value for this parameter.region id
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
error_messagestringsubject to actual returnerror message in cluster upgrade.
upgrade_taskobject{"message":"subject to actual return","status":"running "}upgrade task details.
precheck_report_idstringbe4c8eb72de94d459ea7ace7c811d119pre-check return ID.
messagestringsubject to actual returnupgrade task description information.
statusstringrunningupgrade task status.
upgrade_stepstringprecheckingthe current upgrade phase of the cluster.

Example

Successful Response example

{
"error_message":"subject to actual return",
"upgrade_task":
{
"message":"subject to actual return",
"status":"running "
},
"precheck_report_id":"be4c8eb72de94d459ea7ace7c811d119",
"message":"subject to actual return",
"status":"running",
"upgrade_step":"prechecking"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}