DescribeAvailableInstanceTypes
Queries the available instance types for scenarios such as disaster recovery drills, failover, and failback.
Try it now
Test
RAM authorization
|
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 |
| ChargeType |
string |
No |
The billing method. Valid values:
|
PostPaid |
| Network |
string |
No |
The network type. Valid values:
|
vpc |
| IoOptimized |
boolean |
No |
Specifies whether the instance is I/O optimized. |
true |
| SortBy |
string |
No |
The sort criterion. Valid values:
|
vcpu |
| Order |
string |
No |
The sort order. Valid values:
|
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:
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.