查詢MongoDB實例的備份列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作：是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
|---|---|---|---|---|
| dds:DescribeBackups | get |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實例 ID。 說明
當本參數(shù)傳入的是分片集群實例 ID 時，還需要傳入 NodeId 參數(shù)。
| dds-bp1a7009eb24**** |
| NodeId | string | 否 | 分片集群實例中 Shard 節(jié)點的 ID。 說明
當 DBInstanceId 參數(shù)傳入的是分片集群實例 ID 時，本參數(shù)必填。
| d-bp128a003436**** |
| BackupId | string | 否 | 備份 ID。 當 DBInstanceId 參數(shù)傳入的是分片集群實例 ID 時，備份 ID 個數(shù)與 Shard 節(jié)點個數(shù)相同，中間用英文逗號（,）間隔。 | 2072****,2072****,2072**** |
| PageNumber | integer | 否 | 頁碼，取值為大于 0 且不超過 Integer 數(shù)據(jù)類型的最大值，默認值為 1。 | 1 |
| PageSize | integer | 否 | 每頁記錄數(shù)，取值：
| 30 |
| StartTime | string | 否 | 查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。 | 2022-01-13T13:00Z |
| EndTime | string | 否 | 查詢結束時間，必須晚于查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。 | 2022-01-14T13:00Z |
| SrcRegion | string | 否 | 實例所在地域。 說明
| cn-beijing |
| DestRegion | string | 否 | 備份所在地域。 說明
異地備份必填
| cn-hangzhou |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "275D43C3-F12F-5224-B375-0C6BF453BD56",
"PageSize": 30,
"PageNumber": 1,
"Backups": {
"Backup": [
{
"BackupStatus": "Success",
"BackupType": "FullBackup",
"BackupStartTime": "2022-01-14T03:56:17Z",
"BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&Region=cn-hangzhou",
"BackupSize": 6168576,
"BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=LTAI4G2wxd32KLGARf****&Signature=lkFPjOY%2F8adB18vnOCbtmT7****&Region=cn-hangzhou",
"BackupMode": "Automated",
"BackupEndTime": "2022-01-14T03:57:34Z",
"BackupId": "32102****",
"BackupDBNames": "database",
"BackupMethod": "Physical",
"BackupJobId": "1123xxxx",
"BackupName": "12345678.tar.gz",
"BackupScale": "DBInstance",
"IsAvail": true,
"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 錯誤碼發(fā)生變更、OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
| 2024-04-12 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
| 2024-03-25 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
| 2024-02-22 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
| 2023-12-07 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |