CreateOrder - - 阿里云

To facilitate ticket creation, you can call the following dedicated operations to create some types of tickets:

CreateDataCorrectOrder: creates a regular data change ticket.
CreateDataCronClearOrder: creates a ticket to clear historical data.
CreateDataImportOrder: creates a data import ticket.
CreateFreeLockCorrectOrder: creates a lock-free change 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.
Tid	Long	No	3***	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.
Comment	String	Yes	test	The description of the ticket to be created.
PluginParam	Map	Yes	{PluginParam_test}	The ticket creation parameter. The value is a JSON string. The value of this parameter differs based on the type of the ticket. For more information, see the PluginParam parameter section in this topic.
RelatedUserList	String	Yes	user1,user2	The IDs of the stakeholders that are involved in the ticket. Separate multiple IDs with commas (,).
PluginType	String	Yes	DATA_EXPORT	The type of the ticket. For more information, see PluginType parameter.
RegionId	String	No	cn-hangzhou	The region in which DMS is activated. For more information, see RegionID parameter.
AttachmentKey	String	No	test_AttachmentKey	The key of an attachment that is returned after the attachment is uploaded. You can call the GetUserUploadFileJob operation to query the key of the attachment.

PluginParam parameter


# Change a schema design.
 {
    "title": "test", // The name of the ticket.
    "description": "test", // The description of the ticket.
    "dbId": 11****, // The database to which changes are made.
    "logic": false, // Specifies whether the database is a logical database.
    "relatedIds": [], // The IDs of the stakeholders that are involved in the ticket.
  }

# Export data.
 {
  "classify": "Reason", // The purpose of the ticket.
  "dbId": 17****, // The ID of the database from which data is exported.
  "exeSQL": "select 1", // The SQL statement that is executed to export data.
  "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.
 }

If you need to create more types of tickets, submit a ticket for consultation.

Response parameters


Parameter	Type	Example	Description
CreateOrderResult	Array of Long	12***	The ID of the ticket.
RequestId	String	427688B8-ADFB-4C4E-9D45-EF5C1FD6****	The ID of the request.
ErrorCode	String	UnknownError	The error code.
ErrorMessage	String	UnknownError	The error message.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=CreateOrder
&Comment=test
&PluginParam={PluginParam_test}
&PluginType=DATA_EXPORT
&RelatedUserList=user1,user2
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateOrderResponse>
    <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6****</RequestId>
    <CreateOrderResult>
        <OrderIds>12***</OrderIds>
    </CreateOrderResult>
    <Success>true</Success>
</CreateOrderResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "427688B8-ADFB-4C4E-9D45-EF5C1FD6****",
  "CreateOrderResult" : {
    "OrderIds" : "12***"
  },
  "Success" : true
}

Error codes

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