指定したゾーンで作成可能な ApsaraDB for Redis インスタンスのタイプをクエリします。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 DescribeAvailableResource

実行する操作です。 値は DescribeAvailableResource に設定します。

RegionId String 必須 cn-hangzhou

インスタンスのリージョン ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

ZoneId String 任意 cn-hangzhou-h

インスタンスのゾーン ID です。 DescribeRegions を呼び出して、最新のゾーンリストをクエリできます。

InstanceChargeType String 任意 PrePaid

インスタンスの課金方法です。 デフォルト値は Prepaid です。 設定可能な値は以下のとおりです。

  • PrePaid:サブスクリプション
  • PostPaid: 従量課金
DBType String 任意 sharding

インスタンスのデータベースエンジンタイプです。

  • normal:レプリカセットインスタンス
  • sharding:シャードクラスターインスタンス
ResourceGroupId String 任意 rg-acfmyiu4ekp****

リソースグループの ID です。

レスポンスパラメーター

パラメーター データ型 説明
RequestId String 344EE51D-8850-4935-B68B-58A8F4DCE3BD

リクエストの ID です。

SupportedDBTypes SupportedDBType の配列

使用可能なデータベースタイプです。

SupportedDBType
AvailableZones AvailableZone の配列

使用可能なゾーンです。

AvailableZone
SupportedEngineVersions SupportedEngineVersion の配列

使用可能なストレージエンジンのバージョンです。

SupportedEngineVersion
SupportedEngines SupportedEngine の配列

使用可能なストレージエンジンです。

SupportedEngine
SupportedNodeTypes SupportedNodeType の配列

使用可能なインスタンスタイプです。

SupportedNodeType
NodeType String 3

インスタンス内のノード数です。

NetworkTypes String VPC

インスタンスのネットワークタイプです。

AvailableResources AvailableResource の配列

利用可能なリソースの詳細です。

AvailableResource
InstanceClassRemark String 8 cores, 32 GB (maximum connections: 8000, maximum IOPS: 14000)

インスタンスの仕様です。

InstanceClass String dds.mongo.2xlarge

インスタンスタイプです。

Engine String WiredTiger

インスタンスのストレージエンジンです。

Version String 4.0

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

ZoneId String cn-hangzhou-h

インスタンスのゾーン ID です。

RegionId String cn-hangzhou

インスタンスのリージョン ID です。

DBType String sharding

インスタンスのデータベースエンジンタイプです。

リクエストの例

http(s)://mongodb.aliyuncs.com/?Action=DescribeAvailableResource
&RegionId=cn-hangzhou
&<Common request parameters>

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

XML 形式

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

<DescribeAvailableResourceResponse>
    <RequestId>344EE51D-8850-4935-B68B-58A8F4DCE3BD</RequestId>
    <SupportedDBTypes>
        <AvailableZones>
            <SupportedEngineVersions>
                <SupportedEngines>
                    <SupportedNodeTypes>
                        <NodeType>3</NodeType>
                        <NetworkTypes>VPC</NetworkTypes>
                        <AvailableResources>
                            <InstanceClassRemark>8 cores, 32 GB (maximum connections: 8000, maximum IOPS: 14000)</InstanceClassRemark>
                            <InstanceClass>dds.mongo.2xlarge</InstanceClass>
                        </AvailableResources>
                    </SupportedNodeTypes>
                    <Engine>WiredTiger</Engine>
                </SupportedEngines>
                <Version>4.0</Version>
            </SupportedEngineVersions>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <RegionId>cn-hangzhou</RegionId>
        </AvailableZones>
        <DbType>sharding</DbType>
    </SupportedDBTypes>
</DescribeAvailableResourceResponse>

JSON 形式

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

{
  "RequestId" : "344EE51D-8850-4935-B68B-58A8F4DCE3BD",
  "SupportedDBTypes" : [ {
    "AvailableZones" : [ {
      "SupportedEngineVersions" : [ {
        "SupportedEngines" : [ {
          "SupportedNodeTypes" : [ {
            "NodeType" : "3",
            "NetworkTypes" : "VPC",
            "AvailableResources" : [ {
              "InstanceClassRemark" : "8 cores, 32 GB (maximum connections: 8000, maximum IOPS: 14000)",
              "InstanceClass" : "dds.mongo.2xlarge"
            } ]
          } ],
          "Engine" : "WiredTiger"
        } ],
        "Version" : "4.0"
      } ],
      "ZoneId" : "cn-hangzhou-h",
      "RegionId" : "cn-hangzhou"
    } ],
    "DbType" : "sharding"
  } ]
}

エラーコード

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