You can call this operation to run a specified schema design change ticket to change the scheme design.

Debugging

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 parameters

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 ID of the database for which the schema design is changed.
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.
PlanTime String No 2019-10-10 00:00:00

The time at which the schema design is changed.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.
ErrorMessage String UnknownError

The error message.
RequestId String 427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

The ID of the request.
Success Boolean true

Indicates whether the request was successful.
TaskId Long 413452

The ID of the task.

Examples

Sample requests


http(s)://[Endpoint]/? Action=CreatePublishGroupTask
&DbId=12345
&Logic=false
&OrderId=142435
&PublishStrategy=IMMEDIATELY
&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",
	"TaskId":13424,
	"Success":true
}

Error codes

For a list of error codes, visit the API Error Center.