DescribeAvailableResource による利用可能なリソースのクエリ - MongoDB

指定されたゾーンで利用可能なリソースをクエリします。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeAvailableResource

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。DescribeRegions 操作を呼び出して、利用可能な最新のリージョンをクエリできます。	cn-hangzhou
ZoneId	string	任意	ゾーン ID。DescribeRegions 操作を呼び出して、利用可能なゾーンをクエリできます。	cn-hangzhou-h
InstanceChargeType	string	任意	インスタンスの課金方法。有効な値： PrePaid (デフォルト)：サブスクリプション PostPaid：従量課金	PrePaid
DbType	string	任意	インスタンスのアーキテクチャ。有効な値： normal：レプリカセットインスタンス sharding：シャードクラスターインスタンス	sharding
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmyiu4ekp****
StorageType	string	任意	インスタンスのストレージタイプ。有効な値： local_ssd：ローカル SSD cloud_essd1：PL1 高性能 SSD (ESSD) cloud_essd2：PL2 ESSD cloud_essd3：PL3 ESSD cloud_auto：ESSD AutoPL ディスクこのパラメーターはデフォルトで空です。空の場合、すべてのタイプのストレージリソースがクエリされます。	local_ssd
DBInstanceClass	string	任意	インスタンスのインスタンスタイプ。	dds.mongo.standard
EngineVersion	string	任意	インスタンスのメジャーエンジンバージョン。	5.0
ReplicationFactor	string	任意	ノード数。レプリカセットにのみ適用されます。列挙値: 1 : 1 3 : 3 5 : 5 7 : 7	3

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	344EE51D-8850-4935-B68B-58A8F4DCE3BD
SupportedDBTypes	object
SupportedDBType	array<object>	サポートされているデータベースタイプ。
	array<object>
AvailableZones	object
AvailableZone	array<object>	利用可能なゾーン。
	array<object>
SupportedEngineVersions	object
SupportedEngineVersion	array<object>	サポートされているストレージエンジンバージョン。
	array<object>
SupportedEngines	object
SupportedEngine	array<object>	サポートされているストレージエンジン。
	array<object>
SupportedNodeTypes	object
SupportedNodeType	array<object>	サポートされているインスタンスタイプ。
	array<object>
NodeType	string	インスタンス内のノード数。	3
NetworkTypes	string	インスタンスのネットワークタイプ。	VPC
AvailableResources	object
AvailableResource	array<object>	利用可能なリソースの詳細。
	array<object>
InstanceClassRemark	string	インスタンスのタイプ。	4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））
InstanceClass	string	インスタンスファミリー。	mdb.shard.2x.xlarge.d
DBInstanceStorageRange	object	インスタンスのストレージ容量範囲。
Min	integer	最小ストレージ容量。単位：GB。	20
Max	integer	最大ストレージ容量。単位：GB。	16000
Step	integer	ストレージ容量を調整するためのステップサイズ。単位：GB。	10
Engine	string	インスタンスのストレージエンジン。	WiredTiger
Version	string	インスタンスのデータベースエンジンバージョン。	4.0
ZoneId	string	ゾーン ID。	cn-hangzhou-h
RegionId	string	リージョン ID。	cn-hangzhou
DbType	string	インスタンスのアーキテクチャ。有効な値： normal：レプリカセットインスタンス sharding：シャードクラスターインスタンス	sharding

例

成功レスポンス

JSONJSON

{
  "RequestId": "344EE51D-8850-4935-B68B-58A8F4DCE3BD",
  "SupportedDBTypes": {
    "SupportedDBType": [
      {
        "AvailableZones": {
          "AvailableZone": [
            {
              "SupportedEngineVersions": {
                "SupportedEngineVersion": [
                  {
                    "SupportedEngines": {
                      "SupportedEngine": [
                        {
                          "SupportedNodeTypes": {
                            "SupportedNodeType": [
                              {
                                "NodeType": "3",
                                "NetworkTypes": "VPC",
                                "AvailableResources": {
                                  "AvailableResource": [
                                    {
                                      "InstanceClassRemark": "4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））",
                                      "InstanceClass": "mdb.shard.2x.xlarge.d",
                                      "DBInstanceStorageRange": {
                                        "Min": 20,
                                        "Max": 16000,
                                        "Step": 10
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          },
                          "Engine": "WiredTiger"
                        }
                      ]
                    },
                    "Version": "4.0"
                  }
                ]
              },
              "ZoneId": "cn-hangzhou-h",
              "RegionId": "cn-hangzhou"
            }
          ]
        },
        "DbType": "sharding"
      }
    ]
  }
}

エラーコード

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

変更履歴

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