DescribeDBInstancesOverview API參考-ApsaraDB for MongoDB-阿里雲

查詢一個或多個ApsaraDB for MongoDB執行個體的概覽資訊。

介面說明

如果您未指定執行個體的具體資訊，則返回當前帳號的目標地區下所有執行個體的概覽資訊。
該介面返回結果不進行分頁。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeDBInstancesOverview

list

*Instance

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID，您可以調用 DescribeRegions 查詢。	cn-hangzhou
InstanceIds	string	否	需要查詢概覽的執行個體 ID。說明如果不傳入該參數，預設查詢當前阿里雲帳號下的所有執行個體。支援傳入多個執行個體 ID，執行個體 ID 之間以英文逗號（,）分隔。	dds-bp12c5b040dc****
InstanceStatus	string	否	執行個體的狀態資訊，取值詳情請參見執行個體狀態表。	Running
ChargeType	string	否	執行個體的付費類型，取值： PrePaid：預付費，訂用帳戶。 PostPaid：隨用隨付。	PostPaid
NetworkType	string	否	執行個體的網路類型，取值： Classic：傳統網路。 VPC：VPC 網路。	Classic
EngineVersion	string	否	執行個體的引擎版本，取值為 5.0、4.4、 4.2、4.0或 3.4。	4.0
InstanceClass	string	否	執行個體規格。不同類型執行個體的規格分別請參見：單節點執行個體規格表複本集執行個體規格表分區叢集執行個體規格表	dds.mongo.2xlarge
VpcId	string	否	專用網路 ID。	vpc-bp1nme44gek34slfc****
VSwitchId	string	否	虛擬交換器 ID。	vsw-bp1e7clcw529l773d****
InstanceType	string	否	執行個體類型，取值： sharding：分區叢集執行個體。 replicate：複本集執行個體和單節點執行個體。說明請根據實際需求配置，例如您需要查詢分區叢集執行個體的概覽，則配置該參數的值為 sharding。不配置該參數時，預設查詢所有執行個體的概覽。	replicate
ZoneId	string	否	可用性區域 ID。	cn-hangzhou-b
ResourceGroupId	string	否	資源群組 ID。資源群組詳情請參見查看資源群組基本資料。	rg-acfmyiu4ekp****
ShowTags	boolean	否	是否展示執行個體標籤，預設值 false。	false

返回參數

名稱	類型	描述	樣本值
	object	執行個體概覽資訊。
TotalCount	string	查詢結果中執行個體的數量。	1
RequestId	string	請求 ID。	52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA
DBInstances	array<object>	執行個體資訊列表。
	array<object>	執行個體資訊列表。
CreationTime	string	執行個體建立的時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2022-01-05T03:18:53Z
ExpireTime	string	執行個體到期時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。	2022-02-05T16:00Z
Tags	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
LastDowngradeTime	string	執行個體最後一次降配時間。	2021-05-08
ShardList	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
DBInstanceType	string	執行個體類型，取值： sharding：分區叢集執行個體。 replicate：複本集執行個體和單節點執行個體。	replicate
DestroyTime	string	執行個體資料銷毀時間，格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2021-12-10T16:00:00Z
ChargeType	string	執行個體付費類型，取值： PrePaid：預付費，訂用帳戶。 PostPaid：隨用隨付。	PrePaid
CapacityUnit	string	執行個體消耗的讀寫輸送量。說明當執行個體類型為 Serverless 執行個體時返回該參數。僅中國站支援 Serverless 執行個體。	100
VpcAuthMode	string	是否開啟了專用網路免密訪問功能。取值： Open：開啟。 Close：關閉。	Open
DBInstanceStatus	string	執行個體的狀態資訊，取值詳情請參見執行個體狀態表。	Running
NetworkType	string	執行個體網路類型，取值： Classic：傳統網路。 VPC：VPC 網路。	VPC
LockMode	string	執行個體的鎖定狀態。 Unlock：正常。 ManualLock：手動觸發鎖定。 LockByExpiration：執行個體到期自動鎖定。 LockByRestoration：執行個體復原前自動鎖定。 LockByDiskQuota：執行個體空間滿自動鎖定。 Released：執行個體已釋放。此時執行個體無法進行解鎖，只能使用備份資料重新建立新執行個體，重建時間較長，請耐心等待。	Unlock
EngineVersion	string	執行個體的資料庫版本。	4.2
MongosList	array<object>	Mongos 節點資訊列表。說明執行個體類型為分區叢集執行個體時返回該參數。
	object	Mongos 節點資訊列表。說明執行個體類型為分區叢集執行個體時返回該參數。
NodeClass	string	Mongos 節點規格。	dds.mongos.standard
NodeDescription	string	Mongos 節點描述。	測試mongos節點
NodeId	string	Mongos 節點 ID。	s-bp10e3b0d02f****
RegionId	string	執行個體所屬地區 ID。	cn-hangzhou
DBInstanceStorage	integer	執行個體的儲存空間大小，單位為 GB。	20
ResourceGroupId	string	執行個體所屬資源群組 ID。	rg-acfm22cdcgc****
ZoneId	string	執行個體所屬可用性區域。	cn-hangzhou-i
DBInstanceId	string	執行個體 ID。	dds-bp12c5b040dc****
DBInstanceClass	string	執行個體規格。不同類型執行個體的規格分別請參見：單節點執行個體規格表複本集執行個體規格表分區叢集執行個體規格表	dds.mongo.mid
Engine	string	資料庫引擎，取值為 MongoDB。	MongoDB
ReplicationFactor	string	執行個體中節點的個數。說明執行個體類型為複本集執行個體時返回該參數。	3
DBInstanceDescription	string	執行個體的描述或備忘資訊。	測試資料庫
KindCode	string	表示執行個體的類型。取值： 0：物理機 1：ECS 2：DOCKER 18：k8s 新架構執行個體	0

樣本

正常返回樣本

JSON格式

{
  "TotalCount": "1",
  "RequestId": "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
  "DBInstances": [
    {
      "CreationTime": "2022-01-05T03:18:53Z",
      "ExpireTime": "2022-02-05T16:00Z",
      "Tags": [
        {
          "Key": "testdatabase",
          "Value": "apitest"
        }
      ],
      "LastDowngradeTime": "2021-05-08",
      "ShardList": [
        {
          "NodeClass": "dds.shard.mid",
          "NodeDescription": "測試shard節點",
          "NodeStorage": 10,
          "NodeId": "d-bp1cac6f2083****",
          "ReadonlyReplicas": 2
        }
      ],
      "DBInstanceType": "replicate",
      "DestroyTime": "2021-12-10T16:00:00Z",
      "ChargeType": "PrePaid",
      "CapacityUnit": "100",
      "VpcAuthMode": "Open",
      "DBInstanceStatus": "Running",
      "NetworkType": "VPC",
      "LockMode": "Unlock",
      "EngineVersion": "4.2",
      "MongosList": [
        {
          "NodeClass": "dds.mongos.standard",
          "NodeDescription": "測試mongos節點",
          "NodeId": "s-bp10e3b0d02f****"
        }
      ],
      "RegionId": "cn-hangzhou",
      "DBInstanceStorage": 20,
      "ResourceGroupId": "rg-acfm22cdcgc****",
      "ZoneId": "cn-hangzhou-i",
      "DBInstanceId": "dds-bp12c5b040dc****",
      "DBInstanceClass": "dds.mongo.mid",
      "Engine": "MongoDB",
      "ReplicationFactor": "3",
      "DBInstanceDescription": "測試資料庫",
      "KindCode": "0"
    }
  ]
}

錯誤碼

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

變更歷史

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