調(diào)用CreateCloudBenchTasks接口,創(chuàng)建壓測任務(wù)。
接口說明
數(shù)據(jù)庫自治服務(wù) DAS 提供智能壓測功能,幫助您驗(yàn)證您的實(shí)例規(guī)格是否需要擴(kuò)容,有效應(yīng)對業(yè)務(wù)流量高峰。更多信息,請參見智能壓測。數(shù)據(jù)庫需滿足如下前提條件:
- 源數(shù)據(jù)庫僅支持 RDS MySQL 高可用系列或三節(jié)點(diǎn)企業(yè)系列、PolarDB MySQL 版的集群版。
- 目標(biāo)數(shù)據(jù)庫實(shí)例為 RDS MySQL、PolarDB MySQL 版。
- 實(shí)例已接入 DAS,詳情請參見接入阿里云數(shù)據(jù)庫實(shí)例。
- 需開啟 DAS 企業(yè)版,詳情請參見 DAS 企業(yè)版。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TaskType | string | 是 | 壓測任務(wù)類型。取值:
| pressure test |
SrcInstanceId | string | 是 | 源實(shí)例 ID,僅支持 RDS MySQL、PolarDB MySQL 版實(shí)例,您可通過調(diào)用 GetInstanceInspections 接口獲取。 說明
當(dāng) DstType 為 Instance 時(shí),本參數(shù)需要傳入。
| rm-2ze1jdv45i7l6**** |
Description | string | 是 | 壓測任務(wù)描述。 | test-das-bench-0501 |
SrcPublicIp | string | 否 | 備用參數(shù)。 | None |
DstInstanceId | string | 否 | 目標(biāo)實(shí)例 ID,僅支持 RDS MySQL、PolarDB MySQL 版實(shí)例,您可通過調(diào)用 GetInstanceInspections 接口獲取。 說明
當(dāng) DstType 為 Instance 時(shí),本參數(shù)需要傳入。
| rm-2ze1jdv45i7l6**** |
GatewayVpcId | string | 否 | 數(shù)據(jù)庫網(wǎng)關(guān)的專有網(wǎng)絡(luò) ID。 說明
若 ClientType 取值為 ECS,則此參數(shù)必傳入。
| vpc-t4nsnwvpbc1h76ja4**** |
GatewayVpcIp | string | 否 | 數(shù)據(jù)庫網(wǎng)關(guān)的 IP 地址或域名。 說明
若 ClientType 取值為 ECS,則此參數(shù)必傳入。
| 172.30.XX.XX |
ClientType | string | 是 | 壓測機(jī)器類型。取值:
| ECS |
RequestStartTime | string | 否 | 壓測任務(wù)的開始時(shí)間,格式為 Unix 時(shí)間戳,單位為毫秒。 | 1608888296000 |
RequestEndTime | string | 否 | 壓測任務(wù)的結(jié)束時(shí)間,格式為 Unix 時(shí)間戳,單位為毫秒。 | 1608888296001 |
RequestDuration | string | 否 | 壓測任務(wù)的持續(xù)時(shí)間,單位為毫秒。 | 86400000 |
Rate | string | 否 | 源實(shí)例流量在目標(biāo)實(shí)例上的回放速度,回放速度必須是正整數(shù),取值:1~30,默認(rèn)為 1。 | 1 |
SmartPressureTime | string | 否 | 生成壓測的持續(xù)時(shí)間,單位為毫秒。 說明
當(dāng) TaskType 為smart pressure test時(shí)本參數(shù)需要傳入。
| 86400000 |
DtsJobClass | string | 否 | DTS 遷移任務(wù)規(guī)格,您可以通過調(diào)用 DescribeCloudbenchTask 接口獲取。 說明
壓測任務(wù)需要先將源實(shí)例基準(zhǔn)數(shù)據(jù)遷移至目標(biāo)實(shí)例,當(dāng)您新建 DTS 任務(wù)時(shí)需要傳入本參數(shù)。
| medium |
DtsJobId | string | 否 | DTS 遷移任務(wù) ID,您可調(diào)用 ConfigureDtsJob 接口獲取。 說明
已在 DTS 控制臺創(chuàng)建完 DTS 任務(wù)時(shí)本參數(shù)必傳入。
| 23127 |
SrcSuperAccount | string | 否 | 源端實(shí)例高權(quán)限賬號。取值:admin。 說明
當(dāng) DstType 為 Instance 時(shí),本參數(shù)需要傳入。
| admin |
SrcSuperPassword | string | 否 | 源端實(shí)例高權(quán)限賬號的密碼。 說明
當(dāng) DstType 為 Instance 時(shí),本參數(shù)需要傳入。
| test123 |
DstSuperAccount | string | 否 | 目標(biāo)實(shí)例的高權(quán)限賬號。 | root |
DstSuperPassword | string | 否 | 目標(biāo)實(shí)例高權(quán)限賬號的密碼。 | test123 |
DstType | string | 否 | 目標(biāo)實(shí)例的類型。取值:
| Instance |
DstConnectionString | string | 否 | 目標(biāo)實(shí)例的連接地址,僅支持 RDS MySQL、PolarDB MySQL 版實(shí)例。 說明
DstType 為 ConnectionString 本參數(shù)有效。
| rm-de21209****.mysql.rds.aliyuncs.com |
DstPort | string | 否 | 目標(biāo)實(shí)例的端口。 說明
DstType 為 ConnectionString 本參數(shù)有效。
| 3306 |
WorkDir | string | 否 | 壓測生成的臨時(shí)目錄。 | /tmp/bench/ |
BackupId | string | 否 | 備份集 ID,可通過查詢備份列表接口 DescribeBackups 獲取。 | 229132 |
BackupTime | string | 否 | 備份的時(shí)間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時(shí)間)。 | 2021-04-23T13:22:14Z |
Amount | string | 否 | 創(chuàng)建壓測任務(wù)的總個(gè)數(shù),取值:0~30,默認(rèn)為 1。 | 1 |
EndState | string | 否 | 壓測任務(wù)結(jié)束后的狀態(tài)。取值:
說明
當(dāng)壓測任務(wù)執(zhí)行完 EndState 設(shè)置的狀態(tài)之后,任務(wù)將直接到達(dá)完成狀態(tài)。
| WAIT_TARGET |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Data": {
"taskIds": [
"\"Data\": { \"total\": 1, \"list\":[...] }, \"Code\": 200, \"Success\": true }"
]
},
"Message": "Successful",
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 請求參數(shù)錯(cuò)誤 |
403 | NoPermission | You are not authorized to do this action. | 沒有權(quán)限執(zhí)行該操作 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|