请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 unbind_role_names 是 Array of strings 委托解绑的权限策略集合。 bind_role_names 是 Array of strings 委托绑定的权限策略集合。

请求示例 指定任务设置需要迁移的用户 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-update-user { "jobs": [{ "is_migrate_user": true, "is_set_password": false, "job_id": "36c368d7-c03f-46e1-839a-b5c5bddjb105", "list": [{ "account": "admin.testuser2", "comment": "", "id": "admin.testuser2", "is_set_password": true, "is_transfer": true, "password": null, "privileges": null, "roles": ["admin.clusterAdmin"], "selected": true }], "password": "", "user_roles": [{ "comment": "", "inherits_roles": [ "admin.roletest1", "admin.roletest3", "fastunit.roletest1" ], "is_transfer": true, "privileges": "[{u'resource': {u'cluster': True}, u'actions': [u'addShard']}, {u'resource': {u'db': u'fastunit', u'collection': u'coll'}, u'actions': [u'find', u'insert', u'remove', u'update']}, {u'resource': {u'db': u'mgo', u'collection': u'mycollection3'}, u'actions': [u'insert', u'remove', u'update']}, {u'resource': {u'db': u'', u'collection': u''}, u'actions': [u'find']}, {u'resource': {u'db': u'admin', u'collection': u''}, u'actions': [u'find']}]", "role": "admin.roletest4", "selected": true }] }] } 指定任务设置不迁移用户 https://{endpoint}/v3/0549a6a31000d4e82fd1c00c3d6f2d76/jobs/batch-update-user { "jobs" : [ { "is_migrate_user" : false, "is_set_password" : false, "job_id" : "a281f62f-4631-45d6-a2d3-679a9f4jb105" } ] }

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 all_counts Integer 总数。 results Array of objects 迁移用户信息。 详情请参见表8 表8 results字段数据结构说明 参数 参数类型 描述 job_id String 任务ID。 is_global_password String 是否使用全局密码。 message String 错误码。 user_list Array of objects 用户列表数据。 详情请参见表9。 roles_list Array of objects 角色列表数据。 详情请参见表10。 is_success Boolean 是否成功。 表9 user_list字段数据结构说明 参数 参数类型 描述 id String 用户账号ID。 account String 账号。 comment String 说明。 is_transfer Boolean 是否迁移。 privileges Array of strings 权限。 password String 密码。 roles Array of strings 拥有的角色。 selected Boolean 是否选择。 no_privileges String 无法同步的用户权限。 parent_account String 父用户。 no_parent_account String 无法同步父子关系的父用户。 表10 roles_list字段数据结构说明 参数 参数类型 描述 role String 角色。 comment String 说明。 is_transfer Boolean 是否迁移。 privileges String 权限。 inherits_roles Array of strings 继承的角色。 selected Boolean 是否选择。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of objects 批量更新迁移用户请求列表。 详情请参见表4。 表4 jobs字段数据结构说明 参数 是否必选 参数类型 描述 job_id 是 String 任务ID。 password 否 String 全局密码。 list 否 Array of objects 用户迁移信息，迁移用户时必填。 详情请参见表5。 user_roles 否 Array of objects 角色迁移信息，迁移用户时必填。 详情请参见表6。 is_set_password 是 Boolean 是否设置密码。 is_migrate_user 是 Boolean 是否迁移用户。 is_sync_object_privilege 否 Boolean 是否同步权限，不填默认为false，PostgreSQL同步使用。 表5 list字段数据结构说明 名称 是否必选 参数类型 说明 id 是 String 用户ID。 account 是 String 用户。 comment 否 String 说明。 is_transfer 是 Boolean 是否支持迁移。 privileges 否 String 权限列表。 password 否 String 密码。 is_set_password 否 Boolean 是否重置密码。 roles 是 Array of strings 角色。 selected 是 Boolean 是否选择。 表6 user_roles字段数据结构说明 名称 是否必选 参数类型 说明 role 是 String 角色。 comment 否 String 说明。 is_transfer 是 Boolean 是否支持迁移。 privileges 是 String 权限。 inherits_roles 否 Array of strings 继承角色列表。 selected 否 Boolean 是否选择，不填默认不迁移。

响应示例 状态码： 200 Success. { "is_existed" : true, "name" : "DRS_AGENTCY", "roles" : [ { "name" : "DRS FullAccess", "description" : "策略描述1" }, { "name" : "Tenant Administrator", "description" : "策略描述2" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 is_existed Boolean 委托是否存在。 name String 委托名称。 roles Array of AgencyRole objects 委托绑定的权限策略信息。 表4 AgencyRole 参数 参数类型 描述 name String 策略名称。 description String 策略描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求示例 通过OBS备份文件进行全量备份恢复。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7526", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "目标RDS实例名称：rds-sqlserver-2022-stand", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "" }, "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "files" : [ { "name" : "1706510914000_0_Test_Database.bak", "obs_path" : "", "size" : "8.75 MB" } ] }, "options" : { "is_cover" : true, "recovery_mode" : "full", "is_default_restore" : true, "is_last_backup" : true, "reset_db_name_map" : { }, "is_precheck" : true, "is_delete_backup_file" : true, "db_names" : [ "" ] } } RDS备份文件备份恢复。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7526", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "miao'shu", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "0d87037d934848999fdc10bbabb08e6fbr04" }, "backup_info" : { "file_source" : "RDS", "files" : [ { "obs_path" : "", "size" : "211.10MB", "rds_version" : "2019_EE", "rds_source_instance_id" : "7fb189b57339473a929d41dabb3878a2in04", "file_name" : "sqlserver-Auto-Single-Sqlserver2019-tar-sense-20240827181001498" } ] }, "options" : { "is_precheck" : true, "reset_db_name_map" : { "db_test12" : "", "db_hailiang_schema" : "", "db_sqls2v5_01" : "" }, "db_names" : [ "db_test12", "db_hailiang_schema", "db_sqls2v5_01" ] } } 通过OBS桶备份文件进行全量+增量备份恢复。 首先进行一次全量迁移，is_last_backup选择“false”。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7527", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "描述", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "" }, "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "files" : [ { "name" : "ims.bak", "obs_path" : "floder/", "size" : "8.75 MB" } ] }, "options" : { "is_cover" : true, "recovery_mode" : "full", "is_default_restore" : true, "is_last_backup" : false, "reset_db_name_map" : { }, "is_precheck" : true, "is_delete_backup_file" : true, "db_names" : [ "" ] } } 通过OBS桶备份文件进行全量+增量备份恢复。 全量迁移完成后，然后进行一次增量迁移。如果不止一个增量备份文件，is_last_backup依然选择“false”。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7527", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "描述", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "" }, "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "files" : [ { "name" : "ims_log1.bak", "obs_path" : "floder/", "size" : "1.75 MB" } ] }, "options" : { "is_cover" : true, "recovery_mode" : "incre", "is_default_restore" : true, "is_last_backup" : false, "reset_db_name_map" : { }, "is_precheck" : true, "is_delete_backup_file" : true, "db_names" : [ "" ] } } 通过OBS桶备份文件进行全量+增量备份恢复。 停止数据库业务，进行最后一次增量迁移，is_last_backup选择“true”。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7527", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "描述", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "" }, "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "files" : [ { "name" : "ims_log2.bak", "obs_path" : "floder/", "size" : "1.75 MB" } ] }, "options" : { "is_cover" : true, "recovery_mode" : "incre", "is_default_restore" : true, "is_last_backup" : true, "reset_db_name_map" : { }, "is_precheck" : true, "is_delete_backup_file" : true, "db_names" : [ "" ] } }

响应示例 状态码： 200 OK { "id" : "0667845a-6291-4e2a-95b0-190c0abjb703", "status" : "SUC CES S", "create_time" : "2024-08-19T02:27:15Z", "finish_time" : "2024-08-19T02:29:03Z", "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "file_info" : [ { "file_name" : "1706510914000_1_Test_Database.bak", "file_size" : "704KB", "file_last_modify" : "1706511360000" } ] }, "base_info" : { "name" : "DRS-6813", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "目标RDS实例名称：rds-sqlserver2022-stand", "is_grant_agency_low_permission" : false }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04" }, "options" : { "is_cover" : true, "is_default_restore" : true, "is_last_backup" : false, "is_precheck" : true, "is_delete_backup_file" : false, "recovery_mode" : "full", "db_names" : [ ] }, "new_db_names" : "[]", "instance_name" : "" } 状态码： 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }

请求参数 表2 请求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：中文

请求参数 表2 请求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：中文 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 备份迁移任务名称。 description 否 String 备份迁移任务描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 备份迁移任务总数。 jobs Array of OfflineTaskInfo objects 备份迁移任务列表。 表5 OfflineTaskInfo 参数 参数类型 描述 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 错误描述。

响应示例 状态码： 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." }

URI GET /v5/{project_id}/backup-migration-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 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 排序字段。 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：中文

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。