云服务器内容精选

  • 响应示例 状态码: 200 OK { "is_full_trans_support_object" : false, "is_incre_trans_support_object" : false, "is_full_incre_trans_support_object" : false, "file_size" : "5.0", "support_object_import_engine" : [ "oracle-to-mrsKafka", "oracle-to-kafka" ], "is_support_column_mapping" : false, "is_database_support_search" : true, "is_table_support_search" : true }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 is_full_trans_support_object Boolean 全量任务是否支持对象选择。 is_incre_trans_support_object Boolean 增量任务是否支持对象选择。 is_full_incre_trans_support_object Boolean 全量加增量任务是否支持对象选择。 support_object_import_engine Array of strings 支持对象导入的引擎。 is_support_column_mapping Boolean 是否支持列映射。 is_database_support_search Boolean 库是否支持搜索。 is_schema_support_search Boolean schema是否支持搜索。 is_table_support_search Boolean 表是否支持搜索。 file_size String 对象导入支持的文件大小,单位为MB。 previous_select String 上一次选择迁移对象或者同步对象的方式。 为空时表示当前还未选择需要的方式。 srcImportObject:当前任务上次选择的方式为导入方式。 import_level String 对象导入类型。 table:表级。 database:库级。 is_import_cloumn Boolean 当前任务上次选择列加工的方式。 true: 当前任务上次选择列加工方式为导入方式。 false 或者 空:当前任务上次选择列加工方式为手动选择方式。
  • 请求参数 表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
  • 响应示例 状态码: 200 OK { "object_mapping_list" : [ { "source_db_name" : "yf", "source_table_name" : "aaaa", "target_db_name" : "yf", "target_table_name" : "aaaa" } ], "count" : 1 } 状态码: 400 Bad Request { "error_code": "DRS.M05003", "error_msg": "Task information not found." }
  • 请求示例 查询同步映射列表请求示例。 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/object-mappings { "db_name": "", "schema_name": "", "table_name": "", "offset": 1, "limit": 10, "has_column_info": false }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 总数。 object_mapping_list Array of objects 同步映射数据列表。 详情请参见表5。 表5 object_mapping_list参数说明 参数 参数类型 描述 source_db_name String 源数据库库名。 source_schema_name String 源数据库模式名。 source_table_name String 源数据库表名。 target_db_name String 目标数据库库名。 target_schema_name String 目标数据库模式名。 target_table_name String 目标数据库表名。 has_column_info Boolean 是否有列映射。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 请求参数 表2 请求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 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset 大于等于 0。默认为0 缺省值:0 limit 否 Integer 每页显示的条目数量。默认为10,取值范围【1-1000】 最小值:1 最大值:1000 缺省值:10 db_name 否 String 库名。 schema_name 否 String 模式名。 table_name 否 String 表名。 has_column_info 否 Boolean 是否有列映射。
  • 请求参数 表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 { "target_root_db" : { "db_name" : "db1", "db_encoding" : "UTF-8" }, "object_scope" : "table", "object_info" : { "db1" : { "name" : "db1", "all" : false, "schemas" : { "schema1" : { "name" : "schema1", "all" : false, "tables" : { "table1" : { "name" : "table1", "type" : "table", "all" : true, "is_synchronized" : false } } } }, "total_table_num" : 1 } }, "max_table_num" : 500 } 状态码: 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }
  • URI GET /v5/{project_id}/jobs/{job_id}/db-objects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0 limit 否 Integer 每页显示的条目数量 type 是 String 查询对象信息类型。取值: source:查询源库对象信息。 modified:查询已选择的(未下发与已同步的)对象信息。 synchronized:查询已同步的(已下发的)对象信息 。 db_names 否 Array 查询指定库的信息。
  • 响应示例 状态码: 202 OK { "id" : "0eacda0b-9422-4535-8b62-537d1833638b", "status" : "pending" } 状态码: 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是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 db_names 否 Array of strings 查询指定库的信息。 type 是 String 查询对象信息类型。取值: source:查询源库对象信息。 modified:查询已选择的(已同步的和未下发的)对象信息。 synchronized:查询已同步的(已下发的)对象信息 , 使用场景在任务处于全量中或者增量中。 is_refresh 否 String 是否强制刷新。取值: true:是,表示从源库重新查询。 false:否,表示从已缓存中数据查询。
  • 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 id String 查询结果ID。 status String 查询状态。 枚举值: pending failed success 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512