Query available resources - - Alibaba Cloud ドキュメントセンター

The DescribeAvailableResource operation is no longer be available. You can use the DescribeAvailableZones and DescribeAvailableClasses operations instead.

説明 You can call the DescribeAvailableResource operation up to 20 times within 1 minute.

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目	データ型	必須／任意	例:	説明
操作	String	必須	DescribeAvailableResource	実行する操作です。値は DescribeAvailableResource に設定します。
RegionId	String	任意	cn-hangzhou	インスタンスのリージョン ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。
ZoneId	String	任意	cn-hangzhou-d	インスタンスのゾーン ID。
InstanceChargeType	String	必須	Postpaid	インスタンスの課金方法です。有効な値： Prepaid: subscription Postpaid: pay-as-you-go
Engine	String	任意	MySQL	The database engine of the instance. 有効な値： MySQL SQLServer PostgreSQL MariaDB
EngineVersion	String	任意	5.7	インスタンスのデータベースエンジンバージョンです。 Valid values when you set the Engine parameter to MySQL: 5.5, 5.6, 5.7, and 8.0 Valid values when you set the Engine parameter to SQLServer: 2008r2, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_ent, and 2019_ent Valid values when you set the Engine parameter to PostgreSQL: 9.4, 10.0, 11.0, 12.0, 13.0, and 14.0 Valid values when you set the Engine parameter to MariaDB: 10.3
DBInstanceClass	String	任意	rds.mysql.s1.small	インスタンスのインスタンスタイプ。 For more information, see Primary ApsaraDB RDS instance types.
OrderType	String	任意	BUY	The type of the order. Set the value to BUY.
DBInstanceStorageType	String	任意	local_ssd	インスタンスのストレージタイプを示します。有効な値： local_ssd: local SSD cloud_ssd: standard SSD cloud_essd: enhanced SSD (ESSD) of performance level 1 (PL1) cloud_essd2: ESSD of PL2 cloud_essd3: ESSD of PL3
カテゴリー	String	任意	基本	The RDS edition of the instance. 有効な値： Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition AlwaysOn: RDS Cluster Edition Finance: RDS Enterprise Edition
DispenseMode	Integer	いいえ	0	Specifies whether to return the zones in which the single-zone deployment method is supported. 有効な値： 1: returns the zones. 0: does not return the zones. デフォルト値：0。説明 The single-zone deployment method allows you to deploy an instance that runs RDS Enterprise Edition in a single zone.

レスポンスパラメーター

項目	データ型	例:	説明
RequestId	String	A32E046E-2643-4B65-828D-23FEED4853A3	リクエストの ID です。
AvailableZones	AvailableZone の配列		An array that consists of zones in which resources are available.
AvailableZone
ZoneId	String	cn-hangzhou-d	インスタンスのゾーン ID。
Status	String	有効にする	Indicates whether the resources in the region can be purchased. 有効な値： Enable: The resources in the region can be purchased. Disable: The resources in the region cannot be purchased.
RegionId	String	cn-hangzhou	インスタンスのリージョン ID です。
SupportedEngines	SupportedEngine の配列		An array that consists of the database engines available in the zone.
SupportedEngine
Engine	String	MySQL	The database engine that the instance runs.
SupportedEngineVersions	SupportedEngineVersion の配列		An array that consists of the database engine versions available in the zone.
SupportedEngineVersion
Version	String	5.7	The version of the database engine that is run by the instance.
SupportedCategorys	Array of SupportedCategory		An array that consists of available RDS editions.
SupportedCategory
カテゴリー	String	HighAvailability	The RDS edition of the instance.
SupportedStorageTypes	Array of SupportedStorageType		An array that consists of available storage types.
SupportedStorageType
StorageType	String	local_ssd	インスタンスのストレージタイプを示します。
AvailableResources	AvailableResource の配列		An array that consists of available resources.
AvailableResource
StorageRange	String	"{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}"	The range of the storage capacity. The value consists of the maximum storage capacity, the minimum storage capacity, and the increment to increase the storage capacity.
DBInstanceClass	String	rds.mysql.s1.small	インスタンスのインスタンスタイプ。
DBInstanceStorageRange	オブジェクト		An array that consists of the ranges of storage capacity.
手順	Integer	5	The increment at which the storage capacity increases. 単位 : GB
Max	Integer	2000	The maximum storage capacity that you can purchase. 単位 : GB
最小	Integer	5	The minimum storage capacity that you must purchase. 単位 : GB

例

リクエストの例

http(s)://rds.aliyuncs.com/?Action=DescribeAvailableResource
&InstanceChargeType=Postpaid
&<Common request parameters>

正常に処理された場合のレスポンス例

XML 形式

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

<DescribeAvailableResourceResponse>
    <RequestId>A32E046E-2643-4B65-828D-23FEED4853A3</RequestId>
    <AvailableZones>
        <ZoneId>cn-hangzhou-b</ZoneId>
        <Status>Enable</Status>
        <RegionId>cn-hangzhou</RegionId>
        <SupportedEngines>
            <Engine>MySQL</Engine>
            <SupportedEngineVersions>
                <Version>5.7</Version>
                <SupportedCategorys>
                    <Category>HighAvailability</Category>
                    <SupportedStorageTypes>
                        <StorageType>local_ssd</StorageType>
                        <AvailableResources>
                            <StorageRange>"{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}"</StorageRange>
                            <DBInstanceClass>rds.mysql.s1.small</DBInstanceClass>
                            <DBInstanceStorageRange>
                                <Step>5</Step>
                                <Max>2000</Max>
                                <Min>5</Min>
                            </DBInstanceStorageRange>
                        </AvailableResources>
                    </SupportedStorageTypes>
                </SupportedCategorys>
            </SupportedEngineVersions>
        </SupportedEngines>
    </AvailableZones>
</DescribeAvailableResourceResponse>

JSON 形式

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

{
  "RequestId" : "A32E046E-2643-4B65-828D-23FEED4853A3",
  "AvailableZones" : [ {
    "ZoneId" : "cn-hangzhou-b",
    "Status" : "Enable",
    "RegionId" : "cn-hangzhou",
    "SupportedEngines" : [ {
      "Engine" : "MySQL",
      "SupportedEngineVersions" : [ {
        "Version" : "5.7",
        "SupportedCategorys" : [ {
          "Category" : "HighAvailability",
          "SupportedStorageTypes" : [ {
            "StorageType" : "local_ssd",
            "AvailableResources" : [ {
              "StorageRange" : "\"{\\\"values\\\":[{\\\"max\\\":2000,\\\"min\\\":5,\\\"step\\\":5}]}\"",
              "DBInstanceClass" : "rds.mysql.s1.small",
              "DBInstanceStorageRange" : {
                "Step" : 5,
                "Max" : 2000,
                "Min" : 5
              }
            } ]
          } ]
        } ]
      } ]
    } ]
  } ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ArticleNotFound	Article not found	The error message returned because no relevant articles are found.

エラーコードリストについては、「API エラーセンター」をご参照ください。