全部产品
Search
文档中心

云数据库 RDS:DescribeOssDownloads - 查看备份数据上云任务的文件详情

更新时间:Mar 22, 2024

该接口用于查询RDS SQL Server备份数据上云任务的文件详情。

接口说明

适用引擎

  • RDS SQL Server

注意事项

该接口暂不支持 SQL Server 2017 企业版和 2019 企业版实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeOssDownloadsRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。可通过 DescribeDBInstances 接口查询。

rm-uf6wjk5****
MigrateTaskIdstring

迁移任务的 ID,可通过 DescribeMigrateTasks 接口查询。

5625458541
ResourceGroupIdstring

资源组 ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

DBInstanceIdstring

实例 ID。

rm-uf6wjk5****
RequestIdstring

请求 ID。

A5409D02-D661-4BF3-8F3D-0A814D0574E7
MigrateTaskIdstring

迁移任务的 ID。

562154852
Itemsobject []

导入的文件列表。

EndTimestring

结束时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-08-27T12:45:15Z
Statusstring

文件状态,取值:

  • NoStart:未开始
  • Downloading:下载中
  • Finished:下载完成
  • DownloadFailed:下载失败
  • VerifyFailed:MD5 校验失败
  • Deleted:已删除
  • DeleteFailed:删除失败
  • CheckSuccess:检查成功
  • CheckFailed:检查失败
  • Restoring:还原中
  • Restored:还原成功
  • RestoreFailed:还原失败
Finished
Descriptionstring

文件描述信息。

App description
CreateTimestring

备份文件在下载列表中的创建时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-08-17T12:45:15Z
BackupModestring

备份类型,取值:

  • Database:全量备份文件
  • Differential_Database:增量备份文件
  • Transaction_Log:日志备份文件
Database
IsAvailablestring

是否可用,取值:True | False

True
FileNamestring

备份文件在 OSS 上的名称。

test
FileSizestring

备份文件大小,单位 MB。

2

示例

正常返回示例

JSON格式

{
  "DBInstanceId": "rm-uf6wjk5****",
  "RequestId": "A5409D02-D661-4BF3-8F3D-0A814D0574E7",
  "MigrateTaskId": "562154852",
  "Items": {
    "OssDownload": [
      {
        "EndTime": "2017-08-27T12:45:15Z",
        "Status": "Finished",
        "Description": "App description",
        "CreateTime": "2017-08-17T12:45:15Z",
        "BackupMode": "Database",
        "IsAvailable": "True",
        "FileName": "test",
        "FileSize": "2"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-08-04OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId