Call the CreateProcCorrectOrder API to create a programmable object ticket - Data Management - Alibaba Cloud - Data Management

Creates a programmable object ticket.

Operation description

This operation is available only for database instances managed in Security Collaboration mode.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:CreateProcCorrectOrder

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Comment	string	Yes	The remarks of the ticket.	test
RelatedUserList	array	No	The operators related to the ticket.
	integer	No	The ID of the operator related to the ticket.	1342**
Param	object	Yes	The parameters of the ticket.
Classify	string	No	The reason for the programmable object change.	test
DbItemList	array<object>	Yes	The information about the database.
	object	No	The information about the database.
DbId	integer	Yes	The database ID. A database can be physical or logical. To query the ID of a physical database, call the ListDatabases or SearchDatabase operation. To query the ID of a logical database, call the ListLogicDatabases or SearchDatabase operation.	1972****
Logic	boolean	Yes	Whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is a physical database.	false
RollbackSQL	string	No	The SQL statements for rolling back the data change. Note This parameter is required if you set the RollbackSqlType parameter to TEXT.	empty
RollbackAttachmentName	string	No	The key of the attachment that contains the rollback SQL statements. You can call the GetUserUploadFileJob operation to obtain the attachment key from the AttachmentKey value. Note This parameter is required if you set RollbackSqlType to ATTACHMENT.	test_rollback.sql
RollbackSqlType	string	No	The format of the SQL statements used to roll back the data change. Valid values: TEXT ATTACHMENT	TEXT
ExecSQL	string	Yes	The SQL statements for data change.	DELIMITER /// CREATE PROCEDURE GetAllProducts() BEGIN SELECT * FROM base_user; END ///
ExecMode	string	No	The execution mode for the data change ticket after approval. Valid values: COMMITOR: The ticket is executed by the submitter. AUTO: The ticket is automatically executed after approval. LAST_AUDITOR: The ticket is executed by the last approver.	COMMITOR
AttachmentKey	string	No	The key of the ticket attachment. The attachment provides additional instructions for this operation. You can call the GetUserUploadFileJob operation to query the key of the attachment.	order_attachment.txt
Tid	integer	No	The ID of the tenant. Note To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	4***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
Success	boolean	Whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
CreateOrderResult	array	The ticket IDs.
	integer	The ticket ID.	12*****

Examples

Success response

JSON format

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    0
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.