Interpret Data Export Precheck Results via GetDataExportPreCheckDetail - Data Management - Alibaba Cloud - Data Management

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the ticket. You can call the ListOrders operation to obtain the ticket ID.	34****
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C1D39814-9808-47F8-AFE0-AF167239AC9B
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
PreCheckResult	object	The precheck result.
IgnoreAffectRows	boolean	Indicates whether to skip verification. Valid values: true false	true
PreCheckDetailList	object
PreCheckDetailList	array<object>	The precheck details.
	object
AffectRows	integer	The estimated number of data rows to be affected.	1
SQL	string	The SQL statement.	SELECT * FROM tmp_table LIMIT 1
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "C1D39814-9808-47F8-AFE0-AF167239AC9B",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "PreCheckResult": {
    "IgnoreAffectRows": true,
    "PreCheckDetailList": {
      "PreCheckDetailList": [
        {
          "AffectRows": 1,
          "SQL": "SELECT * FROM tmp_table LIMIT 1"
        }
      ]
    }
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.