查詢云數據庫 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 |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 實例 ID。 | dds-bp16cb162771**** |
BackupId | string | 否 | 集群備份 ID。 | 5664**** |
PageNo | integer | 否 | 分頁頁號。默認值為 1,取值范圍為正整數。 | 1 |
PageSize | integer | 否 | 每頁記錄數,取值:
| 30 |
StartTime | string | 否 | 查詢開始時間,格式為yyyy-MM-ddTHH:mmZ(UTC 時間)。 | 2019-03-13T12:11Z |
EndTime | string | 否 | 查詢結束時間,必須晚于查詢開始時間,格式為yyyy-MM-ddTHH:mmZ(UTC 時間)。 | 2019-03-14T13:10Z |
IsOnlyGetClusterBackUp | boolean | 否 | 是否查詢集群備份下的子節點信息。取值說明:
| true |
SrcRegion | string | 否 | 實例所在地域。 說明
| cn-hangzhou |
DestRegion | string | 否 | 異地備份所在地域。 說明
查詢異地備份時,該參數必填。
| cn-shanghai |
返回參數
示例
正常返回示例
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"
}
]
}
錯誤碼
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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-29 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-05-17 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |