DescribeDBInstances - 查詢MongoDB執行個體列表 -

查詢MongoDB執行個體列表。

介面說明

該介面預設查詢複本集執行個體（包含單節點執行個體）列表，即未配置請求參數 DBInstanceType 時，該參數的預設值為 replicate。如果您需要查詢分區叢集執行個體列表，請配置 DBInstanceType 的值為 sharding。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeDBInstances

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/*

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID，您可以調用 DescribeRegions 介面查詢地區 ID。	cn-hangzhou
PageNumber	integer	否	頁碼，取值為大於 0 且不超過整數資料類型的最大值，預設值為 1。	1
PageSize	integer	否	每頁記錄數，取值： 30（預設值） 50 100	30
DBInstanceId	string	否	執行個體 ID。	dds-bp199659b178****
ReplicationFactor	string	否	複本集執行個體的節點數量，取值： 3 5 7	3
DBInstanceDescription	string	否	執行個體名稱，取值說明：以中文、英文字母開頭。可以包含數字、中文、英文、底線（_）和虛線（-）。長度為 2~256 個字元。	測試資料庫
ExpireTime	string	否	執行個體的到期時間,格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。用於篩選到期時間小於等於該時間的執行個體。	2019-12-26T16:00:00Z
DBInstanceStatus	string	否	執行個體的狀態資訊，取值詳情請參見執行個體狀態表。	Running
DBInstanceType	string	否	執行個體類型，取值說明： sharding：分區叢集執行個體。 replicate：預設值，複本集執行個體和單節點執行個體。	sharding
DBInstanceClass	string	否	執行個體規格，取值詳情請參見執行個體規格表。	dds.mongo.mid
Engine	string	否	資料庫引擎，取值為 MongoDB。	MongoDB
EngineVersion	string	否	資料庫版本號碼，取值： 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.0
NetworkType	string	否	執行個體網路類型，取值說明： Classic：傳統網路。 VPC：VPC 網路。	VPC
VpcId	string	否	專用網路 ID。	vpc-bp1n3i15v90el48nx****
VSwitchId	string	否	專用網路的交換器 ID。	vsw-bp1vj604nj5a9zz74****
ChargeType	string	否	執行個體付費類型，取值說明： PrePaid：預付費，訂用帳戶。 PostPaid：隨用隨付。	PrePaid
ZoneId	string	否	可用性區域 ID，您可以通過調用 DescribeRegions 介面查詢可用性區域 ID。	cn-hangzhou-b
Expired	string	否	執行個體到期狀態，取值說明： true：已到期。 false：未到期。	true
ConnectionDomain	string	否	節點的串連地址，您可以通過調用 DescribeDBInstanceAttribute 介面查詢。	dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com
ResourceGroupId	string	否	資源群組 ID。	rg-acfmyiu4ekp****
Tag	array<object>	否	標籤管理。
	object	否
Key	string	否	執行個體的標籤鍵。N 的取值範圍為 1~20。不能以`aliyun`、`acs:`、`http://`或`https://`開頭。最多支援 64 個字元。不允許傳入Null 字元串。	testdatabase
Value	string	否	執行個體的標籤值。N 的取值範圍為 1~20。不能以`aliyun`、`acs`:、`http://`或`https://`開頭。最多支援 128 個字元。 TagValue 可以為空白。	apitest
DBNodeType	string	否	用於篩選標準執行個體還是測試執行個體單節點執行個體和 dbfs 執行個體：customized 標準執行個體（複本集和分區叢集）：standard 預設（展示全部執行個體）：default	default

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	查詢結果中執行個體的數量。	5
RequestId	string	請求 ID。	0E4FE33F-5510-5758-8FA7-A6672CDE****
PageSize	integer	每頁記錄數。	30
PageNumber	integer	頁碼。	1
DBInstances	object
DBInstance	array<object>	執行個體資訊列表。
	array<object>
CreationTime	string	執行個體建立的時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2021-03-25T02:18:00Z
ChargeType	string	執行個體付費類型，取值說明： PrePaid：預付費，訂用帳戶。 PostPaid：隨用隨付。	PrePaid
Tags	object
Tag	array<object>	資源標籤資訊列表。
	object	資源標籤資訊列表。
Key	string	資源的標籤鍵。	test
Value	string	資源的標籤值。	api
VpcAuthMode	string	是否開啟了專用網路免密訪問功能，取值說明： Open：開啟。 Close：關閉。	Close
NetworkType	string	執行個體網路類型，取值說明： Classic：傳統網路。 VPC：專用網路。	Classic
LockMode	string	執行個體的鎖定狀態，取值說明： Unlock：正常。 ManualLock：手動觸發鎖定。 LockByExpiration：執行個體到期自動鎖定。 LockByRestoration：執行個體復原前自動鎖定。 LockByDiskQuota：執行個體空間滿自動鎖定。 Released：執行個體已釋放。此時執行個體無法進行解鎖，只能使用備份資料重新建立新執行個體，重建時間較長，請耐心等待。	Unlock
EngineVersion	string	資料庫版本號碼，取值： 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
MongosList	object
MongosAttribute	array<object>	Mongos 節點資訊列表。說明執行個體類型為分區叢集執行個體時，返回該參數。
	object	Mongos 節點資訊列表。說明執行個體類型為分區叢集執行個體時，返回該參數。
NodeClass	string	Mongos 節點規格。	dds.mongos.standard
NodeDescription	string	Mongos 節點描述。	測試mongos節點
NodeId	string	Mongos 節點 ID。	s-bp10e3b0d02f****
DBInstanceDescription	string	執行個體的描述或備忘資訊。	測試資料庫
ExpireTime	string	執行個體到期時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。	2021-11-25T16:00Z
DBInstanceType	string	執行個體類型，取值說明： sharding：分區叢集執行個體。 replicate：複本集執行個體和單節點執行個體。	sharding
LastDowngradeTime	string	執行個體最後一次降配時間。	2021-05-08
ShardList	object
ShardAttribute	array<object>	Shard 節點資訊列表。說明執行個體類型為分區叢集執行個體時返回該參數。
	object	Shard 節點資訊列表。說明執行個體類型為分區叢集執行個體時返回該參數。
NodeClass	string	Shard 節點的執行個體規格。	dds.shard.mid
NodeDescription	string	Shard 節點描述。	測試shard節點
NodeStorage	integer	Shard 節點的儲存空間，單位為 GB。	10
NodeId	string	Shard 節點 ID。	d-bp1cac6f2083****
ReadonlyReplicas	integer	Shard 節點中唯讀節點的個數。傳回值範圍：0~5。	2
DestroyTime	string	執行個體資料銷毀時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明訂用帳戶執行個體，到期後第 16 天計算資源會被釋放，資料繼續保留 7 天，到期後第 23 天，資料會被刪除且無法恢複。隨用隨付執行個體，欠費後第 16 天計算資源會被釋放，資料繼續保留 7 天，欠費後第 23 天，資料會被刪除且無法恢複。	2021-12-10T16:00:00Z
DBInstanceStatus	string	執行個體狀態，詳情請參見執行個體狀態表。	Running
RegionId	string	執行個體所屬地區 ID。	cn-hangzhou
DBInstanceStorage	integer	執行個體儲存空間。	20
ResourceGroupId	string	資源群組 ID。	rg-acfmyiu4ekp****
ZoneId	string	執行個體所屬可用性區域 ID。	cn-hangzhou-g
DBInstanceId	string	執行個體 ID。	dds-bp18b0934e70****
DBInstanceClass	string	執行個體規格。	dds.mongo.mid
Engine	string	資料庫引擎。	MongoDB
ReplicationFactor	string	執行個體中節點的個數。說明執行個體類型為複本集執行個體時返回該參數。	3
KindCode	string	執行個體的類型，取值說明： 0：物理機。 1：ECS。 2：DOCKER。 18：k8s 新架構執行個體。	1
CapacityUnit	string	執行個體消耗的讀寫輸送量。說明當執行個體類型為 Serverless 執行個體時返回該參數。	100
StorageType	string	儲存類型，取值說明： cloud_essd：ESSD 雲端硬碟。 local_ssd：SSD 本地碟。	local_ssd
SecondaryZoneId	string	實現多可用性區域部署時，執行個體的備可用性區域 1，取值說明： cn-hangzhou-g：杭州可用性區域 G。 cn-hangzhou-h：杭州可用性區域 H。 cn-hangzhou-i：杭州可用性區域 I。 cn-hongkong-b：香港可用性區域 B。 cn-hongkong-c：香港可用性區域 C。 cn-hongkong-d：香港可用性區域 D。 cn-wulanchabu-a：烏蘭察布可用性區域 A。 cn-wulanchabu-b：烏蘭察布可用性區域 B。 cn-wulanchabu-c：烏蘭察布可用性區域 C。 ap-southeast-1a：新加坡可用性區域 A。 ap-southeast-1b：新加坡可用性區域 B。 ap-southeast-1c：新加坡可用性區域 C。 ap-southeast-5a：雅加達可用性區域 A。 ap-southeast-5b：雅加達可用性區域 B。 ap-southeast-5c：雅加達可用性區域 C。 eu-central-1a：法蘭克福可用性區域 A。 eu-central-1b：法蘭克福可用性區域 B。 eu-central-1c：法蘭克福可用性區域 C。說明當執行個體為 4.4 或 5.0 版本的多可用性區域複本集執行個體或分區叢集執行個體時，返回該參數。目前僅中國站支援返回該參數。	cn-hangzhou-i
HiddenZoneId	string	實現多可用性區域部署時，執行個體的備可用性區域 2，取值說明： cn-hangzhou-g：杭州可用性區域 G。 cn-hangzhou-h：杭州可用性區域 H。 cn-hangzhou-i：杭州可用性區域 I。 cn-hongkong-b：香港可用性區域 B。 cn-hongkong-c：香港可用性區域 C。 cn-hongkong-d：香港可用性區域 D。 cn-wulanchabu-a：烏蘭察布可用性區域 A。 cn-wulanchabu-b：烏蘭察布可用性區域 B。 cn-wulanchabu-c：烏蘭察布可用性區域 C。 ap-southeast-1a：新加坡可用性區域 A。 ap-southeast-1b：新加坡可用性區域 B。 ap-southeast-1c：新加坡可用性區域 C。 ap-southeast-5a：雅加達可用性區域 A。 ap-southeast-5b：雅加達可用性區域 B。 ap-southeast-5c：雅加達可用性區域 C。 eu-central-1a：法蘭克福可用性區域 A。 eu-central-1b：法蘭克福可用性區域 B。 eu-central-1c：法蘭克福可用性區域 C。說明當執行個體為 4.4 或 5.0 版本的多可用性區域複本集執行個體或分區叢集執行個體時，返回該參數。目前僅中國站支援返回該參數。	cn-hangzhou-h
BackupRetentionPolicy	integer	備份保留原則，取值如下： 0：執行個體釋放時立即刪除該執行個體的所有備份組。 1：執行個體釋放時會自動備份，長期保留該備份組。 2：執行個體釋放時會自動備份，並長期保留該叢集的所有備份組。	1
ReleaseTime	string	執行個體釋放時間。	2024-06-17T07:01Z

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 5,
  "RequestId": "0E4FE33F-5510-5758-8FA7-A6672CDE****",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2021-03-25T02:18:00Z",
        "ChargeType": "PrePaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Close",
        "NetworkType": "Classic",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "MongosList": {
          "MongosAttribute": [
            {
              "NodeClass": "dds.mongos.standard",
              "NodeDescription": "測試mongos節點",
              "NodeId": "s-bp10e3b0d02f****"
            }
          ]
        },
        "DBInstanceDescription": "測試資料庫",
        "ExpireTime": "2021-11-25T16:00Z",
        "DBInstanceType": "sharding",
        "LastDowngradeTime": "2021-05-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "NodeClass": "dds.shard.mid",
              "NodeDescription": "測試shard節點",
              "NodeStorage": 10,
              "NodeId": "d-bp1cac6f2083****",
              "ReadonlyReplicas": 2
            }
          ]
        },
        "DestroyTime": "2021-12-10T16:00:00Z",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 20,
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp18b0934e70****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReplicationFactor": "3",
        "KindCode": "1",
        "CapacityUnit": "100",
        "StorageType": "local_ssd",
        "SecondaryZoneId": "cn-hangzhou-i",
        "HiddenZoneId": "cn-hangzhou-h",
        "BackupRetentionPolicy": 1,
        "ReleaseTime": "2024-06-17T07:01Z"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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