DescribeBackups--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

DescribeBackups

最近更新时间：2024.07.17 16:22:07首次发布时间：2024.04.26 11:07:55

调用 DescribeBackups 接口查询目标 MongoDB 实例的备份文件列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-shard-f9e5d782****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
BackupType	String	否	Physical	备份类型。取值范围如下： `Physical`：物理备份。 `Logical`：逻辑备份。说明若该参数留空，默认返回当前实例下所有类型的备份列表。
StartTime	String	否	2024-04-10T13:10:10Z	查询开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明若该参数留空，表示不指定查询开始时间，默认会返回当前实例下现存的所有备份。
EndTime	String	否	2024-04-10T13:10:15Z	查询结束时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明若该参数留空，表示不指定查询结束时间，默认会返回当前实例下现存的所有备份。查询结束时间需晚于查询开始时间。
BackupStatus	String	否	Success	备份状态。取值范围如下： `Success`：备份成功。 `Failed`：备份失败。 `Running`：备份中。说明若该参数留空，表示不使用备份状态进行筛选，默认会返回当前实例下所有状态的备份。
BackupObject	String	否	Data	备份对象。取值范围如下： `Data`：数据备份。 `Log`：日志备份。说明若该参数留空，表示不使用备份对象进行筛选，默认会返回当前实例下所有对象的备份。
PageNumber	Integer	否	1	备份文件列表的页码，默认值为 1。取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	否	10	每页记录数，取值范围 1~1000，默认值：10。

返回参数

参数	类型	示例值	描述
Total	Integer	1	备份文件总数。
Backups	Object[]		备份文件列表信息。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeBackups&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "mongo-shard-f9e5d782****",
    "PageNumber": 1,
    "PageSize": 10,
    "StartTime": "2022-10-25T09:12:35Z",
    "EndTime": "2022-10-25T09:12:50Z"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221025175908010174255202001A1074",
        "Action": "DescribeBackups",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "Backups": [
            {
                "BackupDownloadStatus": "Success",
                "BackupEndTime": "2022-10-25T09:12:49Z",
                "BackupFileName": "1666689162.zip",
                "BackupFileSize": 112036,
                "BackupId": "fb9a3679fe7b42e490172287eed7****",
                "BackupObject": "Data",
                "BackupStartTime": "2022-10-25T09:12:37Z",
                "BackupStatus": "Success",
                "BackupType": "Logical",
                "Creator": "User"
            }
        ],
        "Total": 1
    }
}

错误码

更多详情，请参见错误码。