调用DescribeBackupSetDownloadTaskList接口查看支持查看DBS备份集下载列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 位置 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
Action | Query | String | 是 | DescribeBackupSetDownloadTaskList |
系统规定参数。取值:DescribeBackupSetDownloadTaskList。 |
BackupPlanId | Query | String | 否 | dbs1hvb0wxxxxxx |
备份计划ID。 |
BackupSetDownloadTaskId | Query | String | 否 | dbstooi01exxxxx |
备份集下载任务ID。 |
PageSize | Query | Integer | 否 | 30 |
每页的记录数。取值:
说明 默认为30。
|
PageNum | Query | Integer | 否 | 1 |
页码,大于等于0且不超过Integer的最大值,默认值为:0。 |
RegionId | Host | String | 否 | cn-hangzhou |
地域ID。您可以调用DescribeRegions查询。 |
ClientToken | Query | String | 否 | ETnLKlblzczshOTUbOCzxxxxxxx |
用于保证请求的幂等性,防止重复提交请求。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrCode | String | Param.NotFound |
错误码。 |
ErrMessage | String | The specified parameter %s value is not valid. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
Items | Array of BackupSetDownloadTaskDetail |
备份计划详情。 |
|
BackupSetDownloadTaskDetail | |||
BackupGatewayId | Long | 2134324232134 |
备份集备份网关、仅自动下载有值。 |
BackupPlanId | String | dbs1hvb0xxxx |
备份计划ID。 |
BackupSetCode | String | UTF_8 |
源备份集编码。
|
BackupSetDataFormat | String | SQL |
备份集下载数据格式:
|
BackupSetDataSize | Long | 213 |
备份集数据大小。 |
BackupSetDbType | String | MySQL |
数据库类型。 |
BackupSetDownloadCreateTime | Long | 1554560477000 |
创建时间戳,取值:1554560477000。 |
BackupSetDownloadDir | String | test |
备份集下载服务器目录、仅自动下载有值。 |
BackupSetDownloadFinishTime | Long | 1554560477000 |
完成时间戳,取值:1554560477000。 |
BackupSetDownloadInternetUrl | String | 176.x.x.x |
备份集公网下载地址,仅手工下载类型且转换完成的有值。 |
BackupSetDownloadIntranetUrl | String | 176.x.x.x |
备份集内网下载地址,仅手工下载类型且转换完成的有值。 |
BackupSetDownloadStatus | String | init |
备份集下载状态,取值:
|
BackupSetDownloadTargetType | String | agent |
备份集下载目标类型 ,仅自动下载有值。 说明 agent:已安装备份网关。
|
BackupSetDownloadTaskId | String | dbstooxxxxx |
备份集下载任务ID。 |
BackupSetDownloadTaskName | String | test |
备份集下载任务名称。 |
BackupSetDownloadWay | String | auto |
下载类型:
|
BackupSetId | String | dbsxxxxxx |
源备份集ID。 |
BackupSetJobType | String | cbs_backup_sub_full |
源备份集任务类型,取值:
|
ErrMessage | String | java.lang.IndexOutOfBoundsException. |
异常信息。 |
PageNum | Integer | 1 |
页码。 |
PageSize | Integer | 30 |
每页的记录数。 |
RequestId | String | BFE78B4D-7D57-43D8-ABCA-D11DED1F768E |
请求ID。 |
Success | Boolean | true |
是否成功。 |
TotalElements | Integer | 1 |
总备份集下载记录数。 |
TotalPages | Integer | 1 |
总页数。 |
示例
请求示例
http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=DescribeBackupSetDownloadTaskList
&BackupPlanId = dbs1hvb0wxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<DescribeBackupSetDownloadTaskListResponse>
<RequestId>BFE78B4D-7D57-43D8-ABCA-D11DED1F768E</RequestId>
<PageSize>30</PageSize>
<PageNum>0</PageNum>
<HttpStatusCode>200</HttpStatusCode>
<TotalElements>0</TotalElements>
<TotalPages>0</TotalPages>
<Items></Items>
<Success>true</Success>
</DescribeBackupSetDownloadTaskListResponse>
JSON
格式
{
"RequestId": "BFE78B4D-7D57-43D8-ABCA-D11DED1F768E",
"PageSize": 30,
"PageNum": 0,
"HttpStatusCode": 200,
"TotalElements": 0,
"TotalPages": 0,
"Items": "",
"Success": true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交