CreateCloudBenchTasks - 建立壓測任務 -

調用CreateCloudBenchTasks介面，建立壓測任務。

介面說明

資料庫自治服務 DAS 提供智能壓測功能，協助您驗證您的執行個體規格是否需要擴容，有效應對業務流量高峰。更多資訊，請參見智能壓測。資料庫需滿足如下前提條件：

來源資料庫僅支援 RDS MySQL 高可用系列或三節點企業系列、PolarDB MySQL 版的叢集版。
目標資料庫執行個體為 RDS MySQL、PolarDB MySQL 版。
執行個體已接入 DAS，詳情請參見接入阿里雲資料庫執行個體。
需開啟 DAS 企業版，詳情請參見 DAS 企業版。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:CreateCloudBenchTasks

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
TaskType	string	是	壓測任務類型。取值： pressure test（預設）：智能壓測，將從源執行個體上擷取的流量，按照目標執行個體規格支援的極限速度，在目標執行個體上進行回放。 smart pressure test：產生壓測，通過分析和學習短時間內在源執行個體上擷取的流量，產生和原始流量的業務模型和流量分布基本一致的流量進行持續壓測，減少從源執行個體採集資料的時間，降低儲存成本和效能開銷。	pressure test
SrcInstanceId	string	是	源執行個體 ID，僅支援 RDS MySQL、PolarDB MySQL 版執行個體，您可通過調用 GetInstanceInspections 介面擷取。說明當 DstType 為 Instance 時，本參數需要傳入。	rm-2ze1jdv45i7l6****
Description	string	是	壓測任務描述。	test-das-bench-0501
SrcPublicIp	string	否	備用參數。	None
DstInstanceId	string	否	目標執行個體 ID，僅支援 RDS MySQL、PolarDB MySQL 版執行個體，您可通過調用 GetInstanceInspections 介面擷取。說明當 DstType 為 Instance 時，本參數需要傳入。	rm-2ze1jdv45i7l6****
GatewayVpcId	string	否	資料庫網關的專用網路 ID。說明若 ClientType 取值為 ECS，則此參數必傳入。	vpc-t4nsnwvpbc1h76ja4****
GatewayVpcIp	string	否	資料庫網關的 IP 位址或網域名稱。說明若 ClientType 取值為 ECS，則此參數必傳入。	172.30.XX.XX
ClientType	string	是	壓測機器類型。取值： ECS：您需要自己準備資料庫網關。 DAS_ECS：DAS 自動購買和部署的 ECS。	ECS
RequestStartTime	string	否	壓測任務的開始時間，格式為 Unix 時間戳記，單位為毫秒。	1608888296000
RequestEndTime	string	否	壓測任務的結束時間，格式為 Unix 時間戳記，單位為毫秒。	1608888296001
RequestDuration	string	否	壓測任務的期間，單位為毫秒。	86400000
Rate	string	否	源執行個體流量在目標執行個體上的回放速度，回放速度必須是正整數，取值：1~30，預設為 1。	1
SmartPressureTime	string	否	產生壓測的期間，單位為毫秒。說明當 TaskType 為smart pressure test時本參數需要傳入。	86400000
DtsJobClass	string	否	DTS 遷移任務規格，您可以通過調用 DescribeCloudbenchTask 介面擷取。說明壓測任務需要先將源執行個體基準資料移轉至目標執行個體，當您建立 DTS 任務時需要傳入本參數。	medium
DtsJobId	string	否	DTS 遷移任務 ID，您可調用 ConfigureDtsJob 介面擷取。說明已在 DTS 控制台建立完 DTS 任務時本參數必傳入。	23127
SrcSuperAccount	string	否	源端執行個體高許可權帳號。取值：admin。說明當 DstType 為 Instance 時，本參數需要傳入。	admin
SrcSuperPassword	string	否	源端執行個體高許可權帳號的密碼。說明當 DstType 為 Instance 時，本參數需要傳入。	test123
DstSuperAccount	string	否	目標執行個體的高許可權帳號。	root
DstSuperPassword	string	否	目標執行個體高許可權帳號的密碼。	test123
DstType	string	否	目標執行個體的類型。取值： Instance（預設）：執行個體 ID。 ConnectionString：執行個體的串連地址。	Instance
DstConnectionString	string	否	目標執行個體的串連地址，僅支援 RDS MySQL、PolarDB MySQL 版執行個體。說明 DstType 為 ConnectionString 本參數有效。	rm-de21209****.mysql.rds.aliyuncs.com
DstPort	string	否	目標執行個體的連接埠。說明 DstType 為 ConnectionString 本參數有效。	3306
WorkDir	string	否	壓測產生的臨時目錄。	/tmp/bench/
BackupId	string	否	備份組 ID，可通過查詢備份列表介面 DescribeBackups 擷取。	229132
BackupTime	string	否	備份的時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2021-04-23T13:22:14Z
Amount	string	否	建立壓測任務的總個數，取值：0~30，預設為 1。	1
EndState	string	否	壓測任務結束後的狀態。取值： WAIT_TARGET：準備壓測的目標執行個體。 WAIT_DBGATEWAY：準備壓測部署。 WAIT_SQL：準備全量 SQL。 WAIT_LOGIC：準備開始回放流量。說明當壓測任務執行完 EndState 設定的狀態之後，任務將直接到達完成狀態。	WAIT_TARGET

返回參數

名稱	類型	描述	樣本值
	object
Code	string	返回的狀態代碼。	200
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
RequestId	string	請求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	請求是否執行成功： true：執行成功。 false：執行失敗。	true
Data	object
taskIds	array	詳細資料列表。
	string	詳細資料列表，包括資訊總數、錯誤碼等。	"Data": { "total": 1, "list":[...] }, "Code": 200, "Success": true }

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "taskIds": [
      "\"Data\": { \"total\": 1, \"list\":[...] }, \"Code\": 200, \"Success\": true }"
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParams	The request parameters are invalid.	請求參數錯誤
403	NoPermission	You are not authorized to do this action.	沒有許可權執行該操作

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

變更歷史

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