UpgradeInstance - Hologres - Alibaba Cloud Documentation Center

Upgrades an instance. If the preparation is successful, the instance can start the upgrade directly.

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 HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID.	hgprecn-cn-jeo3n72xxxx

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
upgradeTime	string	No	The upgrade time.	2025-02-11 10:00:01
type	string	No	The upgrade type.	hot

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	EEB0A71E-7AC7-572F-990F-EE51D3FD35B9
Data	object	The returned data.
Success	boolean	Indicates whether the operation is successful. Valid values: true: Successful. false: Failed.	true
FailReason	string	The reason for the upgrade failure.	null
ReasonKey	string	The reason key.	null
Success	boolean	The request result, which indicates whether an exception occurred for this request.	true
ErrorCode	string	The error code.	null
ErrorMessage	string	The error message.	null
HttpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "RequestId": "EEB0A71E-7AC7-572F-990F-EE51D3FD35B9",
  "Data": {
    "Success": true,
    "FailReason": "null",
    "ReasonKey": "null"
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	You are not authorized to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.