DescribeAvailableInstanceTypes

Updated at:

Queries the available instance types for scenarios such as disaster recovery drills, failover, and failback.

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

hdr:DescribeAvailableInstanceTypes

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Region

string

Yes

The region ID.

cn-shanghai

ZoneId

string

Yes

The zone ID.

cn-beijing-g

DiskType

string

Yes

The disk type.

Valid values:

  • cloud_efficiency,cloud_essd,cloud_ssd :

    cloud_efficiency,cloud_essd,cloud_ssd

cloud_efficiency

ChargeType

string

No

The billing method.

Valid values:

  • PostPaid :

    PostPaid

  • PrePaid :

    PrePaid

PostPaid

Network

string

No

The network type.

Valid values:

  • classic :

    classic

  • vpc :

    vpc

vpc

IoOptimized

boolean

No

Specifies whether the instance is I/O optimized.

true

SortBy

string

No

The sort criterion.

Valid values:

  • memory :

    memory

  • vcpu :

    vcpu

vcpu

Order

string

No

The sort order.

Valid values:

  • asc :

    asc

  • desc :

    desc

asc

Filter

string

No

The query filter expression. Separate multiple expressions with semicolons (;). An expression consists of a key, an operator, and a value.

Supported keys:

  • vcpu: the number of vCPUs of the instance type.

  • memory: the memory size of the instance type.

Supported operators include <, <=, >, >=, and =. The value must be an integer.

vcpu>=2;vcpu<16;memory>=4;

PageNumber

integer

No

The page number.

1

PageSize

integer

No

The page size.

10

UserClient

boolean

No

Specifies whether to use the user role to query available instance types. By default, the Hybrid Disaster Recovery service account is used. You must enable this parameter to query specific whitelisted instance types.

true

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

1A7577E8-755A-5BF5-A6BA-B87286D0743F

Success

boolean

Indicates whether the request is successful.

True

Code

string

The return code.

200

Message

string

The response message.

successful

PageSize

integer

The page size.

10

PageNumber

integer

The page number.

1

TotalCount

integer

The total number of instances returned.

11

InstanceTypes

object

instanceType

array

The list of available instance types.

string

The available instance type.

ecs.g5ne.xlarge

Examples

Success response

JSON format

{
  "RequestId": "1A7577E8-755A-5BF5-A6BA-B87286D0743F",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 11,
  "InstanceTypes": {
    "instanceType": [
      "ecs.g5ne.xlarge"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.