GetUpgradeStatus - Hologres - Alibaba Cloud Documentation Center

Queries the upgrade status.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hologram:GetUpgradeStatus

get

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

GET /api/v1/instances/{instanceId}/upgrade/status HTTP/1.1

Path 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	Schema of Response
RequestId	string	Id of the request	D73E42D0-AA72-5880-B96F-548B43C84736
Data	array<object>	The returned result.
	object
FromVersion	string	The current version.	1.3.23
ToVersion	string	The target version to upgrade to.	1.3.24
Status	string	The status of the AirFlow DAG used for the instance upgrade. Valid values: archived : Succeeded. upgrading : Upgrading. preparing : Preparing.	archived
Details	string	The 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	string	The time when the preparation is completed. The time is in the ISO 8601 standard in UTC.	2023-05-09T06:48:28.843Z
Success	boolean	Indicates whether the request was successful. This parameter is not related to business logic.	true
ErrorCode	string	The error code.	404
ErrorMessage	string	The error message.	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.