CreateSQLEvaluateTask - PolarDB - Alibaba Cloud Documentation Center

Creates a SQL statement assessment task. You submit SQL statements through this operation, and the system performs static analysis and risk assessment to identify execution risks and compatibility issues on the target database instance.

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

polardbx:CreateSQLEvaluateTask

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. > You can call the DescribeRegions operation to query the regions supported by PolarDB-X, including region IDs.	cn-shanghai
DBInstanceName	string	Yes	The instance ID. > You can call the DescribeDBInstances operation to query the details of all instances in the target region, including instance IDs.	pxc-shr4idrgogti89
SlinkTaskDesc	string	No	The description of the target SQL statement.	test-drds->auto
SrcResId	string	No	The ID of the source ApsaraDB RDS instance. > You can call the DescribeDropSystemEventMetaList operation to query the details of all source ApsaraDB RDS instances in the target region, including instance IDs.	pxc-shr****rgkh87z
SrcDb	string	No	Specifies whether to enable the source ApsaraDB RDS instance. Valid values: enable: enables the source ApsaraDB RDS instance. disabled: disables the source ApsaraDB RDS instance.	transfer_test3
SrcUserName	string	No	The username of the source instance.	drds_test
SrcPassword	string	No	The port number of the source instance. Valid values: 3200 to 3999. > This parameter is available and required only when DBEndpointInstanceType is set to polardb-o.	******
DstResId	string	No	The ID of the target SQL statement. > You can call the DescribeDBInstances operation to query the details of the target SQL statement, including the ID.	pxc-zkrc1****l54rc
DstDb	string	No	The ID of the instance on which the target SQL statement is executed. > You can call the DescribeDBInstances operation to query the details of the target SQL statement, including the instance ID.	transfer_for_st
DstUserName	string	No	The username of the destination instance.	drds_test
DstPassword	string	No	The password of the target SQL statement. > You can call the DescribeDBInstances operation to query the details of the target SQL statement, including the password.	******
SlinkTaskId	string	No	The task ID for executing the target SQL statement. > You can call the DescribeCloudCenterInstances operation to query the IDs of target SQL statements supported by PolarDB-X.	etx-szr2rr6i*****
SrcResType	string	No	The type of the source instance. Valid values: RDS_MYSQL, POLARX1, POLARX2_STANDARD, POLARX2_ENTERPRISE, and POLARDB_M.	POLARX2

Response elements

Element	Type	Description	Example
	object
Message	string	The response message. > This parameter is empty when the request succeeds. If the request fails, an exception message is returned, such as an error code.	*****
RequestId	string	The request ID.	6352AC16-76BF-5135-B1EA-ED49293526E6
Success	boolean	Indicates whether the request was successful.	True
Data	object	The returned result.
SlinkTaskId	string	The slink task ID.	etx-szr2rr6i*****

Examples

Success response

JSON format

{
  "Message": "*****",
  "RequestId": "6352AC16-76BF-5135-B1EA-ED49293526E6",
  "Success": true,
  "Data": {
    "SlinkTaskId": "etx-szr2rr6i*****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.