All Products
Search
Document Center

Data Management:ListDataCorrectPreCheckDB

Last Updated:Apr 18, 2024

Queries the databases that are involved in the precheck of a data change ticket.

Operation description

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

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:ListDataCorrectPreCheckDBRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ID of the ticket for the data change.

432****
PageNumberlongNo

The number of the page to return.

Valid values: an integer that is greater than 0.

Default value: 1.

1
PageSizelongNo

The number of entries to return on each page.

20
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the ID of the tenant.

4321****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

95A972AF-FAED-4768-9360-7C0DF5D594D0
Successboolean

Indicates whether the request is successful.

true
ErrorMessagestring

The error message returned.

UnknownError
ErrorCodestring

The error code returned.

UnknownError
PreCheckDBListobject []

The information about the databases that are involved in the precheck.

DbIdlong

The ID of the database.

43***
SearchNamestring

The name of the database.

test@localhost:3306
SqlNumlong

The number of SQL statements.

1

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history