调用ListDDLPublishRecords获取结构设计工单的发布详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
OrderId Long 3214325

工单ID。

说明 您可以在控制台(请参见结构设计)或通过CreateOrder接口创建结构设计工单,并获取工单ID。
Tid Long 1

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息
RegionId String cn-hangzhou

选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String A1549FB0-D4B8-4140-919F-17322C1072B8

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

DDLPublishRecordList Array of DDLPublishRecord

发布记录列表。

AuditStatus String CANCEL

审批状态,取值如下:

  • EXEMPT_PASS:免批通过
  • TO_AUDIT:等待审批
  • CANCEL:撤销审批
  • SUCCESS:审批通过
  • FAIL:未通过
AuditExpireTime String 2020-12-14 20:52:38

审批过期时间。

CreatorId Long 1423

工单创建人的用户ID(可通过GetUser接口获取的UserId参数),非阿里云UID。

Finality Boolean true

是否终止,取值为:

  • true:是
  • false:否
    说明 导致终止的原因有审批撤回或在指定执行时间前未完成审批等。
FinalityReason String CANCEL

终止原因。

PublishStatus String AUDIT

发布状态,取值如下:

  • START:创建
  • ANALYZE:分析
  • AUDIT:审批
  • DISPATCH:调度
  • SUCCESS:成功
RiskLevel String LOW_RISK

风险等级,取值如下:

  • NONE_RISK:无风险
  • LOW_RISK:低风险
  • MIDDLE_RISK:中风险
  • HIGH_RISK:高风险
StatusDesc String CANCEL

发布状态描述。

WorkflowInstanceId Long 432153

审批流ID。

PublishTaskInfoList Array of PublishTaskInfo

发布任务信息列表。

DbId Long 4325

数据库ID。

Logic Boolean false

是否为逻辑库,取值:

  • true:是
  • false:否
PlanTime String 2020-12-14 20:52:38

计划发布时间。

PublishStrategy String IMMEDIATELY

发布策略,取值:

  • IMMEDIATELY:立即执行
  • REGULARLY:定时执行
StatusDesc String NONE

状态描述。

TaskJobStatus String NONE

任务状态。

PublishJobList Array of PublishJob

发布任务列表。

ExecuteCount Long 0

已经执行的SQL数量。

Scripts String ALTER TABLE test_toolkit_rename_table_after_rename MODIFY COLUMN gmt_modified datetime NOT NULL

变更脚本。

TableName String test_toolkit_rename_table_after_rename

变更的表名。

StatusDesc String NONE

状态描述。

TaskJobStatus String NONE

发布任务状态,取值如下:

  • NONE:未知
  • SUCCESS:执行成功
  • FAIL:执行失败
DBTaskGroupId Long 423515

SQL任务分组ID。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?OrderId=3214325
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDDLPublishRecordsResponse>
    <RequestId>AEF89401-5456-431A-9709-2C6C45657B51</RequestId>
    <Success>true</Success>
    <DDLPublishRecordList>
        <StatusDesc>所有库均执行成功</StatusDesc>
        <PublishTaskInfoList>
            <StatusDesc>所有表均执行成功,回调完成</StatusDesc>
            <TaskJobStatus>SUCCESS</TaskJobStatus>
            <PublishStrategy>IMMEDIATELY</PublishStrategy>
            <DbId>8000009</DbId>
            <PublishJobList>
                <StatusDesc>执行成功,回调成功</StatusDesc>
                <TableName>big_table</TableName>
                <Scripts>CREATE TABLE `big_table` (
                    `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
                    `name` varchar(64) NOT NULL COMMENT '名称',
                    `long_text_a` varchar(1024) NULL COMMENT 'A文本',
                    `long_text_b` varchar(1024) NULL COMMENT 'B文本',
                    PRIMARY KEY (`id`)
                    ) DEFAULT CHARACTER SET=utf8 COMMENT='大表变更';</Scripts>
                <TaskJobStatus>SUCCESS</TaskJobStatus>
                <ExecuteCount>1</ExecuteCount>
                <DBTaskGroupId>2220000</DBTaskGroupId>
            </PublishJobList>
            <PublishJobList>
                <StatusDesc>执行成功,回调成功</StatusDesc>
                <TableName>data_modify</TableName>
                <Scripts>CREATE TABLE `data_modify` (
                    `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
                    `name` varchar(256) NOT NULL COMMENT '姓名',
                    `phone` varchar(32) NULL COMMENT '电话',
                    `sex` varchar(32) NULL COMMENT '性别',
                    `email` varchar(256) NULL COMMENT '邮箱',
                    `user_desc` varchar(1024) NULL COMMENT '备注',
                    PRIMARY KEY (`id`)
                    ) DEFAULT CHARACTER SET=utf8 COMMENT='数据修改测试表';</Scripts>
                <TaskJobStatus>SUCCESS</TaskJobStatus>
                <ExecuteCount>1</ExecuteCount>
                <DBTaskGroupId>2220800</DBTaskGroupId>
            </PublishJobList>
            <PlanTime>2020-12-23 11:37:00</PlanTime>
            <Logic>false</Logic>
        </PublishTaskInfoList>
        <AuditStatus>SUCCESS</AuditStatus>
        <CreatorId>260006</CreatorId>
        <Finality>true</Finality>
        <AuditExpireTime>2020-12-23 11:37:00</AuditExpireTime>
        <WorkflowInstanceId>850007</WorkflowInstanceId>
        <RiskLevel>LOW_RISK</RiskLevel>
        <FinalityReason>执行成功,任务结束</FinalityReason>
        <PublishStatus>SUCCESS</PublishStatus>
    </DDLPublishRecordList>
</ListDDLPublishRecordsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "AEF89401-5456-431A-9709-2C6C45657B51",
  "Success" : true,
  "DDLPublishRecordList" : [ {
    "StatusDesc" : "所有库均执行成功",
    "PublishTaskInfoList" : [ {
      "StatusDesc" : "所有表均执行成功,回调完成",
      "TaskJobStatus" : "SUCCESS",
      "PublishStrategy" : "IMMEDIATELY",
      "DbId" : 8000009,
      "PublishJobList" : [ {
        "StatusDesc" : "执行成功,回调成功",
        "TableName" : "big_table",
        "Scripts" : "CREATE TABLE `big_table` (\n\t`id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',\n\t`name` varchar(64) NOT NULL COMMENT '名称',\n\t`long_text_a` varchar(1024) NULL COMMENT 'A文本',\n\t`long_text_b` varchar(1024) NULL COMMENT 'B文本',\n\tPRIMARY KEY (`id`)\n) DEFAULT CHARACTER SET=utf8 COMMENT='大表变更';",
        "TaskJobStatus" : "SUCCESS",
        "ExecuteCount" : 1,
        "DBTaskGroupId" : 2220000
      }, {
        "StatusDesc" : "执行成功,回调成功",
        "TableName" : "data_modify",
        "Scripts" : "CREATE TABLE `data_modify` (\n\t`id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',\n\t`name` varchar(256) NOT NULL COMMENT '姓名',\n\t`phone` varchar(32) NULL COMMENT '电话',\n\t`sex` varchar(32) NULL COMMENT '性别',\n\t`email` varchar(256) NULL COMMENT '邮箱',\n\t`user_desc` varchar(1024) NULL COMMENT '备注',\n\tPRIMARY KEY (`id`)\n) DEFAULT CHARACTER SET=utf8 COMMENT='数据修改测试表';",
        "TaskJobStatus" : "SUCCESS",
        "ExecuteCount" : 1,
        "DBTaskGroupId" : 2220800
      } ],
      "PlanTime" : "2020-12-23 11:37:00",
      "Logic" : false
    } ],
    "AuditStatus" : "SUCCESS",
    "CreatorId" : 260006,
    "Finality" : true,
    "AuditExpireTime" : "2020-12-23 11:37:00",
    "WorkflowInstanceId" : "850007",
    "RiskLevel" : "LOW_RISK",
    "FinalityReason" : "执行成功,任务结束",
    "PublishStatus" : "SUCCESS"
  } ]
}

错误码

访问错误中心查看更多错误码。