ListDDLPublishRecords - 获取结构设计工单详情 - 数据管理 DMS

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:ListDDLPublishRecords	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
OrderId	long	是	工单 ID。说明您可以在控制台（请参见结构设计）或通过 CreateOrder 接口创建结构设计工单，并获取工单 ID。	3214325
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	A1549FB0-D4B8-4140-919F-17322C1072B8
Success	boolean	请求是否成功。	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
DDLPublishRecordList	array<object>	发布记录列表。
DDLPublishRecord	object	发布记录。
AuditStatus	string	审批状态，取值如下： EXEMPT_PASS：免批通过 TO_AUDIT：等待审批 CANCEL：撤销审批 SUCCESS：审批通过 FAIL：未通过	CANCEL
AuditExpireTime	string	审批过期时间。	2020-12-14 20:52:38
CreatorId	long	工单创建人的用户 ID（可通过 GetUser 接口获取的 UserId 参数），非阿里云 UID。	1423
Finality	boolean	是否终止，取值为： true：是 false：否说明导致终止的原因有审批撤回或在指定执行时间前未完成审批等。	true
FinalityReason	string	终止原因。	CANCEL
PublishStatus	string	发布状态，取值如下： START：创建 ANALYZE：分析 AUDIT：审批 DISPATCH：调度 SUCCESS：成功	AUDIT
RiskLevel	string	风险等级，取值如下： NONE_RISK：无风险 LOW_RISK：低风险 MIDDLE_RISK：中风险 HIGH_RISK：高风险	LOW_RISK
StatusDesc	string	发布状态描述。	CANCEL
WorkflowInstanceId	long	审批流 ID。	432153
Comment	string	发布备注	发布备注
PublishTaskInfoList	array<object>	发布任务信息列表。
PublishTaskInfo	object	发布任务信息。
DbId	long	数据库 ID。	4325
Logic	boolean	是否为逻辑库，取值： true：是 false：否	false
PlanTime	string	计划发布时间。	2020-12-14 20:52:38
PublishStrategy	string	发布策略，取值： IMMEDIATELY：立即执行 REGULARLY：定时执行	IMMEDIATELY
StatusDesc	string	状态描述。	NONE
TaskJobStatus	string	任务状态。	NONE
PublishJobList	array<object>	发布任务列表。
PublishJob	object	发布任务。
ExecuteCount	long	已经执行的 SQL 数量。	0
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：未知 SUCCESS：执行成功 FAIL：执行失败	NONE
DBTaskGroupId	long	SQL 任务分组 ID。	423515

示例

正常返回示例

JSON格式

{
  "RequestId": "A1549FB0-D4B8-4140-919F-17322C1072B8",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DDLPublishRecordList": [
    {
      "AuditStatus": "CANCEL",
      "AuditExpireTime": "2020-12-14 20:52:38",
      "CreatorId": 1423,
      "Finality": true,
      "FinalityReason": "CANCEL",
      "PublishStatus": "AUDIT",
      "RiskLevel": "LOW_RISK",
      "StatusDesc": "CANCEL",
      "WorkflowInstanceId": 432153,
      "Comment": "发布备注",
      "PublishTaskInfoList": [
        {
          "DbId": 4325,
          "Logic": false,
          "PlanTime": "2020-12-14 20:52:38",
          "PublishStrategy": "IMMEDIATELY",
          "StatusDesc": "NONE",
          "TaskJobStatus": "NONE",
          "PublishJobList": [
            {
              "ExecuteCount": 0,
              "Scripts": "ALTER TABLE test_toolkit_rename_table_after_rename MODIFY COLUMN gmt_modified datetime NOT NULL",
              "TableName": "test_toolkit_rename_table_after_rename",
              "StatusDesc": "NONE",
              "TaskJobStatus": "NONE",
              "DBTaskGroupId": 423515
            }
          ]
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-04-18	OpenAPI 返回结构发生变更	查看变更详情