Queries the upgrade status of an instance.
Try it now
Test
RAM authorization
Request syntax
GET /api/v1/instances/{instanceId}/upgrade/status HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
No |
The instance ID. |
hgprecn-cn-uqm30ptv6004 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
No |
The region ID. |
cn-hangzhou |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The data returned. |
||
| RequestId |
string |
The request ID. |
D73E42D0-AA72-5880-B96F-548B43C84736 |
| Data |
array<object> |
The data returned. |
|
|
object |
|||
| FromVersion |
string |
The version of the instance before the upgrade. |
1.3.23 |
| ToVersion |
string |
The target version of the upgrade. |
1.3.24 |
| Status |
string |
The status of the Airflow directed acyclic graph (DAG) used for the instance upgrade. Valid values:
|
archived |
| Details |
string |
Details about the upgrade process, formatted as a JSON string. |
{"UpgradePhase":"Upgrade","StatusCode":"LeaderRestartFailed","FlightingReport":{"SQLResultStat":{"TotalExecuted":9000"Exceptions":0,"Incorrect":1,"Slow":1,"DQLSpeedup":2}"SegmentFormatStat":[{"Database":"test_db","TableUsingSegmentCount":5},{"Database":"user_order","TableUsingSegmentCount":7}],"EstimatedUpgradeTime":{"StopInstance":30,"BackupData":120,"UpgradeInstance":600},"ReadPermissionCheckStat":[{"db":"tst0","user":"v4_300433463265624129","schema":"dim_db","table":"it_rpt_org_tree_info_partition_all"},{"db":"tst1","user":"v4_300433463265624129","schema":"dim_db","table":"it_rpt_org_tree_info_partition_all_2"},]},"UpgradingSteps":{"Stop":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"},"Backup":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"},"DoUpgrade":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"},"Rollback":{"Status":"Success","StartTime":"2023-05-09T06:48:28.843Z","StopTime":"2023-05-09T06:48:28.843Z"}},"Instances":{"LeaderInstanceId":"hgxxx","LeaderInstanceName":"ERP instance","LeaderInstanceStatus":"Running","FollowerInstances":[{"InstanceId":"hgxxx","InstanceName":"TMSinstance","Status":"Running"},{"InstanceId":"hxxx""InstanceName":"WMS readonly","Status":"Unavailable"}]}} |
| PrepareFinishTime |
string |
The completion time of the preparation phase, in ISO 8601 format: |
2023-05-09T06:48:28.843Z |
| Success |
boolean |
Indicates whether the API call was successful. This parameter does not reflect the status of the upgrade. |
true |
| ErrorCode |
string |
The error code returned if the API call fails. |
404 |
| ErrorMessage |
string |
The error message returned if the API call fails. |
Internal server error. |
| HttpStatusCode |
string |
The HTTP status code. |
200 |
Examples
Success response
JSON format
{
"RequestId": "D73E42D0-AA72-5880-B96F-548B43C84736",
"Data": [
{
"FromVersion": "1.3.23",
"ToVersion": "1.3.24",
"Status": "archived",
"Details": "{\"UpgradePhase\":\"Upgrade\",\"StatusCode\":\"LeaderRestartFailed\",\"FlightingReport\":{\"SQLResultStat\":{\"TotalExecuted\":9000\"Exceptions\":0,\"Incorrect\":1,\"Slow\":1,\"DQLSpeedup\":2}\"SegmentFormatStat\":[{\"Database\":\"test_db\",\"TableUsingSegmentCount\":5},{\"Database\":\"user_order\",\"TableUsingSegmentCount\":7}],\"EstimatedUpgradeTime\":{\"StopInstance\":30,\"BackupData\":120,\"UpgradeInstance\":600},\"ReadPermissionCheckStat\":[{\"db\":\"tst0\",\"user\":\"v4_300433463265624129\",\"schema\":\"dim_db\",\"table\":\"it_rpt_org_tree_info_partition_all\"},{\"db\":\"tst1\",\"user\":\"v4_300433463265624129\",\"schema\":\"dim_db\",\"table\":\"it_rpt_org_tree_info_partition_all_2\"},]},\"UpgradingSteps\":{\"Stop\":{\"Status\":\"Success\",\"StartTime\":\"2023-05-09T06:48:28.843Z\",\"StopTime\":\"2023-05-09T06:48:28.843Z\"},\"Backup\":{\"Status\":\"Success\",\"StartTime\":\"2023-05-09T06:48:28.843Z\",\"StopTime\":\"2023-05-09T06:48:28.843Z\"},\"DoUpgrade\":{\"Status\":\"Success\",\"StartTime\":\"2023-05-09T06:48:28.843Z\",\"StopTime\":\"2023-05-09T06:48:28.843Z\"},\"Rollback\":{\"Status\":\"Success\",\"StartTime\":\"2023-05-09T06:48:28.843Z\",\"StopTime\":\"2023-05-09T06:48:28.843Z\"}},\"Instances\":{\"LeaderInstanceId\":\"hgxxx\",\"LeaderInstanceName\":\"ERP instance\",\"LeaderInstanceStatus\":\"Running\",\"FollowerInstances\":[{\"InstanceId\":\"hgxxx\",\"InstanceName\":\"TMSinstance\",\"Status\":\"Running\"},{\"InstanceId\":\"hxxx\"\"InstanceName\":\"WMS readonly\",\"Status\":\"Unavailable\"}]}}",
"PrepareFinishTime": "2023-05-09T06:48:28.843Z"
}
],
"Success": true,
"ErrorCode": "404",
"ErrorMessage": "Internal server error.",
"HttpStatusCode": "200"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.