查詢一個或多個云數據庫MongoDB實例的概覽信息。
接口說明
-
如果您未指定實例的具體信息，則返回當前賬號的目標地域下所有實例的概覽信息。
-
該接口返回結果不進行分頁。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dds:DescribeDBInstancesOverview | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID，您可以調用 DescribeRegions 查詢。 | cn-hangzhou |
| InstanceIds | string | 否 | 需要查詢概覽的實例 ID。 說明
| dds-bp12c5b040dc**** |
| InstanceStatus | string | 否 | 實例的狀態信息，取值詳情請參見實例狀態表。 | Running |
| ChargeType | string | 否 | 實例的付費類型，取值：
| PostPaid |
| NetworkType | string | 否 | 實例的網絡類型，取值：
| 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 | 否 | 實例類型，取值：
說明
| replicate |
| ZoneId | string | 否 | 可用區 ID。 | cn-hangzhou-b |
| ResourceGroupId | string | 否 | 資源組 ID。資源組詳情請參見查看資源組基本信息。 | rg-acfmyiu4ekp**** |
返回參數
示例
正常返回示例
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"
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2022-01-11 | 新增 OpenAPI | 查看變更詳情 |