Queries available resources within a specific zone when you upgrade or downgrade instance types or replace system disks.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeResourcesModification |
The operation that you want to perform. Set the value to DescribeResourcesModification. |
RegionId | String | Yes | cn-hangzhou |
The ID of the region. You can call the DescribeRegions operation to query the most recent region list. |
ResourceId | String | Yes | i-bp67acfmxazb4p**** |
The ID of the resource. For example, when DestinationResource is set to InstanceType, this parameter can be interpreted as InstanceId. |
MigrateAcrossZone | Boolean | No | true |
Specifies whether to support cross-cluster instance type upgrades. Valid values:
Default value: false. When the MigrateAcrossZone parameter is set to true and you upgrade the instance type of the Elastic Compute Service (ECS) instance based on returned information, take note of the following items:
|
DestinationResource | String | Yes | InstanceType |
The type of the resource. Valid values:
|
OperationType | String | No | Upgrade |
The operation of changing resource configurations.
Default value: Upgrade. |
InstanceType | String | No | ecs.g5.large |
The instance type. For more information, see Instance families or call the DescribeInstanceTypes operation to query the most recent instance type list. This parameter is required when the DestinationResource parameter is set to SystemDisk. |
Cores | Integer | No | 2 |
The number of vCPU cores of the instance type. For more information, see Instance families. This parameter is valid only when DestinationResource is set to InstanceType. |
Memory | Float | No | 8.0 |
The memory size of the instance type. Unit: GiB. For more information, see Instance families. This parameter is valid only when DestinationResource is set to InstanceType. |
ZoneId | String | No | cn-hangzhou-e |
The ID of the zone to query. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
The ID of the request. |
AvailableZones | Array of AvailableZone |
Details about the available zones. |
|
AvailableZone | |||
ZoneId | String | cn-hangzhou-e |
The ID of the zone. |
Status | String | Available |
The state of the resource. Valid values:
|
StatusCategory | String | WithStock |
The category of resource based on stock status. Valid values:
|
RegionId | String | cn-hangzhou |
The region ID of the zone. |
AvailableResources | Array of AvailableResource |
Details about the resources available in the zone. |
|
AvailableResource | |||
Type | String | InstanceType |
The type of resource. Valid values:
|
SupportedResources | Array of SupportedResource |
Details about the resources. |
|
SupportedResource | |||
Status | String | Available |
The state of the resource. Valid values:
|
Value | String | ecs.g5.large |
The resource value. |
Max | Integer | 2 |
The maximum resource specification value. This parameter is not returned if it has no value. |
Unit | String | null |
The resource specification unit. This parameter is not returned if it has no value. |
StatusCategory | String | WithStock |
The category of resource based on stock status. Valid values:
|
Min | Integer | 1 |
The minimum resource specification value. This parameter is not returned if it has no value. |
Examples
Sample requests
http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
&DestinationResource=InstanceType
&RegionId=cn-hangzhou
&ResourceId=i-bp67acfmxazb4p****
&MigrateAcrossZone=true
&OperationType=Upgrade
&InstanceType=ecs.g5.large
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeResourcesModificationResponse>
<RequestId>994F2B60-B050-49E3-9283-44655FAC7A4X</RequestId>
<AvailableZones>
<AvailableZone>
<Status>Available</Status>
<RegionId>cn-hangzhou</RegionId>
<AvailableResources>
<AvailableResource>
<Type>InstanceType</Type>
<SupportedResources>
<SupportedResource>
<Status>Available</Status>
<Value>ecs.g5.xlarge</Value>
</SupportedResource>
<SupportedResource>
<Status>Available</Status>
<Value>ecs.t5-lc1m2.large</Value>
</SupportedResource>
<SupportedResource>
<Status>Available</Status>
<Value>ecs.t5-c1m4.2xlarge</Value>
</SupportedResource>
<SupportedResource>
<Status>Available</Status>
<Value>ecs.c5.xlarge</Value>
</SupportedResource>
</SupportedResources>
</AvailableResource>
</AvailableResources>
<ZoneId>cn-hangzhou-e</ZoneId>
</AvailableZone>
</AvailableZones>
</DescribeResourcesModificationResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "994F2B60-B050-49E3-9283-44655FAC7A4X",
"AvailableZones" : {
"AvailableZone" : [ {
"Status" : "Available",
"RegionId" : "cn-hangzhou",
"AvailableResources" : {
"AvailableResource" : [ {
"Type" : "InstanceType",
"SupportedResources" : {
"SupportedResource" : [ {
"Status" : "Available",
"Value" : "ecs.g5.xlarge"
}, {
"Status" : "Available",
"Value" : "ecs.t5-lc1m2.large"
}, {
"Status" : "Available",
"Value" : "ecs.t5-c1m4.2xlarge"
}, {
"Status" : "Available",
"Value" : "ecs.c5.xlarge"
} ]
}
} ]
},
"ZoneId" : "cn-hangzhou-e"
} ]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | Invalid.OperationType | The specified operationType is not valid. | The error message returned because the specified OperationType parameter is invalid. |
400 | Invalid.Param | The input parameter DestinationResource that is mandatory for processing this request is not supplied. | The error message returned because the specified DestinationResource parameter is invalid. |
400 | Invalid.InstanceChargeType | The specified InstanceChargeType is not valid. | The error message returned because the specified instance billing method is invalid. |
403 | InvalidDedicatedHostId.NotFound | The specified DedicatedHostId does not exist in our records. | The error message returned because the specified dedicated host does not exist within the current region. |
404 | Invalid.RegionId | The specified RegionId does not exist. | The error message returned because the specified RegionId parameter is invalid. |
404 | Invalid.ResourceType | The ResourceType provided does not exist in our records. | The error message returned because the specified resource type is invalid. |
404 | Invalid.DestinationResource | The specified DestinationResource is not valid. | The error message returned because the specified DestinationResource parameter is invalid. |
404 | Invalid.IoOptimized | The specified IoOptimized is not valid. | The error message returned because the specified IoOptimized parameter is invalid. |
404 | Invalid.NetworkCategory | The specified NetworkCategory is not valid. | The error message returned because the specified NetworkCategory parameter is invalid. |
404 | Invalid.SpotStrategy | The specified SpotStrategy is not valid. | The error message returned because the specified SpotStrategy parameter is invalid. |
404 | Invalid.ResourceId | The specified ResourceId is not valid. | The error message returned because the specified ResourceId parameter is invalid. |
404 | Invalid.InstancePayType | The specified InstancePayType is not valid. | The error message returned because the specified instance billing method is invalid. |
404 | OperationDenied | The specified operation is denied as this instanceType is not support. | The error message returned because the instance type does not support the operation. |
404 | InvalidInstanceId.NotFound | The specified InstanceId provided does not exist in our records. | The error message returned because the specified instance ID does not exist. Check whether the instance ID is correct. |
404 | InvalidResourceId.NotFound | The specified ResourceId is not found in our records. | The error message returned because the specified ResourceId parameter does not exist. Check whether the resource ID is correct. |
For a list of error codes, visit the API Error Center.