文档

DescribeResourcesModification - 查询某一可用区可用资源信息

更新时间:

调用DescribeResourcesModification查询升级和降配实例规格或者系统盘时,某一可用区的可用资源信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeResourcesModificationRead
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

目标地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ResourceIdstring

资源 ID。例如,当待查询的资源为实例时,可以理解为 InstanceId。

i-bp67acfmxazb4p****
MigrateAcrossZoneboolean

是否支持跨集群升级实例规格。取值范围:

  • true:支持。
  • false:不支持。

默认值:false。

当参数 MigrateAcrossZone 取值为 true 时,一旦您根据返回信息升级了云服务器,请留意以下注意事项:

  • 经典网络类型实例:
    • 对于已停售的实例规格,非 I/O 优化实例变配到 I/O 优化实例时,实例私网 IP 地址、云盘设备名和软件授权码会发生变化。对于 Linux 实例,普通云盘(cloud)会被识别为 xvda 或者 xvdb 等,高效云盘(cloud_efficiency)和 SSD 云盘(cloud_ssd)会被识别为 vda 或者 vdb 等。
    • 对于正常售卖的实例规格族,实例的私网 IP 地址会发生变化。
  • 专有网络 VPC 类型实例:对于已停售的实例规格,非 I/O 优化实例变配到 I/O 优化实例时,云服务器云盘设备名和软件授权码会发生变化。Linux 实例的普通云盘(cloud)会被识别为 xvda 或者 xvdb 等,高效云盘(cloud_efficiency)和 SSD 云盘(cloud_ssd)会被识别为 vda 或者 vdb 等。
true
DestinationResourcestring

目标资源类型。取值范围:

  • InstanceType:实例规格。
  • SystemDisk:系统盘类型。
InstanceType
OperationTypestring

更改资源配置的操作类型。

  • 包年包月资源的取值范围:

    • Upgrade:升级资源。
    • Downgrade:降级资源。
    • RenewDowngrade:续费降配。
    • RenewModify:过期实例的续费变配。
  • 按量付费资源的取值:Upgrade。

默认值:Upgrade。

Upgrade
InstanceTypestring

实例规格。更多信息,请参见实例规格族,也可以调用 DescribeInstanceTypes 接口获得最新的规格表。当参数 DestinationResource 取值为 SystemDisk 时,必须同时指定 InstanceType 参数。

ecs.g5.large
Coresinteger

实例规格的 vCPU 内核数目。取值请参见实例规格族。当 DestinationResource=InstanceType 参数有效,Cores 才为有效参数。

2
Memoryfloat

实例规格的内存大小,单位为 GiB。取值请参见实例规格族。当 DestinationResource=InstanceType,Memory 才为有效参数。

8.0
ZoneIdstring

可用区 ID。

cn-hangzhou-e
Conditionsarray

条件列表。

string

指定条件,查询当前资源满足条件后支持变更到的目标资源属性值。

目前仅支持传入 DiskCategory,表示查询实例变更云盘类型后支持变配到的规格。

DiskCategory

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
AvailableZonesobject []

数据中心信息 AvailableZone 组成的集合。

ZoneIdstring

可用区 ID。

cn-hangzhou-e
Statusstring

资源状态。可能值:

  • Available:资源充足。
  • SoldOut:资源已售罄。
Available
StatusCategorystring

根据库存详细分类资源类别。可能值:

  • WithStock:库存充足。
  • ClosedWithStock:库存接近水位低线。
  • WithoutStock:库存告罄。
WithStock
RegionIdstring

地域 ID。

cn-hangzhou
AvailableResourcesobject []

可供创建的具体资源组成的数组。

Typestring

资源类型。可能值:

  • Zone:可用区。
  • IoOptimized:I/O 优化。
  • InstanceType:实例规格。
  • SystemDisk:系统盘类型。
  • DataDisk:数据盘类型。
  • Network:网络类型。
InstanceType
SupportedResourcesobject []

支持的可供创建的具体资源组成的数组。

Statusstring

资源状态。可能值:

  • Available:资源充足。
  • SoldOut:资源已售罄。
Available
Valuestring

资源值。

ecs.g5.large
Maxinteger

云盘容量范围的最大值。

仅当入参 DestinationResource 取值为 SystemDisk 时该参数才生效。

2048
Unitstring

云盘容量的单位。 仅当入参 DestinationResource 取值为 SystemDisk 时该参数才生效。

GiB
StatusCategorystring

根据库存详细分类资源类别。可能值:

  • WithStock:库存充足。

  • ClosedWithStock:库存接近水位低线。

  • WithoutStock:库存告罄。

WithStock
Mininteger

云盘容量范围的最小值。

仅当入参 DestinationResource 取值为 SystemDisk 时该参数才生效。

20
ConditionSupportedResourcesobject []

有条件支持的可供创建的具体资源列表。满足条件后,可以将当前资源变更到列表中的资源。

Conditionsobject []

条件列表。

Keystring

条件名。目前可选值:

DiskCategory:盘类型不满足。

DiskCategory
Statusstring

资源的库存状态。可能值:

  • Available:资源充足。

  • SoldOut:资源已售罄。

Available
Valuestring

资源值。

ecs.g5.large
Maxinteger

云盘容量范围的最大值。

仅当入参 DestinationResource 取值为 SystemDisk 时该参数才生效。

2048
Unitstring

云盘容量的单位。

仅当入参 DestinationResource 取值为 SystemDisk 时该参数才生效。

GiB
StatusCategorystring

根据库存详细分类资源类别。可能值:

  • WithStock:库存充足。

  • ClosedWithStock:库存接近水位低线。

  • WithoutStock:库存告罄。

WithStock
Mininteger

云盘容量范围的最小值。

仅当入参 DestinationResource 取值为 SystemDisk 时该参数才生效。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "AvailableZones": {
    "AvailableZone": [
      {
        "ZoneId": "cn-hangzhou-e",
        "Status": "Available",
        "StatusCategory": "WithStock",
        "RegionId": "cn-hangzhou",
        "AvailableResources": {
          "AvailableResource": [
            {
              "Type": "InstanceType",
              "SupportedResources": {
                "SupportedResource": [
                  {
                    "Status": "Available",
                    "Value": "ecs.g5.large",
                    "Max": 2048,
                    "Unit": "GiB",
                    "StatusCategory": "WithStock",
                    "Min": 20
                  }
                ]
              },
              "ConditionSupportedResources": {
                "ConditionSupportedResource": [
                  {
                    "Conditions": {
                      "Condition": [
                        {
                          "Key": "DiskCategory"
                        }
                      ]
                    },
                    "Status": "Available",
                    "Value": "ecs.g5.large",
                    "Max": 2048,
                    "Unit": "GiB",
                    "StatusCategory": "WithStock",
                    "Min": 20
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Invalid.OperationTypeThe specified operationType is not valid.指定的参数 operationType 无效。
400Invalid.ParamThe input parameter DestinationResource that is mandatory for processing this request is not supplied.目标资源类型无效。
400Invalid.InstanceChargeTypeThe specified InstanceChargeType is not valid.指定的参数 InstanceChargeType 无效。
400InvalidCondition.MalformedThe specified Condition is not valid.-
403InvalidDedicatedHostId.NotFoundThe specified DedicatedHostId does not exist in our records.指定的宿主机在当前地域中不存在。
403InvalidParam.TypeAndCpuMem.ConflictThe specified 'InstanceType' and 'Cores','Memory' are not blank at the same time.-
403InvalidParam.CoresThe specified parameter 'Cores' should be empty.-
403InvalidParam.MemoryThe specified parameter 'Memory' should be empty.-
403InvalidParameter.ResourceOwnerIdThe specified parameter ResourceOwnerId is not available anymore.-
404Invalid.RegionIdThe specified RegionId does not exist.地域参数无效。
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.提供的RegionId不存在
404Unavailable.RegionsThe available regions does not exists.-
404Invalid.ResourceTypeThe ResourceType provided does not exist in our records.资源类型无效。
404Invalid.DestinationResourceThe specified DestinationResource is not valid.指定的目标资源无效。
404Invalid.IoOptimizedThe specified IoOptimized is not valid.指定的参数 IoOptimized 无效。
404Invalid.NetworkCategoryThe specified NetworkCategory is not valid.指定的参数 NetworkCategory 无效。
404Invalid.SpotStrategyThe specified SpotStrategy is not valid.竞价策略参数无效。
404Invalid.ResourceIdThe specified ResourceId is not valid.指定的参数 ResourceId 无效。
404Invalid.InstancePayTypeThe specified InstancePayType is not valid.指定的参数 InstanceChargeType 无效。
404Invalid.OperationTypeThe specified OperationType is not valid.指定的参数 operationType 无效。
404OperationDeniedThe specified operation is denied as this instanceType is not support.实例规格不支持当前操作。
404InvalidInstanceId.NotFoundThe specified InstanceId provided does not exist in our records.指定的实例不存在,请确认参数是否正确。
404InvalidResourceId.NotFoundThe specified ResourceId is not found in our records.指定的资源不存在,请您检查该资源是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:Conditions
出参OpenAPI 返回结构发生变更
2022-09-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    错误码 404 变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:ZoneId
2022-09-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    错误码 404 变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:ZoneId
  • 本页导读 (1)