该接口用于查看DBS全量备份任务列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dbs:DescribeFullBackupList | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BackupPlanId | string | 是 | 备份计划 ID。 | dbsr179qz****** |
| PageSize | integer | 否 | 每页的记录数，取值：
默认为 30。 | 30 |
| PageNum | integer | 否 | 页码，大于等于 0 且不超过 Integer 的最大值，默认值为：0。 | 1 |
| ClientToken | string | 否 | 用于保证请求的幂等性，防止重复提交请求。 | ETnLKlblzczshOTUbOCzxxxxxxx |
| ShowStorageType | boolean | 否 | 是否显示存储类型。 | true |
| BackupSetId | string | 否 | 备份集 ID。 | 1iukx5h****** |
| StartTimestamp | long | 否 | 开始备份时间。 | 1676887100 |
| EndTimestamp | long | 否 | 结束备份时间。 | 1676887128 |
返回参数
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"PageNum": 1,
"RequestId": "636BC118-6080-4119-A6B5-C199CEC1037D",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid. ",
"TotalPages": 1,
"TotalElements": 1,
"PageSize": 10,
"Items": {
"FullBackupFile": [
{
"FinishTime": 1676887128000,
"BackupStatus": "finish",
"SourceEndpointIpPort": "121.XXX.XXX.144:3306",
"CreateTime": 1676886947000,
"ErrMessage": "NULL",
"BackupObjects": "[{\\\"DBName\\\":\\\"test\\\"}]",
"EndTime": 1676887128000,
"StartTime": 1676887100000,
"BackupSetExpiredTime": 1677491900000,
"StorageMethod": "Standard",
"BackupSetId": "1iukx5h******",
"BackupSize": 580
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Request.Forbidden | Have no Permissions | 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史