Executes a ticket to make a schema design change.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request Parameter

Parameter Type Required Example Description
Action String Yes CreatePublishGroupTask

The operation that you want to perform. Set the value to CreatePublishGroupTask .

DbId Integer Yes 12345

The library ID of the execution.

Logic Boolean Yes false

Specifies whether the database is a logical database.

OrderId Long Yes 142435

The ID of the ticket.

Note You can use the console (see Design schemas ) or by CreateOrder The interface creates a structural design ticket and obtains the ticket ID.
PublishStrategy String Yes IMMEDIATELY

The policy for changing the schema design. Valid values:

  • IMMEDIATELY: The schema design is changed immediately.
  • REGULARLY: The schema design is changed at a specified time.
Tid Long Yes -1

The ID of the tenant.

Note Take the tenant ID information displayed in the upper right corner of the system. For details, see Tenant ID and Tenant .
PlanTime String No 2019-10-10 00:00:00

The scheduled execution time.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code returned.

ErrorMessage String UnknownError

The returned message.

RequestId String 427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

TaskId Long 413452

The ID of the task.


Sample requests

     http(s)://[Endpoint]/?Action=CreatePublishGroupTask &DbId=12345 &Logic=false &OrderId=142435 &PublishStrategy=IMMEDIATELY &Tid=-1 &<Public request parameters> 

Sample success responses

XML format

     <RequestId>78C93646-D9B1-4E6E-B5FD-C69F94A7905A</RequestId> <Success>true</Success> <TaskId>13424</TaskId> 

JSON Address format

     { "RequestId": "78C93646-D9B1-4E6E-B5FD-C69F94A7905A", "Success": true, "TaskId": 13424 } 

Error code

Go to the Error Center See more error codes.