查询PolarDB MySQL版备份数据详情。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dbs:DescribeBackupDataList | List |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceName | string | 否 | PolarDB 实例 ID。 | pc-2ze3nrr64c5****** |
| RegionCode | string | 否 | 备份集所在地域。 | cn-hangzhou |
| SceneType | string | 否 | 备份场景类型，当前仅支持LEVEL_1，即实例所在地域的一级备份。 | LEVEL_1 |
| StartTime | string | 否 | 查询开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 | 2024-04-17T17:00:16Z |
| EndTime | string | 否 | 查询结束时间，需要大于查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 | 2024-04-17T17:00:32Z |
| BackupStatus | string | 否 | 备份集状态，取值如下：
| OK |
| BackupId | string | 否 | 备份集 ID。 | 213064**** |
| BackupMethod | string | 否 | 备份方式，取值如下：
| Snapshot |
| BackupMode | string | 否 | 备份模式，取值如下：
| Automated |
| BackupType | string | 否 | 备份类型，取值如下：
| FullBackup |
| BackupScale | string | 否 | 备份规格，取值如下：
| DBInstance |
| PageSize | integer | 否 | 每页记录数，默认值为 20。 | 20 |
| PageNumber | integer | 否 | 页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。 | 1 |
| InstanceIsDeleted | boolean | 否 | 实例是否已删除，取值如下：
| false |
| InstanceRegion | string | 否 | 原实例所在地域。 | cn-hangzhou |
| DataSourceId | string | 否 | 预留参数，暂无需关注。 | test**** |
返回参数
示例
正常返回示例
JSON格式
{
"Data": {
"Content": [
{
"BackupId": "213088****",
"BackupName": "logic_backup",
"BackupMode": "Automated",
"BackupType": "FullBackup",
"BackupScale": "DBInstance",
"BackupMethod": "Snapshot",
"BackupSize": 25669140480,
"BackupStatus": "OK",
"BackupStartTime": "2024-04-17T17:00:16Z",
"BackupEndTime": "2024-04-17T17:00:32Z",
"ConsistentTime": 1713373221,
"BackupLocation": "logic",
"InstanceName": "pc-2ze3nrr64c5******",
"Engine": "polardb_mysql",
"EngineVersion": "5.7",
"SupportDeletion": 0,
"Encryption": "psk2",
"IsAvail": 1,
"Checksum": "84a4c16431f969712e6895992719****",
"BackupDownloadURL": "http://oss.com/****",
"BackupIntranetDownloadURL": "http://oss.com/****",
"ExpectExpireType": "DELAY",
"ExpectExpireTime": "2024-04-19T05:00:49Z",
"PolarSnapshot": {
"DumpId": 0,
"DumpSize": 25669140589,
"expectExpireType": "DELAY",
"ExpectExpireTime": "2024-04-19T05:00:49Z"
}
}
],
"PageSize": 20,
"PageNumber": 1,
"TotalPages": 1,
"TotalElements": 1,
"Extra": "dbtest"
},
"RequestId": "95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28",
"ErrCode": "Request.Forbidden\t",
"Success": "true",
"ErrMessage": "The specified parameter %s value is not valid. ",
"Code": "Success",
"Message": "The specified parameter %s value is not valid."
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Request.Forbidden | Have no Permissions | 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作 |
访问错误中心查看更多错误码。