更新时间:2024-05-27 GMT+08:00

提交查询数据库对象信息

功能介绍

提交查询数据库对象信息。例如:

  • 当type取值为source时,查询源库库表信息。
  • 当源库库表信息有变化时,type取值为source,is_refresh取值为true。
  • 当已同步到目标库的库表信息过大,需要提前将数据加载到缓存中时,type取值为synchronized。

建议使用新接口提交查询数据库对象信息进行查询。

接口约束

  • 目前仅支持Oracle->GaussDB分布式、MySQL->Kafka、GaussDB(for MySQL)->Kafka同步场景。
  • 仅支持部分Region使用,详情参考终端节点

URI

POST /v5/{project_id}/jobs/{job_id}/db-objects/collect

表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:查询已同步的(已下发的)对象信息 , 使用场景在任务处于全量中或者增量中。

is_refresh

Boolean

是否强制刷新。取值:

  • true 是,表示从源库重新查询。
  • false 否,表示从缓存中查询。

db_names

Array

查询指定库的信息。

请求参数

表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

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

id

String

查询结果ID。

status

String

查询状态。

枚举值:

  • pending
  • failed
  • success

job_id

String

任务ID。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:12

最大长度:12

error_msg

String

错误描述。

最小长度:1

最大长度:512

请求示例

查询已同步的对象信息。

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/db-objects/collect?type=synchronized

响应示例

状态码: 202

OK

{
  "id" : "036ceb63-51f8-43fb-9164-82c17b2eadbc",
  "status" : "pending",
  "job_id" : "2fccbe0d-4e6b-4957-981a-edca4e2jb201"
}

状态码: 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job ID."
}

状态码

状态码

描述

202

OK

400

Bad Request

错误码

请参见错误码