DescribeResourcesModification - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries available resources within a specific zone when you upgrade or downgrade instance types or replace system disks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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 cross-cluster instance type upgrades are supported. Valid values: true false Default value: false. When MigrateAcrossZone is set to true and you upgrade the instance type of an Elastic Compute Service (ECS) instance based on the returned information, take note of the following items: Instances that reside in the classic network: For retired instance types, when a non-I/O-optimized instance is upgraded to an I/O-optimized instance, the private IP address, disk device names, and software authorization codes of the instance change. For Linux instances, basic disks (cloud) are identified as xvd* such as xvda and xvdb, and ultra disks (cloud_efficiency) and standard SSDs (cloud_ssd) are identified as vd* such as vda and vdb. For instance families available for purchase, when the instance type of an instance is changed, the private IP address of the instance changes. Instances that reside in virtual private clouds (VPCs): For retired instance types, when a non-I/O-optimized instance is upgraded to an I/O-optimized instance, the disk device names and software authorization codes of the instance change. For Linux instances, basic disks (cloud) are identified as xvd* such as xvda and xvdb, and ultra disks (cloud_efficiency) and standard SSDs (cloud_ssd) are identified as vd* such as vda and vdb.
DestinationResource	String	Yes	InstanceType	The target resource type. Valid values: InstanceType SystemDisk
OperationType	String	No	Upgrade	The operation of changing resource configurations. Valid values for subscription resources: Upgrade Downgrade RenewDowngrade RenewModify Valid values for pay-as-you-go resources: Upgrade Default value: Upgrade.
InstanceType	String	No	ecs.g5.large	The instance type. For more information, see Overview of instance families or call the DescribeInstanceTypes operation to query the most recent instance type list. This parameter is required when DestinationResource is set to SystemDisk.
Cores	Integer	No	2	The number of vCPU cores of the instance type. For information about the values, see Overview of instance families. This parameter takes effect only when DestinationResource is set to InstanceType.
Memory	Float	No	8.0	The memory size of the instance type. Unit: GiB. For information about the values, see Overview of instance families. This parameter takes effect only when DestinationResource is set to InstanceType.
ZoneId	String	No	cn-hangzhou-e	The ID of the zone.
Conditions.N	String	No	DiskCategory	The condition. If you specify this parameter, the system queries the resource types that the resource can be changed to after the resource meets the specified condition. Set the value to DiskCategory, which indicates a disk category change. When you set this parameter to DiskCategory, the system queries the instance types that the instance can be changed to after a disk category change.

Response parameters


Parameter	Type	Example	Description
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	The request ID.
AvailableZones	Array of AvailableZone		The information about the queried zones.
AvailableZone
ZoneId	String	cn-hangzhou-e	The ID of the zone.
Status	String	Available	The status of the resource. Valid values: Available SoldOut
StatusCategory	String	WithStock	The category of resource based on stock status. Valid values: WithStock: resources that are in sufficient stock ClosedWithStock: resources that are in insufficient stock WithoutStock: resources that are out of stock
RegionId	String	cn-hangzhou	The ID of the region.
AvailableResources	Array of AvailableResource		The resources that are available in the zone.
AvailableResource
Type	String	InstanceType	The type of resource. Valid values: Zone IoOptimized InstanceType SystemDisk DataDisk Network
SupportedResources	Array of SupportedResource		The information about the resources.
SupportedResource
Status	String	Available	The status of the resource. Valid values: Available SoldOut
Value	String	ecs.g5.large	The resource type.
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: WithStock: resources that are in sufficient stock ClosedWithStock: resources that are in insufficient stock WithoutStock: resources that are out of stock
Min	Integer	1	The minimum resource specification value. This parameter is not returned if it has no value.
ConditionSupportedResources	Array of ConditionSupportedResource		The resource types that resources can be changed to after the resources meet specified conditions.
ConditionSupportedResource
Conditions	Array of Condition		The conditions.
Condition
Key	String	DiskCategory	The condition name. Valid value: DiskCategory, which indicates a disk category change.
Status	String	Available	The stock status of the resource. Valid values: Available SoldOut
Value	String	ecs.g5.large	The resource type.
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: WithStock: resources that are in sufficient stock ClosedWithStock: resources that are in insufficient stock WithoutStock: resources that are out of stock
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>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <AvailableZones>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <Status>Available</Status>
        <StatusCategory>WithStock</StatusCategory>
        <RegionId>cn-hangzhou</RegionId>
        <AvailableResources>
            <Type>InstanceType</Type>
            <SupportedResources>
                <Status>Available</Status>
                <Value>ecs.g5.large</Value>
                <Max>2</Max>
                <Unit>null</Unit>
                <StatusCategory>WithStock</StatusCategory>
                <Min>1</Min>
            </SupportedResources>
            <ConditionSupportedResources>
                <Conditions>
                    <Key>DiskCategory</Key>
                </Conditions>
                <Status>Available</Status>
                <Value>ecs.g5.large</Value>
                <Max>2</Max>
                <Unit>null</Unit>
                <StatusCategory>WithStock</StatusCategory>
                <Min>1</Min>
            </ConditionSupportedResources>
        </AvailableResources>
    </AvailableZones>
</DescribeResourcesModificationResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "AvailableZones" : [ {
    "ZoneId" : "cn-hangzhou-e",
    "Status" : "Available",
    "StatusCategory" : "WithStock",
    "RegionId" : "cn-hangzhou",
    "AvailableResources" : [ {
      "Type" : "InstanceType",
      "SupportedResources" : [ {
        "Status" : "Available",
        "Value" : "ecs.g5.large",
        "Max" : 2,
        "Unit" : "null",
        "StatusCategory" : "WithStock",
        "Min" : 1
      } ],
      "ConditionSupportedResources" : [ {
        "Conditions" : [ {
          "Key" : "DiskCategory"
        } ],
        "Status" : "Available",
        "Value" : "ecs.g5.large",
        "Max" : 2,
        "Unit" : "null",
        "StatusCategory" : "WithStock",
        "Min" : 1
      } ]
    } ]
  } ]
}

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.