DescribeResourcesModification

更新時間:
Copy as MD

變更執行個體規格或系統磁碟類型之前,查詢某一可用區下執行個體規格或系統磁碟的庫存情況。

介面說明

常見變更場景示例如下:

示例 1:查詢當前執行個體支援變配的規格

查詢執行個體 i-bp67acfmxazb4p****支援變配到的規格,以及相應規格在執行個體所屬可用區下的庫存情況。

http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
&RegionId=cn-hangzhou
&ResourceId=i-bp67acfmxazb4p****
&DestinationResource=InstanceType
&OperationType=Upgrade
&公共請求參數

示例 2:查詢當前執行個體變更雲端硬碟類型後支援變配到的規格

查詢執行個體 i-bp67acfmxazb4p****變更雲端硬碟類型後,可以變配到的規格,以及相應規格在執行個體所屬可用區下的庫存情況。

http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
&RegionId=cn-hangzhou
&ResourceId=i-bp67acfmxazb4p****
&DestinationResource=InstanceType
&OperationType=Upgrade
&Conditions.0=DiskCategory
&公共請求參數

示例 3:查詢目標規格要求的雲端硬碟類型

查詢目標規格(例如 ecs.g7.large)要求的雲端硬碟類型(即當前執行個體 i-bp67acfmxazb4p****變更到該雲端硬碟類型後才支援變配到目標規格),以及雲端硬碟類型在執行個體所屬可用區下的庫存情況。

說明

目標規格需透過示例 2 查詢。

http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
&RegionId=cn-hangzhou
&ResourceId=i-bp67acfmxazb4p****
&DestinationResource=SystemDisk
&OperationType=Upgrade
&InstanceType=ecs.g7.large
&公共請求參數

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeResourcesModification

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

待變更執行個體所屬的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。

cn-hangzhou

ResourceId

string

待變更規格或系統磁碟類型的執行個體 ID(InstanceId)。

i-bp67acfmxazb4p****

MigrateAcrossZone

boolean

是否支援跨叢集升級執行個體規格。取值範圍:

  • true:支援。

  • false:不支援。

預設值:false。

當參數 MigrateAcrossZone 取值為 true 時,一旦您根據返回資訊升級了雲端伺服器,請留意以下注意事項:

  • 專有網路 VPC 類型執行個體:對於已停售的執行個體規格,非 I/O 優化執行個體變配到 I/O 優化執行個體時,雲端伺服器雲端硬碟裝置名和軟體授權碼會發生變化。Linux 執行個體的普通雲端硬碟(cloud)會被識別為 xvda 或者 xvdb 等,高效雲端硬碟(cloud_efficiency)和 SSD 雲端硬碟(cloud_ssd)會被識別為 vda 或者 vdb 等。

true

DestinationResource

string

待變更的執行個體資源類型。取值範圍:

  • InstanceType:執行個體規格。

  • SystemDisk:系統磁碟類型。

    取值為 SystemDisk 時,必須同時指定 InstanceType 參數。表示目標規格要求的雲端硬碟類型。

InstanceType

OperationType

string

更改資源配置的操作類型。

  • 包年包月資源的取值範圍:

    • Upgrade:升級資源。

    • Downgrade:降級資源。

    • RenewDowngrade:續費降配。

    • RenewModify:過期執行個體的續費變配。

  • 按量付費資源的取值:Upgrade。

預設值:Upgrade。

Upgrade

InstanceType

string

目標執行個體規格。更多資訊,請參見執行個體規格族,也可以呼叫 DescribeInstanceTypes 介面獲得最新的規格表。

當參數 DestinationResource 取值為 SystemDisk 時,必須同時指定 InstanceType 參數。表示目標規格要求的雲端硬碟類型。

ecs.g7.large

Cores

integer

目標執行個體規格的 vCPU 核心數目。取值請參見執行個體規格族

僅當 DestinationResource=InstanceType 參數有效,Cores 為有效參數。

2

Memory

number

目標執行個體規格的記憶體大小,單位為 GiB。取值請參見執行個體規格族

僅當 DestinationResource=InstanceType,Memory 才為有效參數。

8.0

ZoneId

string

目標可用區 ID。

當需要跨可用區變更執行個體規格時,需要指定該參數。

cn-hangzhou-e

Conditions

array

條件列表。

string

目前僅支援 DiskCategory,表示查詢當前執行個體變更雲端硬碟類型後支援變配到的規格。

僅當 DestinationResource=InstanceType,Conditions 為有效參數。

DiskCategory

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

AvailableZones

object

AvailableZone

array<object>

資料中心資訊 AvailableZone 組成的集合。

array<object>

ZoneId

string

可用性區域 ID。

cn-hangzhou-e

Status

string

資源狀態。可能值:

  • Available:資源充足。

  • SoldOut:資源已售罄。

Available

StatusCategory

string

根據庫存詳細分類資源類別。可能值:

  • WithStock:庫存充足。

  • ClosedWithStock:庫存接近水位低線。

  • WithoutStock:庫存告罄。

WithStock

RegionId

string

地區 ID。

cn-hangzhou

AvailableResources

object

AvailableResource

array<object>

可供建立的具體資源群組成的數組。

array<object>

Type

string

資源類型。可能值:

  • InstanceType:執行個體規格。

  • SystemDisk:系統硬碟類型。

InstanceType

SupportedResources

object

SupportedResource

array<object>

支援的可供建立的具體資源群組成的數組。

object

Status

string

資源狀態。可能值:

  • Available:資源充足。

  • SoldOut:資源已售罄。

Available

Value

string

資源值。

ecs.g7.large

Max

integer

雲端硬碟容量範圍的最大值。

僅當入參 DestinationResource 取值為 SystemDisk 時該參數才生效。

2048

Unit

string

雲端硬碟容量的單位。 僅當入參 DestinationResource 取值為 SystemDisk 時該參數才生效。

GiB

StatusCategory

string

根據庫存詳細分類資源類別。可能值:

  • WithStock:庫存充足。

  • ClosedWithStock:庫存接近水位低線。

  • WithoutStock:庫存告罄。

WithStock

Min

integer

雲端硬碟容量範圍的最小值。

僅當入參 DestinationResource 取值為 SystemDisk 時該參數才生效。

20

ConditionSupportedResources

object

ConditionSupportedResource

array<object>

有條件支援的可供建立的具體資源清單。

array<object>

有條件支援的可供建立的具體資源。滿足條件後,可以將當前資源變更到列表中的資源。

Conditions

object

Condition

array<object>

條件列表。

object

條件列表。

Key

string

條件名。目前可選值:

DiskCategory:盤類型不滿足。

DiskCategory

Status

string

資源的庫存狀態。可能值:

  • Available:資源充足。

  • SoldOut:資源已售罄。

Available

Value

string

資源值。

ecs.g5.large

Max

integer

雲端硬碟容量範圍的最大值。

僅當入參 DestinationResource 取值為 SystemDisk 時該參數才生效。

2048

Unit

string

雲端硬碟容量的單位。

僅當入參 DestinationResource 取值為 SystemDisk 時該參數才生效。

GiB

StatusCategory

string

根據庫存詳細分類資源類別。可能值:

  • WithStock:庫存充足。

  • ClosedWithStock:庫存接近水位低線。

  • WithoutStock:庫存告罄。

WithStock

Min

integer

雲端硬碟容量範圍的最小值。

僅當入參 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.g7.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

錯誤碼

錯誤資訊

描述

400 Invalid.OperationType The specified operationType is not valid.
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.
400 InvalidCondition.Malformed The specified Condition is not valid.
403 InvalidDedicatedHostId.NotFound The specified DedicatedHostId does not exist in our records.
403 InvalidParam.TypeAndCpuMem.Conflict The specified 'InstanceType' and 'Cores','Memory' are not blank at the same time.
403 InvalidParam.Cores The specified parameter 'Cores' should be empty.
403 InvalidParam.Memory The specified parameter 'Memory' should be empty.
403 InvalidParameter.ResourceOwnerId The specified parameter ResourceOwnerId is not available anymore.
404 Invalid.RegionId The specified RegionId does not exist.
404 InvalidRegionId.NotFound The RegionId provided does not exist in our records.
404 Unavailable.Regions The available regions does not exists.
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.
404 Invalid.NetworkCategory The specified NetworkCategory is not valid.
404 Invalid.SpotStrategy The specified SpotStrategy is not valid.
404 Invalid.ResourceId The specified ResourceId is not valid.
404 Invalid.InstancePayType The specified InstancePayType is not valid.
404 Invalid.OperationType The specified OperationType is not valid.
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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情