响应示例 状态码： 200 OK { "total_count": 100, "shard_statics": null, "slow_sqls": null, "slow_sql_templates": null, "error_sqls": null, "error_sql_templates": null, "replaying_sqls": [ { "schema_name": "db", "sql_statement": "select * from preple where id = 1", "latency": 0, "execute_latency": 0, "status": "running", "replay_start_time": "2024-04-23T12:07:53Z" }, { "schema_name": "db", "sql_statement": "select * from preple where id = 1", "latency": 0, "execute_latency": 1, "status": "running", "replay_start_time": "2024-04-23T12:07:53Z" } ] } 状态码： 400 Bad Request { "error_code": "DRS.10020000", "error_msg": "Incorrect parameter type." }

请求示例 查询指定时间范围内回放详情基于时间序统计信息 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7b35723d-1525-410e-90c3-70f9ed3jb601/replay-results?type=shard_statistics&start_time=1700421943000&end_time=1700439961000 分页查询指定时间范围内回放的慢SQL详情 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7b35723d-1525-410e-90c3-70f9ed3jb601/replay-results?type=slow_sql&start_time=1700421943&end_time=1700439961&offset=1&limit=10 分页查询回放中慢SQL统计信息 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7b35723d-1525-410e-90c3-70f9ed3jb601/replay-results?type=slow_sql_template&offset=1&limit=10 分页查询指定时间范围内异常SQL详情 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7b35723d-1525-410e-90c3-70f9ed3jb601/replay-results?type=error_sql&start_time=1700421943&end_time=1700439961&offset=1&limit=10 分页查询回放过程中异常SQL统计信息 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7b35723d-1525-410e-90c3-70f9ed3jb601/replay-results?type=error_sql_template&offset=1&limit=10 查询正在回放的SQL信息 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7b35723d-1525-410e-90c3-70f9ed3jb601/replay-results?type=replaying_sql

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Long 数据总量。 shard_statics Array of objects 回放基于时间统计详细信息列表，在type为shard_statistics时返回。 详情请参见表5。 slow_sqls Array of objects 慢SQL信息列表，在type为slow_sql时返回。 详情请参见表6。 slow_sql_templates Array of objects 慢SQL统计信息列表，在type为slow_sql_template时返回。 详情请参见表7。 error_sqls Array of objects 异常SQL信息列表，在type为error_sql时返回。 详情请参见表8。 error_sql_templates Array of objects 异常SQL统计信息列表，在type为error_sql_template时返回。 详情请参见表9。 replaying_sqls Array of objects 正在回放SQL信息列表，在type为replaying_sql时返回。 详情请参见表10。 error_classifications Array of objects 回放异常SQL分类信息，在type为error_classification时返回。 详情请参见表11。 表5 shard_statics字段数据结构说明 参数 参数类型 描述 time String 回放时间点。 total Long SQL总量。 finish Long SQL执行量。 abnormal Long SQL异常量。 slow Long 慢SQL数量。 表6 slow_sqls字段数据结构说明 参数 参数类型 描述 object_type String SQL语句类型。 slow_sql String SQL语句。 old_time String 源库执行耗时。 replay_time String 目标库回放执行耗时。 表7 slow_sql_templates字段数据结构说明 参数 参数类型 描述 sql_template String SQL语句模板。 sql_template_md5 String SQL语句模板MD5。 target_name String 目标库别名。 schema_name String schema名称。 query_type String SQL类型。 min_latency Long SQL执行最小耗时。 max_latency Long SQL执行最大耗时。 avg_latency Long SQL执行平均耗时。 total_latency Long SQL执行总的耗时。 target_type String 目标库类型。 count Long SQL数量。 表8 error_sqls字段数据结构说明 参数 参数类型 描述 object_type String SQL类型。 abnormal_sql String SQL语句。 abnormal_info String 异常原因描述。 表9 error_sql_templates字段数据结构说明 参数 参数类型 描述 sql_template String SQL模板。 sql_template_md5 String SQL模板MD5。 target_name String 目标库昵称。 schema_name String schema名称。 query_type String SQL类型。 target_type String 目标库类型。 count Long 归类的SQL数量。 表10 replaying_sqls字段数据结构说明 参数 参数类型 描述 schema_name String 库名或shema名称。 sql_statement String SQL语句。 latency Integer 原始执行耗时。 execute_latency Integer 回放执行耗时。 status String 执行状态。 client String 客户端IP。 connection_id String 连接ID。 replay_start_time String 回放开始时间。 表11 error_classifications字段数据结构说明 参数 参数类型 描述 target_name String 目标库标识。 error_type String 异常SQL分类。 error_cnt String 异常SQL数量。 error_template_cnt String 异常SQL模板数量。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

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

URI GET /v5/{project_id}/jobs/{job_id}/replay-results 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 结果类型。取值： shard_statistics：回放概览基于时间维度统计信息。 slow_sql：慢SQL详情。 error_sql： 回放异常SQL详情。 slow_sql_template：慢SQL统计信息。 error_sql_template：异常SQL统计信息。 replaying_sql：正在回放SQL详情。 error_classification：回放异常SQL分类。 枚举值： shard_statistics slow_sql error_sql slow_sql_template error_sql_template replaying_sql error_classification start_time 否 String 查询数据的起始时间，在type为shard_statistics、slow_sql、error_sql时必填。 end_time 否 String 查询数据的结束时间，在type为shard_statistics、slow_sql、error_sql时必填. offset 否 Long 分页查询数据表当前超始偏移量, 在type为slow_sql、error_sql、slow_sql_template、error_sql_template必填。 limit 否 Long 分页查询数据表当前页数据总量，在type为slow_sql、error_sql、slow_sql_template、error_sql_template必填。 sort_key 否 String 返回结果按该关键字排序（slow_sql_template支持count、maxLatency、avgLatency关键字，error_sql_template支持count关键字）。 sort_dir 否 String 排序规则，取值如下： asc：升序 desc：降序 缺省值：desc 枚举值： asc desc target_name 否 String 回放数据库名称，用于在一致性回放策略场景，过滤目标库与源库镜像库回放结果。参数非必须，不提供则默认查询所有数据，其取值如下： target：查询目标库回放结果。 target_mirror：查询源库镜像库回放结果。 枚举值： target target_mirror is_sample 否 Boolean 是否查询样例，取值true或者false。type取值为slow_sql后者error_sql时生效，值为true时只查询一条样例数据。 error_type 否 String 错误分类，type取值为error_sql或者error_sql_template时生效，根据错误分类过滤数据。 sql_template_md5 否 String SQL模板md5，type取值为slow_sql或者error_sql时生效。根据模板过滤对应的异常SQL和慢SQL。 该参数取值可参考type为slow_sql_template或者error_sql_template时的返回字段。

响应参数 状态码： 202 表36 响应Body参数 参数 参数类型 描述 job Object 批量创建异步任务响应体。 详情请参见表37。 表37 job字段数据结构说明 参数 参数类型 描述 async_job_id String 批量异步创建的任务ID。 状态码： 400 表38 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

请求示例 批量异步创建Oracle到 GaussDB 分布式版按需实时同步任务，任务模式为全量+增量，公网网络类型。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-async-create { "jobs" : [ { "base_info" : { "name" : "DRS-1234", "job_type" : "sync", "engine_type" : "oracle-to-gaussdbv5", "job_direction" : "up", "task_type" : "FULL_INCR_TRANS", "net_type" : "eip", "charging_mode" : "on_demand", "enterprise_project_id" : "0", "description" : "", "expired_days" : "14", "tags" : [ { "key" : "test", "value" : "test" } ] }, "source_endpoint" : [ { "db_type" : "oracle", "endpoint_type" : "offline", "endpoint_role" : "so", "endpoint" : { "endpoint_name" : "oracle", "ip" : "10.154.217.239", "db_port" : "1521", "db_user" : "ORACLE_USER", "db_name" : "serviceName.orcl", "db_password" : "******" }, "ssl" : { "ssl_link" : false } } ], "target_endpoint" : [ { "db_type" : "gaussdbv5", "endpoint_type" : "cloud", "endpoint_role" : "ta", "endpoint" : { "endpoint_name" : "cloud_gaussdbv5", "instance_id" : "c2c7579bc09c490b9d8009db715aeb0ain14", "db_user" : "root", "db_password" : "******" }, "cloud" : { "region" : "cn-north-4", "project_id" : "9dc8c0f3f74c4dbb23c29cf0318ee561", "az_code" : "cn-north-4a,cn-north-4g,cn-north-4c" }, "vpc" : { "vpc_id" : "2cb5d364-ae63-4fbb-85b7-7d59f4a88f8f", "subnet_id" : "2cb54324-ae63-4fbb-85b7-7d59f4a88f8f", "security_group_id" : "039a3s89-665a-43e2-9b4f-bda7d9ee148d" } } ], "alarm_notify" : { "alarm_to_user" : true, "topic_urn" : "urn:smn:cn-north-4:f2c2468c3ee7410c862a461ca073d2f2:test", "delay_time" : 60 }, "speed_limit" : [ { "begin" : "16:00", "end" : "15:59", "speed" : "10" } ], "policy_config" : { "ddl_trans" : false }, "db_object" : { "object_scope" : "table", "target_root_db" : { "db_name" : "target_db_name", "db_encoding" : "utf8" }, "object_info" : { "source_db1" : { "name" : "source_db1", "all" : false, "tables" : { "source_tb1" : { "type" : "table", "name" : "source_tb1", "all" : true }, "source_tb2" : { "type" : "table", "name" : "source_tb2", "all" : true } } } } }, "node_info" : { "spec" : { "node_type" : "medium" } } } ] }

URI GET /v5/{project_id}/batch-async-jobs/{async_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 async_job_id 是 String 批量异步创建的任务ID，由创建批量异步任务接口返回。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示查询该偏移量后面的记录。 limit 否 Integer 查询返回记录的数量限制。

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

响应示例 状态码： 200 OK { "jobs" : [ { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "status" : "CONFIGURATION", "create_time" : "2022-11-07T16:15:18Z", "base_info" : { "name" : "DRS-1234", "job_type" : "sync", "engine_type" : "oracle-to-gaussdbv5", "job_direction" : "up", "task_type" : "FULL_INCR_TRANS", "net_type" : "eip", "charging_mode" : "on_demand", "enterprise_project_id" : "0", "description" : "", "expired_days" : 14, "tags" : [ { "key" : "test", "value" : "test" } ] }, "source_endpoint" : [ { "db_type" : "oracle", "endpoint_type" : "offline", "endpoint_role" : "so", "endpoint" : { "id" : "f59e6118-da89-4fdb-9b98-65f56709928a", "endpoint_name" : "oracle", "ip" : "10.154.217.239", "db_port" : "1521", "db_user" : "ORACLE_USER", "db_name" : "serviceName.orcl" }, "ssl" : { "ssl_link" : false } } ], "target_endpoint" : [ { "db_type" : "gaussdbv5", "endpoint_type" : "cloud", "endpoint_role" : "ta", "endpoint" : { "id" : "10deb576-8885-473b-a213-4d76e668dc0d", "endpoint_name" : "cloud_gaussdbv5", "instance_id" : "c2c7579bc09c490b9d8009db715aeb0ain14", "db_user" : "root" }, "cloud" : { "region" : "cn-north-4", "project_id" : "9dc8c0f3f74c4dbb23c29cf0318ee561", "az_code" : "cn-north-4a,cn-north-4g,cn-north-4c" }, "vpc" : { "vpc_id" : "2cb5d364-ae63-4fbb-85b7-7d59f4a88f8f", "subnet_id" : "2cb54324-ae63-4fbb-85b7-7d59f4a88f8f", "security_group_id" : "039a3s89-665a-43e2-9b4f-bda7d9ee148d" } } ], "alarm_notify" : { "alarm_to_user" : true, "topic_urn" : "urn:smn:cn-north-4:f2c2468c3ee7410c862a461ca073d2f2:test", "delay_time" : 60 }, "speed_limit" : [ { "begin" : "16:00", "end" : "15:59", "speed" : "10" } ], "policy_config" : { "ddl_trans" : false }, "node_info" : { "spec" : { "node_type" : "medium" } } }, { "id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "status" : "INCRE_TRANSFER_STARTED", "create_time" : "2022-11-05T15:32:22Z", "base_info" : { "name" : "DRS-2345", "job_type" : "sync", "engine_type" : "oracle-to-gaussdbv5", "job_direction" : "up", "task_type" : "FULL_INCR_TRANS", "net_type" : "vpn", "charging_mode" : "on_demand", "enterprise_project_id" : "0", "description" : "", "expired_days" : 14, "tags" : [ { "key" : "test", "value" : "test" } ] }, "source_endpoint" : [ { "db_type" : "oracle", "endpoint_type" : "offline", "endpoint_role" : "so", "endpoint" : { "id" : "6a2aea81-c01d-4313-b93e-6a17f9351c51", "endpoint_name" : "oracle", "ip" : "10.154.227.134", "db_port" : "1521", "db_user" : "ORACLE_USER", "db_name" : "serviceName.orcl" }, "ssl" : { "ssl_link" : false } } ], "target_endpoint" : [ { "db_type" : "gaussdbv5", "endpoint_type" : "cloud", "endpoint_role" : "ta", "endpoint" : { "id" : "f59e6118-da89-4fdb-9b98-65f56709928a", "endpoint_name" : "cloud_gaussdbv5", "instance_id" : "c2c7579bc09c490b9d8009db715aeb0ain14", "db_user" : "root" }, "cloud" : { "region" : "cn-north-4", "project_id" : "9dc8c0f3f74c4dbb23c29cf0318ee561", "az_code" : "cn-north-4a,cn-north-4g,cn-north-4c" }, "vpc" : { "vpc_id" : "2cb5d364-ae63-4fbb-85b7-7d59f4a88f8f", "subnet_id" : "2cb54324-ae63-4fbb-85b7-7d59f4a88f8f", "security_group_id" : "039a3s89-665a-43e2-9b4f-bda7d9ee148d" }, "ssl" : { "ssl_link" : false } } ], "policy_config" : { "ddl_trans" : false }, "node_info" : { "spec" : { "node_type" : "high" } } } ], "total_count" : 2 } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

请求参数 表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 strings 批量查询任务详情。 page_req 否 Object 分页信息。 详情请参见表4。 表4 page_req字段数据结构说明 参数 是否必选 参数类型 描述 cur_page 否 Integer 当前页, 不能超过传入jobID数量除每页任务数量的最大页。 最小值：1 缺省值：1 per_page 否 Integer 每页item数量，填0获取全部item。 最小值：0 最大值：100 缺省值：5

请求示例 查询任务详情请求示例： https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-detail { "jobs" : [ "24834eb6-be30-464e-a299-f7aa730jb101", "140b5236-88ad-43c8-811c-1268453jb101" ], "page_req" : { "cur_page" : 1, "per_page" : 10 } }

响应参数 状态码： 200 表10 响应Body参数 参数 参数类型 描述 count Integer 总数。 results Array of objects 批量修改任务返回列表。 详情请参见表11。 表11 results字段数据结构说明 参数 参数类型 描述 id String 任务ID。 status String 状态。取值： success：成功。 failed：失败。 error_code String 错误码。 error_msg String 错误信息。

请求示例 批量修改指定任务的任务名称 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-modification { "jobs" : [ { "job_id" : "140b5236-88ad-43c8-811c-1268453jb101", "name" : "testName" } ] } 批量设置指定任务的异常通知信息 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-modification { "jobs" : [ { "job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502", "alarm_notify" : { "delay_time" : 0, "rto_delay" : 0, "rpo_delay" : 0, "alarm_to_user" : false, "subscriptions" : [ { "protocol" : "sms", "endpoints" : [ "150********" ] }, { "protocol" : "email", "endpoints" : [ "abc@huawei.com" ] } ] } } ] } 批量修改指定任务的任务名称和描述 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-modification { "jobs" : [ { "job_id" : "140b5236-88ad-43c8-811c-1268453jb101", "name" : "testName", "description" : "test description" } ] }

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