CreateSQLEvaluateTask - SQL评估 - 云原生数据库 PolarDB

用于创建 SQL 语句评估任务，通过该接口，用户提交 SQL 语句，系统将对其进行静态分析与风险评估，输出其在目标数据库实例上的执行风险、兼容性问题。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:CreateSQLEvaluateTask

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在地域 id。>您可以调用 describeregions 接口查看 polardb-x 支持的地域详情，包括地域 id。	cn-shanghai
DBInstanceName	string	是	实例 id。>您可以调用 describedbinstances 接口查看目标地域下所有实例的详情，包括实例 id。	pxc-shr4idrgogti89
SlinkTaskDesc	string	否	目标 sql 的描述信息。	test-drds->auto
SrcResId	string	否	源 rds 实例 id。>您可以调用 describedropsystemeventmetalist 接口查看目标地域下所有的源 rds 实例详情，包括实例 id。	pxc-shr****rgkh87z
SrcDb	string	否	源 rds 实例是否开启源 rds，取值范围如下：enable：开启源 rdsdisabled：关闭源 rds	transfer_test3
SrcUserName	string	否	源端用户名	drds_test
SrcPassword	string	否	源端口号，取值范围为 3200~3999。>当 dbendpointinstancetype 取值为polardb-o时，本参数才可用且必须传入。	******
DstResId	string	否	目标 sql 的 id。>您可以调用 describedbinstances 接口查看目标 sql 的详情，包括 id。	pxc-zkrc1****l54rc
DstDb	string	否	执行目标 sql 的实例 id。>您可以调用 describedbinstances 接口查看目标 sql 的详情，包括实例 id。	transfer_for_st
DstUserName	string	否	目标端用户名	drds_test
DstPassword	string	否	目标 sql 的密码。>您可以调用 describedbinstances 接口查看目标 sql 的详情，包括密码。	******
SlinkTaskId	string	否	执行目标 sql 的任务 id。>您可以通过 describecloudcenterinstances 接口查看 polardb-x 支持的目标 sql 的 id。	etx-szr2rr6i*****
SrcResType	string	否	源实例类型： RDS_MYSQL、POLARX1、POLARX2_STANDARD、POLARX2_ENTERPRISE、POLARDB_M	POLARX2

返回参数

名称	类型	描述	示例值
	object
Message	string	返回消息。>请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。	*****
RequestId	string	请求 id。	6352AC16-76BF-5135-B1EA-ED49293526E6
Success	boolean	请求是否成功。	True
Data	object	返回结果。
SlinkTaskId	string	slink 任务 id。	etx-szr2rr6i*****

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。