# 查询备份迁移任务列表 - ListReplicationJobs #### 功能介绍 获取当前备份迁移任务列表，不包含已删除的任务。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-drs/drs_api_0035.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/backup-migration-jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 租户在某一Region下的Project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-drs/drs_api_0106.html) | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 任务名称，支持模糊搜索。 | | status | 否 | String | 备份迁移任务状态。 TRANSFERRING：恢复中 SUCCESS：成功 FAILED：失败 PRECHECK FAILED：预检查失败 | | dbs_instance_ids | 否 | Array of strings | 数据库实例ID，最大数量为10。 | | description | 否 | String | 描述。 | | create_at | 否 | String | 创建时间。 | | completed_at | 否 | String | 完成时间。 | | enterprise_project_id | 否 | String | 企业项目ID。 | | tags | 否 | String | 标签。 | | limit | 否 | Integer | 查询返回记录的数量限制，默认值为10。 | | offset | 否 | Integer | 偏移量，默认值为0，表示查询该偏移量后面的记录。 | | sort_key | 否 | String | 排序字段。 取值范围： - **name** - **db_type** - **inst_id** - **ip** - **created_at** - **description** - **tag_value** | | sort_dir | 否 | String | 排序方法。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 | | X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 | | X-Language | 否 | String | 请求语言类型。 en-us：英文 zh-cn：中文 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 备份迁移任务总数。 | | jobs | Array of [OfflineTaskInfo] objects | 备份迁移任务列表。 | 表5OfflineTaskInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 任务ID。 | | name | String | 任务名称。 | | status | String | 任务状态。 - TRANSFERRING：恢复中 - SUCCESS：成功 - FAILED：失败 - PRECHECK FAILED：预检查失败 | | engine_type | String | 数据库引擎。 - sqlserver：RDS for SQL Server引擎 | | error_log | String | 错误日志。 | | description | String | 描述。 | | create_time | String | 任务创建时间。 | | finish_time | String | 任务完成时间。 | | enterprise_project_id | String | 企业项目。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 查询备份迁移的迁移任务列表。 ``` https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs?limit=1 ``` #### 响应示例 **状态码：200** OK ``` { "jobs" : [ { "id" : "0667845a-6291-4e2a-95b0-190c0abjb703", "name" : "DRS-6813", "status" : "SUCCESS", "description" : "目标RDS实例名称：rds-sqlserver2022-stand", "engine_type" : "sqlserver", "create_time" : "2024-08-19T02:27:15Z", "finish_time" : "2024-08-19T02:29:03Z", "enterprise_project_id" : "0" } ], "count" : 35 } ``` **状态码：400** Bad Request ``` { "error_code" : "DRS.10000001", "error_msg" : "Failed." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | 其他状态请参见[状态码](https://support.huaweicloud.com/api-drs/drs_api_0108.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-drs/drs_05_0004.html)。