Calls the CreatePublishGroupTask to execute a schema design change.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes CreatePublishGroupTask

The operation that you want to perform. Valid values: CreatePublishGroupTask .

DbId Integer Yes 12345

The ID of the executed database.

Logic Boolean Yes false

Specifies whether the database is a logical database.

OrderId Long Yes 142435

The ID of the ticket.

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 The tenant ID is taken from the avatar in the upper-right corner of the system. For more information, see Tenant ID and Tenant .
PlanTime String No 2019-10-10 00:00:00

The time of the scheduled execution plan.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message of the failure.

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=immediate&Tid=-1 &<common request parameters> 

Sample success responses

XML format

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

JSON Format

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

Error codes

Go to the Error Center For more information, see error codes.