Use ListDataCorrectPreCheckDB to query databases for a data change precheck - Data Management - Alibaba Cloud - Data Management

Operation description

For more information about the Normal Data Modify feature, see Change regular data.

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:ListDataCorrectPreCheckDB

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the ticket for the data change.	432****
PageNumber	integer	No	The number of the page to return. Valid values: a positive integer. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page.	20
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	4321****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	95A972AF-FAED-4768-9360-7C0DF5D594D0
Success	boolean	Indicates whether the request is successful.	true
ErrorMessage	string	The error message returned.	UnknownError
ErrorCode	string	The error code returned.	UnknownError
PreCheckDBList	array<object>	The databases involved in the precheck.
	object
DbId	integer	The ID of the database.	43***
SearchName	string	The name of the database.	test@localhost:3306
SqlNum	integer	The number of SQL statements.	1

Examples

Success response

JSON format

{
  "RequestId": "95A972AF-FAED-4768-9360-7C0DF5D594D0",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "PreCheckDBList": [
    {
      "DbId": 0,
      "SearchName": "test@localhost:3306",
      "SqlNum": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.