CreateSQLEvaluateTask - 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，取值範圍如下：*enable：啟用來源 RDS。*disabled：停用來源 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*****"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。