使用DescribeAvailableResource查詢可用資源資訊-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

查詢指定可用性區域的資源資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeAvailableResource

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
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：ESSD PL1 雲端硬碟。 cloud_essd2：ESSD PL2 雲端硬碟。 cloud_essd3：ESSD PL3 雲端硬碟。 cloud_auto：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

樣本

正常返回樣本

JSON格式

{
  "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"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。