DescribeAvailableResource - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

指定されたゾーンで作成可能な Tair (Redis OSS-compatible) インスタンスのタイプをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeAvailableResource

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID です。最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出します。	cn-hangzhou
ZoneId	string	任意	インスタンスのゾーン ID です。最新のゾーン一覧を照会するには、DescribeZones 操作を呼び出します。	cn-hangzhou-h
InstanceChargeType	string	任意	課金方法です。有効な値は以下のとおりです。 PrePaid（デフォルト）：サブスクリプション PostPaid：従量課金	PrePaid
OrderType	string	任意	注文タイプです。有効な値は以下のとおりです。 BUY（デフォルト）：インスタンス作成用の注文 UPGRADE：インスタンスのスペックアップ用の注文 DOWNGRADE：インスタンスのスペックダウン用の注文	BUY
Engine	string	任意	インスタンスのデータベースエンジンです。有効な値は以下のとおりです。 Redis Memcache	Redis
ResourceGroupId	string	任意	インスタンスが属するリソースグループの ID です。リソースグループの ID を照会するには、ListResourceGroups 操作を呼び出します。説明また、Resource Management コンソールからリソースグループの ID を照会することもできます。詳細については、「リソースグループの基本情報を表示する」をご参照ください。	rg-acfmyiu4e******
InstanceId	string	任意	インスタンスの ID です。説明このパラメーターは、OrderType パラメーターが UPGRADE または DOWNGRADE に設定されている場合にのみ使用可能で、必須となります。	r-bp1zxszhcgatnx****
AcceptLanguage	string	任意	応答の表示言語です。有効な値は以下のとおりです。 zh-CN：中国語（デフォルト） en-US：英語	zh-CN
ProductType	string	任意	インスタンスタイプです。デフォルト値は Local です。有効な値は以下のとおりです。 Local：クラシック Redis Community Edition インスタンス、またはクラシック DRAM ベースのインスタンス Tair_rdb：クラウドネイティブ DRAM ベースのインスタンス Tair_scm：永続メモリインスタンス Tair_essd：ESSD／SSD ベースのインスタンス OnECS：クラウドネイティブ Redis Community Edition インスタンス説明このパラメーターのデフォルト値は Local です。ディスクリソースを照会するには、必要なディスクリソースを提供するインスタンスタイプを指定する必要があります。	Local
NodeId	string	任意	作成可能なリソースを照会する対象となるデータノードの ID です。データノードの ID を照会するには、DescribeLogicInstanceTopology 操作を呼び出します。戻り値からシャープ記号（`#`）およびその後に続く内容を削除してください。たとえば、`r-bp10noxlhcoim2**-db-0` のみを残します。説明このパラメーターを指定する前に、InstanceId** パラメーターをクラスターアーキテクチャまたは読み書き分離アーキテクチャを使用するインスタンスの ID に設定する必要があります。	r-bp1zxszhcgatnx****-db-0
InstanceScene	string	任意	インスタンスのエディションです。有効な値は以下のとおりです。 professional：Standard Edition。スタンドアロン、マスターレプリカ、読み書き分離、クラスターアーキテクチャをサポートし、優れた拡張性を提供します。	professional

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	493B7308-D9C2-55F6-B042-0313BD63****
AvailableZones	object
AvailableZone	array<object>	ゾーンの詳細情報です。
	array<object>
ZoneId	string	インスタンスが配置されているゾーンの ID です。	cn-hangzhou-h
ZoneName	string	ゾーンの名前です。	杭州可用区H
RegionId	string	リージョンの ID です。	cn-hangzhou
SupportedEngines	object
SupportedEngine	array<object>	サポートされているエンジンです。
	array<object>
Engine	string	インスタンスのデータベースエンジンです。	Redis
SupportedEditionTypes	object
SupportedEditionType	array<object>	インスタンスのエディションタイプです。
	array<object>
EditionType	string	インスタンスのエディションです。有効な値は次のとおりです。 Community：Community Edition Enterprise：Enhanced Edition (Tair)	Enterprise
SupportedSeriesTypes	object
SupportedSeriesType	array<object>	インスタンスのシリーズタイプです。
	array<object>
SeriesType	string	インスタンスのシリーズです。有効な値は次のとおりです。 enhanced_performance_type：Tair (Enterprise Edition) DRAM ベースインスタンス hybrid_storage：Redis Open-Source Edition ハイブリッドストレージ型インスタンス	enhanced_performance_type
SupportedEngineVersions	object
SupportedEngineVersion	array<object>	利用可能なエンジンバージョンです。
	array<object>
Version	string	インスタンスのエンジンバージョンです。	5.0
SupportedArchitectureTypes	object
SupportedArchitectureType	array<object>	利用可能なアーキテクチャです。
	array<object>
Architecture	string	インスタンスのアーキテクチャです。有効な値は次のとおりです。 standard：標準アーキテクチャ cluster：クラスタアーキテクチャ rwsplit：読み書き分離アーキテクチャ	cluster
SupportedShardNumbers	object
SupportedShardNumber	array<object>	利用可能なシャード数です。
	array<object>
ShardNumber	string	シャード数です。	8
SupportedNodeTypes	object
SupportedNodeType	array<object>	サポートされているノードタイプです。
	array<object>	サポートされているノードタイプです。
SupportedNodeType	string	インスタンスのノードタイプです。有効な値は次のとおりです。 single：スタンドアロン double：マスター・レプリカ	double
AvailableResources	object
AvailableResource	array<object>	利用可能なインスタンスタイプです。
	object	利用可能なインスタンスタイプです。
InstanceClassRemark	string	インスタンスタイプの説明です。	16G集群版（8节点）（QPS:1920000 Connections:240000）
Capacity	integer	インスタンスのメモリサイズです。単位：MB。	16384
InstanceClass	string	インスタンスタイプのコードです。インスタンスタイプのコードを表示するには、ヘルプセンターで該当のインスタンスタイプコードを検索できます。	redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread
IsMainSale	boolean	内部パラメーターです。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "493B7308-D9C2-55F6-B042-0313BD63****",
  "AvailableZones": {
    "AvailableZone": [
      {
        "ZoneId": "cn-hangzhou-h",
        "ZoneName": "杭州 可用区H",
        "RegionId": "cn-hangzhou",
        "SupportedEngines": {
          "SupportedEngine": [
            {
              "Engine": "Redis",
              "SupportedEditionTypes": {
                "SupportedEditionType": [
                  {
                    "EditionType": "Enterprise",
                    "SupportedSeriesTypes": {
                      "SupportedSeriesType": [
                        {
                          "SeriesType": "enhanced_performance_type",
                          "SupportedEngineVersions": {
                            "SupportedEngineVersion": [
                              {
                                "Version": "5.0",
                                "SupportedArchitectureTypes": {
                                  "SupportedArchitectureType": [
                                    {
                                      "Architecture": "cluster",
                                      "SupportedShardNumbers": {
                                        "SupportedShardNumber": [
                                          {
                                            "ShardNumber": "8",
                                            "SupportedNodeTypes": {
                                              "SupportedNodeType": [
                                                {
                                                  "SupportedNodeType": "double",
                                                  "AvailableResources": {
                                                    "AvailableResource": [
                                                      {
                                                        "InstanceClassRemark": "16G集群版（8节点）（QPS:1920000 Connections:240000）",
                                                        "Capacity": 16384,
                                                        "InstanceClass": "redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread"
                                                      }
                                                    ]
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        },
        "IsMainSale": true
      }
    ]
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。