全部產品
Search
文件中心

ApsaraDB for MongoDB:DescribeBackupStorage - 查詢執行個體的備份使用量

更新時間:Apr 21, 2026

查詢MongoDB雲端硬碟版複本集或分區叢集的備份使用量。

介面說明

分區叢集備份用量的計費規則是每個分區單獨計費,本介面只支援查詢單分區的備份用量。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeBackupStorage

get

*Instance

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

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

執行個體所屬的地區 ID,您可以通過調用 DescribeDBInstanceAttribute 進行查詢。

cn-bejing

DBInstanceId

string

執行個體 ID。

dds-2zeb2d64cb46xxxx

NodeId

string

分區叢集執行個體中 Shard 節點 ID。

說明

DBInstanceId 參數傳入的是分區叢集執行個體 ID 時,本參數為必填。

d-2zee48956b4axxxx

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

D648B367-15B6-1B42-BD4B-4XXXXXXXXX

FullStorageSize

integer

執行個體全量備份資料內建儲存量,單位為位元組(B)。

說明

雲端硬碟版執行個體使用快照備份,當前全量的備份的大小為快照鏈的大小。

789221621

LogStorageSize

integer

執行個體記錄備份資料內建儲存量,單位為位元組(B)。

7892216

FreeSize

integer

執行個體免費備份資料額度,單位為位元組(B)。

42949672960

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D648B367-15B6-1B42-BD4B-4XXXXXXXXX",
  "FullStorageSize": 789221621,
  "LogStorageSize": 7892216,
  "FreeSize": 42949672960
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidDBInstance.Malformed Too many instance ids or instance id format is invalid.

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

變更歷史

更多資訊,參考變更詳情