调用DescribeResourcesModification查询升级和降配实例规格或者系统盘时,某一可用区的可用资源信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeResourcesModification | 系统规定参数。取值:DescribeResourcesModification。 |
RegionId | String | 是 | cn-hangzhou | 目标地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
ResourceId | String | 是 | i-bp67acfmxazb4p**** | 资源ID。例如,当待查询的资源为实例时,可以理解为InstanceId。 |
MigrateAcrossZone | Boolean | 否 | true | 是否支持跨集群升级实例规格。取值范围:
默认值:false。 当参数MigrateAcrossZone取值为true时,一旦您根据返回信息升级了云服务器,请留意以下注意事项:
|
DestinationResource | String | 是 | InstanceType | 目标资源类型。取值范围:
|
OperationType | String | 否 | Upgrade | 更改资源配置的操作类型。
默认值:Upgrade。 |
InstanceType | String | 否 | ecs.g5.large | 实例规格。更多信息,请参见实例规格族,也可以调用DescribeInstanceTypes 接口获得最新的规格表。当参数DestinationResource取值为SystemDisk时,必须同时指定InstanceType参数。 |
Cores | Integer | 否 | 2 | 实例规格的vCPU内核数目。取值请参见实例规格族。当DestinationResource=InstanceType参数有效,Cores才为有效参数。 |
Memory | Float | 否 | 8.0 | 实例规格的内存大小,单位为GiB。取值请参见实例规格族。当DestinationResource=InstanceType,Memory才为有效参数。 |
ZoneId | String | 否 | cn-hangzhou-e | 可用区ID。 |
Conditions.N | String | 否 | DiskCategory | 指定条件,查询当前资源满足条件后支持变更到的目标资源属性值。 目前仅支持传入DiskCategory,表示查询实例变更云盘类型后支持变配到的规格。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | 请求ID。 |
AvailableZones | Array of AvailableZone | 数据中心信息AvailableZone组成的集合。 |
|
AvailableZone | |||
ZoneId | String | cn-hangzhou-e | 可用区ID。 |
Status | String | Available | 资源状态。可能值:
|
StatusCategory | String | WithStock | 根据库存详细分类资源类别。可能值:
|
RegionId | String | cn-hangzhou | 地域ID。 |
AvailableResources | Array of AvailableResource | 可供创建的具体资源组成的数组。 |
|
AvailableResource | |||
Type | String | InstanceType | 资源类型。可能值:
|
SupportedResources | Array of SupportedResource | 支持的可供创建的具体资源组成的数组。 |
|
SupportedResource | |||
Status | String | Available | 资源状态。可能值:
|
Value | String | ecs.g5.large | 资源值。 |
Max | Integer | 2048 | 云盘容量范围的最大值。 仅当入参DestinationResource取值为SystemDisk时该参数才生效。 |
Unit | String | GiB | 云盘容量的单位。 仅当入参DestinationResource取值为SystemDisk时该参数才生效。 |
StatusCategory | String | WithStock | 根据库存详细分类资源类别。可能值:
|
Min | Integer | 20 | 云盘容量范围的最小值。 仅当入参DestinationResource取值为SystemDisk时该参数才生效。 |
ConditionSupportedResources | Array of ConditionSupportedResource | 有条件支持的可供创建的具体资源列表。满足条件后,可以将当前资源变更到列表中的资源。 |
|
ConditionSupportedResource | |||
Conditions | Array of Condition | 条件列表。 |
|
Condition | |||
Key | String | DiskCategory | 条件名。目前可选值: DiskCategory:盘类型不满足。 |
Status | String | Available | 资源的库存状态。可能值:
|
Value | String | ecs.g5.large | 资源值。 |
Max | Integer | 2048 | 云盘容量范围的最大值。 仅当入参DestinationResource取值为SystemDisk时该参数才生效。 |
Unit | String | GiB | 云盘容量的单位。 仅当入参DestinationResource取值为SystemDisk时该参数才生效。 |
StatusCategory | String | WithStock | 根据库存详细分类资源类别。可能值:
|
Min | Integer | 20 | 云盘容量范围的最小值。 仅当入参DestinationResource取值为SystemDisk时该参数才生效。 |
示例
请求示例
http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
&DestinationResource=InstanceType
&RegionId=cn-hangzhou
&ResourceId=i-bp67acfmxazb4p****
&MigrateAcrossZone=true
&OperationType=Upgrade
&InstanceType=ecs.g5.large
&公共请求参数
正常返回示例
XML
格式
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>
<StatusCategory>WithStock</StatusCategory>
</SupportedResources>
<ConditionSupportedResources>
<Conditions>
<Key>DiskCategory</Key>
</Conditions>
<Status>Available</Status>
<Value>ecs.g5.large</Value>
<StatusCategory>WithStock</StatusCategory>
</ConditionSupportedResources>
</AvailableResources>
</AvailableZones>
</DescribeResourcesModificationResponse>
JSON
格式
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",
"StatusCategory" : "WithStock"
} ],
"ConditionSupportedResources" : [ {
"Conditions" : [ {
"Key" : "DiskCategory"
} ],
"Status" : "Available",
"Value" : "ecs.g5.large",
"StatusCategory" : "WithStock"
} ]
} ]
} ]
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | Invalid.OperationType | The specified operationType is not valid. | 指定的参数 operationType 无效。 |
400 | Invalid.Param | The input parameter DestinationResource that is mandatory for processing this request is not supplied. | 目标资源类型无效。 |
400 | Invalid.InstanceChargeType | The specified InstanceChargeType is not valid. | 指定的参数 InstanceChargeType 无效。 |
403 | InvalidDedicatedHostId.NotFound | The specified DedicatedHostId does not exist in our records. | 指定的宿主机在当前地域中不存在。 |
404 | Invalid.RegionId | The specified RegionId does not exist. | 地域参数无效。 |
404 | Invalid.ResourceType | The ResourceType provided does not exist in our records. | 资源类型无效。 |
404 | Invalid.DestinationResource | The specified DestinationResource is not valid. | 指定的目标资源无效。 |
404 | Invalid.IoOptimized | The specified IoOptimized is not valid. | 指定的参数 IoOptimized 无效。 |
404 | Invalid.NetworkCategory | The specified NetworkCategory is not valid. | 指定的参数 NetworkCategory 无效。 |
404 | Invalid.SpotStrategy | The specified SpotStrategy is not valid. | 竞价策略参数无效。 |
404 | Invalid.ResourceId | The specified ResourceId is not valid. | 指定的参数 ResourceId 无效。 |
404 | Invalid.InstancePayType | The specified InstancePayType is not valid. | 指定的参数 InstanceChargeType 无效。 |
404 | OperationDenied | The specified operation is denied as this instanceType is not support. | 实例规格不支持当前操作。 |
404 | InvalidInstanceId.NotFound | The specified InstanceId provided does not exist in our records. | 指定的实例不存在,请确认参数是否正确。 |
404 | InvalidResourceId.NotFound | The specified ResourceId is not found in our records. | 指定的资源不存在,请您检查该资源是否正确。 |
访问错误中心查看更多错误码。