All Products
Search
Document Center

Data Management:ListDDLPublishRecords

更新時間:Oct 21, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

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
TidlongNo

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

ParameterTypeDescriptionExample
object

The schema of the response.

RequestIdstring

The ID of the request.

A1549FB0-D4B8-4140-919F-17322C1072B8
Successboolean

Indicates whether the request is successful.

true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

UnknownError
DDLPublishRecordListarray<object>

The details of the publishing records.

DDLPublishRecordobject

The publishing record.

AuditStatusstring

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
AuditExpireTimestring

The time when the approval expires.

2020-12-14 20:52:38
CreatorIdlong

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
Finalityboolean

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
FinalityReasonstring

The reason for the termination.

CANCEL
PublishStatusstring

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
RiskLevelstring

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
StatusDescstring

The description of the publishing state.

CANCEL
WorkflowInstanceIdlong

The ID of the approval process.

432153
Commentstring

Release remarks.

Release remarks
PublishTaskInfoListarray<object>

The list of publishing tasks.

PublishTaskInfoobject

The information about the publishing task.

DbIdlong

The ID of the database.

4325
Logicboolean

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
PlanTimestring

The time to publish the ticket.

2020-12-14 20:52:38
PublishStrategystring

The publishing policy. Valid values:

  • IMMEDIATELY: immediately publishes the ticket.
  • REGULARLY: publishes the ticket at a scheduled time.
IMMEDIATELY
StatusDescstring

The description of the state.

NONE
TaskJobStatusstring

The state of the task.

NONE
PublishJobListarray<object>

The list of the publishing tasks.

PublishJobobject

The details of the publishing task.

ExecuteCountlong

The number of SQL statements that are executed.

0
Scriptsstring

The script for data changes.

ALTER TABLE test_toolkit_rename_table_after_rename MODIFY COLUMN gmt_modified datetime NOT NULL
TableNamestring

The name of the table after the change.

test_toolkit_rename_table_after_rename
StatusDescstring

The description of the state.

NONE
TaskJobStatusstring

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
DBTaskGroupIdlong

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 timeSummary of changesOperation
2023-04-18The response structure of the API has changedView Change Details