调用DescribeFullBackupList接口查看DBS全量备份任务列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeFullBackupList |
系统规定参数。取值:DescribeFullBackupList。 |
BackupPlanId | String | 是 | 1ibh2XXXXXXX |
备份计划ID。 |
PageSize | Integer | 否 | 30 |
每页的记录数,取值:
默认为30。 |
PageNum | Integer | 否 | 1 |
页码,大于等于0且不超过Integer的最大值,默认值为:0。 |
RegionId | String | 否 | cn-hangzhou |
地域ID。调用DescribeRegions接口查看DBS支持地域。 |
ClientToken | String | 否 | ETnLKlblzczshOTUbOCzxxxxxxx |
用于保证请求的幂等性,防止重复提交请求。 |
ShowStorageType | Boolean | 否 | true |
是否显示存储类型。 默认true。 |
BackupSetId | String | 否 | 1ibh2XXXXXXX |
备份集ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrCode | String | Param.NotFound |
错误码。 |
ErrMessage | String | The specified parameter %s value is not valid. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
Items | Array of FullBackupFile |
全量备份任务详情。 |
|
FullBackupFile | |||
BackupObjects | String | [{\"DBName\":\"test\"}] |
备份对象。 |
BackupSetExpiredTime | Long | 1554560477000 |
备份集保留到期时间戳。取值1554560477000。 |
BackupSetId | String | 1ibh2f5uXXXX |
备份集ID。 |
BackupSize | Long | 151 |
备份大小。 |
BackupStatus | String | finish |
备份任务状态,取值:
|
CreateTime | Long | 1583740896000 |
任务开始时间戳。取值:1554560477000。 |
EndTime | Long | 1583741465000 |
备份结束时间戳。取值:1554560477000。 |
ErrMessage | String | NULL |
错误信息。 |
FinishTime | Long | 1583741466000 |
任务结束时间戳。取值:1554560477000。 |
SourceEndpointIpPort | String | 100.X.X.10:33204 |
数据库连接地址。 |
StartTime | Long | 1583741439000 |
备份开始时间。取值:1554560477000。 |
StorageMethod | String | Standard |
存储类型,取值:
|
PageNum | Integer | 1 |
页码。 |
PageSize | Integer | 10 |
每页的记录数。 |
RequestId | String | 636BC118-6080-4119-A6B5-C199CEC1037D |
请求ID。 |
Success | Boolean | true |
是否成功。 |
TotalElements | Integer | 1 |
总全量备份任务数。 |
TotalPages | Integer | 1 |
总页数。 |
示例
请求示例
http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=DescribeFullBackupList
&BackupPlanId=1ibh2XXXXXXX
&<公共请求参数>
正常返回示例
XML
格式
<DescribeFullBackupListReponse>
<RequestId>636BC118-6080-4119-A6B5-C199CEC1037D</RequestId>
<PageSize>30</PageSize>
<PageNum>0</PageNum>
<HttpStatusCode>200</HttpStatusCode>
<TotalElements>1</TotalElements>
<TotalPages>1</TotalPages>
<Items>
<FullBackupFile>
<SourceEndpointIpPort>100.X.X.10:33204</SourceEndpointIpPort>
<StorageMethod>Standard</StorageMethod>
<BackupObjects>[{"DBName":"test_y"}]</BackupObjects>
<EndTime>1583741465000</EndTime>
<FinishTime>1583741466000</FinishTime>
<BackupSize>151</BackupSize>
<CreateTime>1583740896000</CreateTime>
<StartTime>1583741439000</StartTime>
<BackupSetExpiredTime>1646813439000</BackupSetExpiredTime>
<BackupSetId>1ibh2XXXXXXX</BackupSetId>
<BackupStatus>finish</BackupStatus>
</FullBackupFile>
</Items>
<Success>true</Success>
</DescribeFullBackupListReponse>
JSON
格式
{
"RequestId": "636BC118-6080-4119-A6B5-C199CEC1037D",
"PageSize": 30,
"PageNum": 0,
"HttpStatusCode": 200,
"TotalElements": 1,
"TotalPages": 1,
"Items": {
"FullBackupFile": [
{
"SourceEndpointIpPort": "100.X.X.10:33204",
"StorageMethod": "Standard",
"BackupObjects": "[{\"DBName\":\"test_y\"}]",
"EndTime": 1583741465000,
"FinishTime": 1583741466000,
"BackupSize": 151,
"CreateTime": 1583740896000,
"StartTime": 1583741439000,
"BackupSetExpiredTime": 1646813439000,
"BackupSetId": "1ibh2XXXXXXX",
"BackupStatus": "finish"
}
]
},
"Success": true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交