查询增量DDL列表 - ListJobDdls
功能介绍
查询增量DDL列表,可根据status查询
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/jobs/{job_id}/ddl
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
job_id | 是 | String | 任务ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
offset | 否 | Integer | 偏移量,默认值为0,表示查询该偏移量后面的记录。 |
limit | 否 | Integer | 查询返回记录的数量限制.默认值为10。 |
start_seq_no | 否 | Long | DDL序列起始值。 |
end_seq_no | 否 | Long | DDL序列结束值。 |
status | 否 | Integer | DDL状态,0为无告警,1为告警中。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 |
X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language | 否 | String | 请求语言类型。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
ddl_list | Array of DdlAlarmResp objects | DDL告警信息列表。 |
count | Integer | 列表中的项目总数,与分页无关。 |
参数 | 参数类型 | 描述 |
|---|---|---|
seqno | Long | 记录唯一序号。 |
checkpoint | String | 数据源库位点。 |
status | Integer | DDL告警状态。0无告警,1告警中。 |
ddl_timestamp | Long | DDL在源库执行时间。 |
ddl_text | String | DDL内容。 |
exe_result | Boolean | DDL执行结果。false执行失败,true执行成功。 |
record_time | Long | 数据记录时间。 |
clean_time | Long | DDL告警清理时间。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
请求示例
查询增量DDL历史列表。
https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7f486edc-6abb-4621-892b-4805221jb2h4/ddl 响应示例
状态码:200
OK
{
"count" : 1,
"ddl_list" : [ {
"seqno" : 30,
"checkpoint" : "mysql-bin.000006:431;200e3d00-4a57-11ef-8a76-fa163ef2208a:7;200e3d00-4a57-11ef-8a76-fa163ef2208a:1-7",
"status" : 1,
"ddl_timestamp" : 1721894317000,
"ddl_text" : "/* sql from das */ALTER TABLE `test1`.`test1`\n\tADD COLUMN `gender` VARCHAR(32) NULL AFTER `name`",
"exe_result" : true,
"record_time" : 1721894318544,
"clean_time" : 1721897321317
} ]
} 状态码:400
Bad Request
{
"error_code" : "DRS.10000001",
"error_msg" : "Failed."
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
错误码
请参见错误码。

