調用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 |
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 |
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 |
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 | 否 | 壓測任務結束后的狀態。取值:
說明
當壓測任務執行完 EndState 設置的狀態之后,任務將直接到達完成狀態。
| WAIT_TARGET |
返回參數
示例
正常返回示例
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. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|