PrepareUpgrade - Hologres - Alibaba Cloud Documentation Center

Prepares an instance for an upgrade by running a pre-upgrade assessment. You can upgrade the instance only if the assessment passes. If it fails, contact technical support for a manual upgrade.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /api/v1/instances/{instanceId}/upgrade/prepare HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The ID of the instance.	hgpostcn-cn-nwy3e6yxxx

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shenzhen
body	object	No	The request body.
version	string	No	The target version for the upgrade. Call the ListUpgradeReleaseVersion operation to get a list of available versions.	r5.0.0
dryRun	boolean	No	This parameter is deprecated.	true

Response elements

Element	Type	Description	Example
	object	The data structure of the response.
RequestId	string	The ID of the request.	77B97AFB-7C9D-50FF-A72D-F13FD73E49D8
Data	object	The response parameters.
Success	boolean	Indicates whether the preparation task started successfully.	true
FailReason	string	The reason the preparation task failed.	null
ReasonKey	string	A key that identifies the reason for the failure.	null
Success	boolean	Indicates whether the API call was successful. This does not indicate the result of the upgrade preparation.	true
ErrorCode	string	The error code returned if the request fails.	null
ErrorMessage	string	The error message returned if the request fails.	null
HttpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "RequestId": "77B97AFB-7C9D-50FF-A72D-F13FD73E49D8",
  "Data": {
    "Success": true,
    "FailReason": "null\n",
    "ReasonKey": "null"
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.