All Products
Search
Document Center

Data Management:CreatePublishGroupTask

Last Updated:Mar 14, 2024

Executes a schema design ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:CreatePublishGroupTaskRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant.

Note : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see Manage DMS tenants.
-1
OrderIdlongYes

The ID of the ticket.

Note : You can create a schema design ticket in the DMS console. For more information, see Design schemas. You can also create a schema design ticket by calling the CreateOrder operation and obtain the ticket ID.
142435
DbIdintegerYes

The ID of the database for which the schema design is executed.

12345
LogicbooleanYes

Indicates whether the database is a logical database.

false
PublishStrategystringYes

The policy to execute the schema design ticket. Valid values:

  • IMMEDIATELY: immediately executes the schema design ticket.
  • REGULARLY: executes the schema design ticket at a scheduled time.
IMMEDIATELY
PlanTimestringNo

The time to execute the schema design ticket.

2019-10-10 00:00:00

Response parameters

ParameterTypeDescriptionExample
object
ErrorMessagestring

The error message returned if the request failed.

UnknownError
RequestIdstring

The ID of the request.

427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
TaskIdlong

The ID of the job.

413452
ErrorCodestring

The error code returned if the request failed.

UnknownError
Successboolean

Indicates whether the request is successful.

true

Examples

Sample success responses

JSONformat

{
  "ErrorMessage": "UnknownError",
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "TaskId": 413452,
  "ErrorCode": "UnknownError",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history