DescribeClusterBackups - 查詢叢集備份組列表 -

查詢ApsaraDB for MongoDB雲端硬碟版分區叢集的叢集備份組列表。

介面說明

2023 年 10 月 19 日前建立的雲端硬碟版分區叢集執行個體，在調用前本介面前，需要調用 TransferClusterBackup 介面，完成分區備份到叢集備份的轉換。

2023 年 10 月 19 日之後建立的雲端硬碟版分區叢集執行個體，預設使用叢集備份。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeClusterBackups

get

*Instance

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。	dds-bp16cb162771****
BackupId	string	否	叢集備份 ID。	5664****
PageNo	integer	否	分頁頁號。預設值為 1，取值範圍為正整數。	1
PageSize	integer	否	每頁記錄數，取值： 30（預設值） 50 100	30
StartTime	string	否	查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。說明當傳入 BackupId 時，此參數無效。	2019-03-13T12:11Z
EndTime	string	否	查詢結束時間，必須晚於查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。說明當傳入 BackupId 時，此參數無效。	2019-03-14T13:10Z
IsOnlyGetClusterBackUp	boolean	否	是否查詢叢集備份下的子節點資訊。取值說明： true：只返回叢集備份基本資料，不返回全量的子節點的備份資訊。 false（預設）：返回全量的子節點的備份資訊。	true
SrcRegion	string	否	執行個體所在地區。說明查詢已釋放執行個體的備份組列表式，該參數必填。查詢異地備份時，該參數必填。	cn-hangzhou
DestRegion	string	否	異地備份所在地區。說明查詢異地備份時，該參數必填。	cn-shanghai
ResourceGroupId	string	否	資源群組 ID。	rg-xxxx
BackupJobId	string	否	備份任務 ID。	775051

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	2F42BB4E-461F-5B55-A37C-53B1141C****
MaxResults	integer	本次請求所返回的最大記錄條數。	10
PageNumber	integer	頁碼。	1
PageSize	integer	每頁最大記錄數量。	30
ClusterBackups	array<object>	叢集備份組列表，一個叢集備份裡麵包含各個節點的備份組。
	array<object>	叢集備份組列表，一個叢集備份裡麵包含各個節點的備份組。
IsAvail	integer	叢集備份組是否有效，取值說明： 1：叢集的備份組有效。 0：子節點的備份組未完成或者失敗。	1
ClusterBackupId	string	叢集備份組 ID。	cb-o8c2ugnxo26kx***
ClusterBackupStatus	string	叢集備份組狀態。	OK
ClusterBackupStartTime	string	叢集備份開始時間。	2023-10-16T19:33:20Z
ClusterBackupSize	string	叢集備份組大小，單位為 Byte。	107374182400
ClusterBackupEndTime	string	叢集備份結束時間。	2023-10-16T19:33:20Z
ClusterBackupMode	string	叢集備份模式。	Automated
ExtraInfo	object	補充資訊，為 JSON 格式。
RegistryFromHistory	string	是否來自於歷史備份組，為 1 則表示是從歷史備份組遷移過來的。	1
Backups	array<object>	單個叢集備份組下，各個子節點的備份組集合。
	array<object>	單個叢集備份組下，各個子節點的備份組集合。
BackupId	string	備份 ID。	738025367
InstanceName	string	MongoDB 分區名稱。	d-bp16cb162771****
BackupDownloadURL	string	備份檔案的外網下載地址，若當前不可下載，則返回為空白字串。	http://oss.com/xxx
BackupIntranetDownloadURL	string	內網下載地址，若當前不可下載，則返回空值。	http://oss.com/xxx
BackupStartTime	string	本次備份開始時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2023-10-16T19:33:20Z
BackupEndTime	string	本次備份結束時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2023-10-16T19:33:20Z
BackupSize	string	備份檔案大小，單位為 Byte。	77544597650
IsAvail	string	備份組是否可用，取值說明： 0：不可用。 1：可用。	1
BackupStatus	string	備份狀態，取值說明： Success：備份成功。 Failed：備份失敗。	Success
BackupName	string	備份名稱。	12345678.tar.gz
ExtraInfo	object	備份關聯的執行個體節點資訊。
NodeId	string	節點 ID。	d-2ze75ab1fa5d****
StorageSize	string	節點的儲存空間大小，單位為 MB。	20480
InstanceClass	string	節點規格。	mdb.shard.4x.large.d
NodeType	string	節點類型。	db
Progress	string	備份進度，單位為%。僅正在啟動並執行備份才會顯示進度。	50
AttachLogStatus	string	備份的狀態，取值如下： Init：初始化。 No_Need：無附加記錄備份。 Running：附加記錄備份中。 Ready：附加記錄備份完成。 Failed：附加記錄備份失敗。說明當 ClusterBackupStatus 參數（叢集備份組的狀態）的值為 OK 時，僅表示全量備份階段執行成功了，對於開啟了記錄備份的叢集執行個體，想要使用按時間點恢複或滿足一致性恢複的效果時，需要附加記錄備份完成。	Ready
EngineVersion	string	備份時的執行個體版本號碼，取值： 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
BackupExpireTime	string	備份到期時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。重要 "9999-01-01T00:00:00Z"表示長期保留。	2025-03-29T03:47:12Z

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****",
  "MaxResults": 10,
  "PageNumber": 1,
  "PageSize": 30,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-o8c2ugnxo26kx***",
      "ClusterBackupStatus": "OK",
      "ClusterBackupStartTime": "2023-10-16T19:33:20Z",
      "ClusterBackupSize": "107374182400",
      "ClusterBackupEndTime": "2023-10-16T19:33:20Z",
      "ClusterBackupMode": "Automated",
      "ExtraInfo": {
        "RegistryFromHistory": "1"
      },
      "Backups": [
        {
          "BackupId": "738025367",
          "InstanceName": "d-bp16cb162771****\n",
          "BackupDownloadURL": "http://oss.com/xxx",
          "BackupIntranetDownloadURL": "http://oss.com/xxx",
          "BackupStartTime": "2023-10-16T19:33:20Z",
          "BackupEndTime": "2023-10-16T19:33:20Z",
          "BackupSize": "77544597650",
          "IsAvail": "1",
          "BackupStatus": "Success",
          "BackupName": "12345678.tar.gz",
          "ExtraInfo": {
            "NodeId": "d-2ze75ab1fa5d****",
            "StorageSize": "20480",
            "InstanceClass": "mdb.shard.4x.large.d",
            "NodeType": "db"
          }
        }
      ],
      "Progress": "50",
      "AttachLogStatus": "Ready",
      "EngineVersion": "4.2",
      "BackupExpireTime": "2025-03-29T03:47:12Z"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The Specified parameter StartTime or EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.

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

變更歷史

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