ListDDLPublishRecords - Data Management

Queries the publishing details of a schema design ticket.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:ListDDLPublishRecords	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ID of the ticket. Note You can create a schema design ticket in the Data Management (DMS) console. For more information, see Design schemas. You can also call the CreateOrder operation to create a schema design ticket and obtain the ID of the ticket.	3214325
Tid	long	No	The ID of the tenant. Note To view the ID of the tenant, log on to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see Manage DMS tenants.	1

Response parameters

Parameter	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	A1549FB0-D4B8-4140-919F-17322C1072B8
Success	boolean	Indicates whether the request is successful.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
DDLPublishRecordList	array<object>	The details of the publishing records.
DDLPublishRecord	object	The publishing record.
AuditStatus	string	The approval state of the ticket. Valid values: EXEMPT_PASS: The ticket passes without approval. TO_AUDIT: The ticket is pending for approval. CANCEL: The ticket is canceled. SUCCESS: The ticket is approved. FAIL: The ticket fails to pass the approval.	CANCEL
AuditExpireTime	string	The time when the approval expires.	2020-12-14 20:52:38
CreatorId	long	The ID of the user who creates the ticket. You can obtain the user ID by calling the GetUser operation and querying the value of the UserId parameter. The value is not the unique ID (UID) of the Alibaba Cloud account.	1423
Finality	boolean	Indicates whether the approval is terminated. Valid values: true: The approval is terminated. false: The approval is not terminated. Note Multiple reasons can terminate the approval. For example, you withdraw the application or your ticket is not approved before the specified time.	true
FinalityReason	string	The reason for the termination.	CANCEL
PublishStatus	string	The publishing state of the ticket. Valid values: START: The ticket is created. ANALYZE: The ticket is under analysis. AUDIT: The ticket is under approval. DISPATCH: A task is generated for the ticket. SUCCESS: The task is successful.	AUDIT
RiskLevel	string	The risk level of the operation. Valid values: NONE_RISK: The operation does not have risks. LOW_RISK: The operation is at low risk. MIDDLE_RISK: The operation is at medium risk. HIGH_RISK: The operation is at high risk.	LOW_RISK
StatusDesc	string	The description of the publishing state.	CANCEL
WorkflowInstanceId	long	The ID of the approval process.	432153
Comment	string	Release remarks.	Release remarks
PublishTaskInfoList	array<object>	The list of publishing tasks.
PublishTaskInfo	object	The information about the publishing task.
DbId	long	The ID of the database.	4325
Logic	boolean	Indicates whether the database is a logical database. Valid values: true: The database is a logical database. false: the database is not a logical database.	false
PlanTime	string	The time to publish the ticket.	2020-12-14 20:52:38
PublishStrategy	string	The publishing policy. Valid values: IMMEDIATELY: immediately publishes the ticket. REGULARLY: publishes the ticket at a scheduled time.	IMMEDIATELY
StatusDesc	string	The description of the state.	NONE
TaskJobStatus	string	The state of the task.	NONE
PublishJobList	array<object>	The list of the publishing tasks.
PublishJob	object	The details of the publishing task.
ExecuteCount	long	The number of SQL statements that are executed.	0
Scripts	string	The script for data changes.	ALTER TABLE test_toolkit_rename_table_after_rename MODIFY COLUMN gmt_modified datetime NOT NULL
TableName	string	The name of the table after the change.	test_toolkit_rename_table_after_rename
StatusDesc	string	The description of the state.	NONE
TaskJobStatus	string	The state of the publishing task. Valid values: NONE: The state of the task is unknown. SUCCESS: The task is successful. FAIL: The task fails.	NONE
DBTaskGroupId	long	The ID of the SQL task group.	423515

Examples

Sample success responses

JSONformat

{
  "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": "Release remarks",
      "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
            }
          ]
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-04-18	The response structure of the API has changed	View Change Details