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

采集数据库位点信息

功能介绍

采集数据库位点信息。

接口约束

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

URI

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

表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参数

参数

是否必选

参数类型

描述

reset_position_time

String

重置位点时间,使用UTC时间 示例:2023-09-19 15:00:00,UTC时间是2023-09-19T07:00:00Z。

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

id

String

查询结果ID。

job_id

String

任务ID。

status

String

查询状态。

枚举值:

  • pending
  • failed
  • success

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:12

最大长度:12

error_msg

String

错误描述。

最小长度:1

最大长度:512

请求示例

采集数据库位点信息(异步调用)。

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/collect-position

{
  "reset_position_time" : "2023-09-19T07:00:00Z"
}

响应示例

状态码: 202

Accepted

{
  "id" : "0eacda0b-9422-4535-8b62-537d1833638b",
  "job_id": "177738d1-4eee-4fcb-a4e1-09aea79jb20i",
  "status" : "pending"
}

状态码: 400

Bad Request

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

状态码

状态码

描述

202

Accepted

400

Bad Request

错误码

请参见错误码