文档首页> 数据复制服务 DRS> API参考> API v5（公测中）> 实例数据库对象配置> 提交查询数据库对象信息
更新时间：2024-03-27 GMT+08:00
在线调试
CLI示例
查看PDF

提交查询数据库对象信息

功能介绍

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

job_id

是

String

任务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

job_id

String

任务ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：1

最大长度：512

请求示例

查询源库对象信息。

https://{endpoint}/v5.1/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/db-objects

{
  "type" : "source"
}

响应示例

状态码： 202

OK

{
  "id" : "0eacda0b-9422-4535-8b62-537d1833638b",
  "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

错误码

请参见错误码。