You can call this operation to create a ticket.

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 CreateOrder

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

Comment String Yes test

The description of the ticket to create.

PluginParam String Yes {}

The parameters required to create the ticket. The parameters to be set vary with the ticket type. For more information, see the following instructions for the PluginParam parameter.

PluginType String Yes DATA_EXPORT

The type of the ticket. Valid values:

  • DC_COMMON: a common data change ticket.
  • NDDL: a schema design change ticket.
  • DATA_EXPORT: a data export ticket.
  • PERM_APPLY: a permission application ticket.
  • OWNER_APPLY: an owner application ticket.
RelatedUserList String Yes 1,2,3

The IDs of users related to the ticket. Separate multiple IDs with commas (,).

Tid Long No -1

The ID of the tenant.

Instructions for the PluginParam parameter

json
"pluginParam" : {
    "classify" : "Test", // The category of the reason for data change.
    "estimateAffectRows" : 1, // The estimated number of affected rows.
    "execSql" : "update base_op_log set id=1 where id=1;", // The SQL statement to run for data change.
    "dbItemList" : [ { // The databases to run.
      "dbId" : 179694,
      "logic" : false
    } ],
    "rbSQL" : "update base_op_log set id=1 where id=1;", // The SQL statement to run for rollback.
    "rbAttachmentName" : null, // The attachment of the SQL statement to run for rollback.
    "sqlType" : "TEXT", // The type of the SQL file to run for data change. Valid values: TEXT and ATTACHMENT.
    "rbSQLType" : "TEXT", // The type of the SQL file to run for rollback. Valid values: TEXT and ATTACHMENT.
    "attachmentName" : // The attachment of the SQL statement to run for data change.
  }
json
"pluginParam": {
    "title": "test", // The title.
    "description": "test", // The description.
    "dbId": 118989, // The source database.
    "logic": false, // Specifies whether the database is a logical database.
    "relatedIds": [], // The IDs of users related to schema design change.
  }
json
"pluginParam" : {
  "classify": "Reason", // The category of the reason for data export.
  "dbId": 179719, // The ID of the database from which data is exported.
  "exeSQL": "select 1", // The SQL statement to run for data export.
  "logic": false, // Specifies whether the database is a logical database.
  "ignoreAffectRows": false, // Specifies whether to ignore the affected rows.
  "affectRows": 1, // The estimated number of affected rows.
  "ignoreAffectRowsReason": "" // The reason for ignoring the affected rows.
 }

Response parameters

Parameter Type Example Description
CreateOrderResult List 123

The ID of the ticket that was created.

OrderIds

The ID of the ticket that was created.

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.

Examples

Sample requests


http(s)://[Endpoint]/? Action=CreateOrder
&Comment=test
&PluginParam={}
&PluginType=DATA_EXPORT
&RelatedUserList=1,2,3
&<Common request parameters>

Sample success responses

XML format

<RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D</RequestId>
<CreateOrderResult>
    <OrderIds>123</OrderIds>
</CreateOrderResult>
<Success>true</Success>

JSON format

{
	"CreateOrderResult":{
		"OrderIds":[
			123
		]
	},
	"RequestId":"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
	"Success":true
}

Error codes

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