GetUpgradeable

Updated at:

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

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:GetUpgradeable

get

*Instance

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

None None

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.