调用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. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|