All Products
Search
Document Center

Hologres:GetUpgradeable

Last Updated:Aug 24, 2026

Queries whether an instance can be upgraded.

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

GET /api/v1/instances/{instanceId}/upgradeable HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

instanceId

string

No

The instance ID.

hgprecn-cn-tl32mqkmxxxx

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID.

cn-beijing

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

B8E7613D-E09F-59D3-B35A-FBB7680DCE8F

Data

array<object>

The returned result.

object

The returned result.

Success

boolean

Indicates whether the instance can be upgraded. Valid values:

  • true: The instance can be upgraded.

  • false: The instance cannot be upgraded because it is already the latest version.

true

FailReason

string

The reason why the upgrade failed.

null

ReasonKey

string

The key of the upgrade reason.

null

Success

boolean

Indicates whether the request was successful. This parameter is not related to business logic.

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": "B8E7613D-E09F-59D3-B35A-FBB7680DCE8F",
  "Data": [
    {
      "Success": true,
      "FailReason": "null",
      "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.