云服务器内容精选

  • 请求示例 执行预检查(异步调用)。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/action { "job" : { "action_name" : "precheck", "action_params" : { "precheck_mode" : "forStartJob" } } } 测试连接目标库(异步调用)。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/action { "job" : { "action_name" : "network", "action_params" : { "endpoints" : [ { "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" } } ] } } } 测试连接源库(异步调用)。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/action { "job" : { "action_name" : "network", "action_params" : { "endpoints" : [ { "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_password" : "******", "id" : "971e1840-9395-4044-b6c8-00ef1f83ce48", "db_name" : "serviceName.orcl" }, "ssl" : { "ssl_link" : false } } ] } } } 创建对象对比任务(异步调用)。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/d0f96c1d-571f-4b63-98a5-3b85b36jb20r/action { "job" : { "action_name" : "create_compare", "action_params" : { "compare_task_param" : { "type" : "object" } } } } 创建行对比任务(异步调用)。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/d0f96c1d-571f-4b63-98a5-3b85b36jb20r/action { "job" : { "action_name" : "create_compare", "action_params" : { "compare_task_param" : { "type" : "lines", "option" : { "comparePolicy" : "normal" }, "db_object" : { "db1" : { "name" : "db1", "tables" : { "table1" : { "name" : "table1" } } } } } } } }
  • 响应示例 状态码: 200 OK { "status": "success" } 状态码: 202 Accepted { "query_id" : "c5c1ffb3-c902-4b31-a606-dfa1231831f9" } 状态码: 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job id." }
  • 响应参数 状态码: 200 表29 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512 id String 任务ID。 name String 任务名称。 status String 操作结果。 状态码: 202 表30 响应Body参数 参数 参数类型 描述 query_id String 异步操作任务响应查询ID。 状态码: 400 表31 响应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也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • URI GET /v5/{project_id}/jobs/{job_id}/data-processing-rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示查询该偏移量后面的记录。 limit 否 Integer 查询返回记录的数量限制。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 总数量。 target_meta_is_null Long 对比不一致详情数量:只有源库存在。 source_meta_is_null Long 对比不一致详情数量:只有目标库存在。 source_target_meta_not_null Long 对比不一致详情数量:源和目标端均存在。 contents_infos Array of objects 详细内容信息列表。 详情请参见表5。 表5 contents_infos字段数据结构说明 参数 参数类型 描述 source_key_value Array of strings 源库KEY值列表。 target_key_value Array of strings 目标库KEY值列表。 select_sql String 查询源库的SQL。 target_select_sql String 查询目标库的SQL。
  • URI GET /v3/{project_id}/jobs/{job_id}/compare/{compare_job_id}/content-difference 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 compare_job_id 是 String 对比任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 table_name 否 String 表名。 db_name 否 String 源库名称。 limit 否 Integer 每页显示的条目数量,最大值1000。 最小值:1 最大值:1000 缺省值:1000 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0。 缺省值:0
  • 响应示例 状态码: 200 OK { "count" : 1, "target_meta_is_null" : 0, "source_meta_is_null" : 0, "source_target_meta_not_null" : 1, "contents_infos" : [ { "source_key_value" : [ "id=5" ], "target_key_value" : [ "id=5" ], "select_sql" : "select * from db1.tb1 where id=5", "target_select_sql" : "select * from db1.tb1 where id=5" } ] } 状态码: 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Task not found. Check the task ID." }
  • 响应参数 状态码: 200 表29 响应Body参数 参数 参数类型 描述 jobs Array of objects 批量操作任务响应体。 详情请参见表30。 表30 jobs字段数据结构说明 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512 id String 任务ID。 name String 任务名称。 status String 操作结果。 状态码: 202 表31 响应Body参数 参数 参数类型 描述 jobs Array of objects 批量异步操作任务响应体。 详情请参见表32。 表32 jobs字段数据结构说明 参数 参数类型 描述 query_id String 异步操作任务响应查询ID。 id String 任务ID。 name String 任务名称。 状态码: 400 表33 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 响应示例 状态码: 200 OK { "jobs" : [ { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name" : "DRS-1234", "status" : "Success" }, { "id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "name" : "DRS-2345", "status" : "Failed", "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID" } ] } 状态码: 202 Accepted { "jobs" : [ { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name" : "DRS-1234", "query_id" : "7debc9c-8e09-4a5d-8dd6-cc44f45566" }, { "id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "name" : "DRS-2345", "query_id" : "7debc9c-8e09-4a5d-8dd6-cc44f45566" } ] } 状态码: 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }
  • 请求示例 批量操作租户指定ID任务。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/action { "jobs" : [ { "job_id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "action_name" : "start" }, { "job_id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "action_name" : "stop" } ] }
  • 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." }
  • 响应参数 状态码: 202 表16 响应Body参数 参数 参数类型 描述 id String 查询结果ID。 job_id String 任务ID。 status String 查询状态。 枚举值: pending failed success 状态码: 400 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512