利用可能な Apsara PolarDB クラスターのリソースを照会する操作です。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定することができます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須事項 説明
Action String いいえ DescribeDBClusterAvailableResources

実行する操作。 値を DescribeDBClusterAvailableResources に設定します。

PayType String はい Postpaid

課金方法。 設定可能な値は以下のとおりです。

  • Postpaid: 従量課金
  • Prepaid: サブスクリプション
DBType String いいえ MySQL

管理するデータベースのエンジン。 設定可能な値は以下のとおりです。

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String いいえ 5.6

データベースエンジンのバージョン。

MySQLの有効値:

  • 5.6
  • 8.0

PostgreSQL の有効値:

  • 11

Oracle の有効値:

  • 11
DBNodeClass String いいえ polar.mysql.x4.large

利用可能なノードの仕様。 詳細は、「仕様と料金 (Specifications and pricing)」をご参照ください。

RegionId String いいえ cn-hangzhou

Apsara PolarDB クラスターのリージョン ID。

最新のリージョンリストを照会するときは「 DescribeRegions」を呼び出します。
ZoneId String いいえ cn-hangzhou-i

利用可能なノードのゾーン ID。

最新のゾーンリストを照会するときは「 DescribeRegions」を呼び出します。

レスポンスパラメーター

パラメーター データ型 説明
RequestId String 47510E32-E16C-4561-A380-4EBFC667716F

リクエストの ID。

AvailableZones Array

使用可能なリソースのリスト。

RegionId String cn-hangzhou

Apsara PolarDB クラスターのリージョン ID。

ZoneId String cn-hangzhou-i

利用可能なノードのゾーン ID。

SupportedEngines Array

使用可能なエンジンのリスト。

Engine String MySQL5.6

データベースエンジンのバージョン。

AvailableResources Array

使用可能なリソースのリスト。

DBNodeClass String polar.mysql.x4.large

利用可能なノードの仕様。

コーディング例

リクエスト例

http(s)://[Endpoint]/? Action=DescribeDBClusterAvailableResources
&PayType=Postpaid
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式

<RequestId>47510E32-E16C-4561-A380-4EBFC667716F</RequestId>
<AvailableZones>
    <RegionId>cn-hangzhou</RegionId>
    <ZoneId>cn-hangzhou-i</ZoneId>
    <SupportedEngines>
        <AvailableResources>
            <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
        </AvailableResources>
        <Engine>MySQL5.6</Engine>
    </SupportedEngines>
</AvailableZones>

JSON 形式

{
    "RequestId": "47510E32-E16C-4561-A380-4EBFC667716F",
    "AvailableZones": [
        {
            "RegionId": "cn-hangzhou",
            "ZoneId": "cn-hangzhou-i",
            "SupportedEngines": [
                {
                    "AvailableResources": [
                        {
                            "DBNodeClass": "polar.mysql.x4.large"
                        }
                    ],
                    "Engine": "MySQL5.6"
                }
            ]
        }
    ]
}

エラーコード

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