该接口用于查询RDS SQL Server实例备份数据上云任务列表。
接口说明
适用引擎
- RDS SQL Server
功能说明
该接口可以查询实例在最近一周内的备份数据上云任务记录。
注意事项
- 备份数据上云的源备份文件必须是全量备份（FULL）文件。
- 暂不支持SQL Server 2017集群版实例。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeMigrateTasks | READ |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
| StartTime | string | 是 |
查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。 |
2017-10-20T01:00Z |
| EndTime | string | 是 |
查询结束时间，必须大于开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。 |
2017-10-25T01:00Z |
| PageSize | integer | 否 |
每页记录数，取值：30~100。默认值：30。 |
30 |
| PageNumber | integer | 否 |
页码，取值：大于0且不超过Integer的最大值。 默认值：1。 |
1 |
| ResourceGroupId | string | 否 |
资源组ID。 |
rg-acfmy**** |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| DBInstanceId | string |
实例ID。 |
rm-uf6wjk5**** |
| PageNumber | integer |
获取第几页的数据。 |
1 |
| RequestId | string |
请求ID。 |
4E356DDF-6B83-45DB-99D5-4B1E8A0D286B |
| PageRecordCount | integer |
每页记录数。 |
10 |
| TotalRecordCount | integer |
满足条件的总的记录数。 |
30 |
| Items | object [] |
备份数据上云任务信息列表。 |
|
| EndTime | string |
备份数据上云任务结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 |
2017-05-30T13:11:04Z |
| Status | string |
备份数据上云任务的状态，取值：
|
Success |
| Description | string |
备份数据上云任务的描述信息。 |
Api description |
| CreateTime | string |
备份数据上云任务创建时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 |
2017-05-30T12:11:04Z |
| DBName | string |
数据库名称。 |
testDB |
| BackupMode | string |
备份数据上云任务类型，取值：
|
FULL |
| MigrateTaskId | string |
备份数据上云任务的ID。 |
564522545 |
| IsDBReplaced | string |
是否是覆盖性导入。 |
True |
示例
正常返回示例
JSON格式
{
"DBInstanceId": "rm-uf6wjk5****",
"PageNumber": 1,
"RequestId": "4E356DDF-6B83-45DB-99D5-4B1E8A0D286B",
"PageRecordCount": 10,
"TotalRecordCount": 30,
"Items": {
"MigrateTask": [
{
"EndTime": "2017-05-30T13:11:04Z",
"Status": "Success",
"Description": "Api description",
"CreateTime": "2017-05-30T12:11:04Z",
"DBName": "testDB",
"BackupMode": "FULL",
"MigrateTaskId": "564522545",
"IsDBReplaced": "True"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidStartTimeAndEndTime.Malformed | The end time must be greater than the start time | 结束时间必须大于开始时间。 |
| 403 | InvalidInstanceState | The DB instance state does not support this operation. | 操作失败，当前实例不可用。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2022-08-04 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/156568.html