CreateCloudBenchTasks_数据库自治服务_API文档-阿里云OpenAPI开发者门户

接口说明

数据库自治服务 DAS 提供智能压测功能，帮助您验证您的实例规格是否需要扩容，有效应对业务流量高峰。更多信息，请参见智能压测。数据库需满足如下前提条件：

源数据库仅支持 RDS MySQL 高可用系列或三节点企业系列、PolarDB MySQL 版的集群版。
目标数据库实例为 RDS MySQL、PolarDB MySQL 版。
实例已接入 DAS，详情请参见接入阿里云数据库实例。
需开启 DAS 企业版，详情请参见 DAS 企业版。

流控信息

请求速率为60/1(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

hdm:CreateCloudBenchTasks	Create	全部资源 *	无	无

请求参数

字段名称	字段详情
TaskTypestring	压测任务类型。取值：展开详情示例值:pressure test
SrcInstanceIdstring	源实例 ID，仅支持 RDS MySQL、PolarDB MySQL 版实例，您可通过调用 GetInstanceInspections 接口获取。展开详情示例值:rm-2ze1jdv45i7l6****
Descriptionstring	压测任务描述。示例值:test-das-bench-0501
SrcPublicIpstring	备用参数。示例值:None
DstInstanceIdstring	目标实例 ID，仅支持 RDS MySQL、PolarDB MySQL 版实例，您可通过调用 GetInstanceInspections 接口获取。展开详情示例值:rm-2ze1jdv45i7l6****
GatewayVpcIdstring	数据库网关的专有网络 ID。展开详情示例值:vpc-t4nsnwvpbc1h76ja4****
GatewayVpcIpstring	数据库网关的 IP 地址或域名。展开详情示例值:172.30.XX.XX
ClientTypestring	压测机器类型。取值：展开详情示例值:ECS
RequestStartTimestring	压测任务的开始时间，格式为 Unix 时间戳，单位为毫秒。示例值:1608888296000
RequestEndTimestring	压测任务的结束时间，格式为 Unix 时间戳，单位为毫秒。示例值:1608888296001
RequestDurationstring	压测任务的持续时间，单位为毫秒。示例值:86400000
Ratestring	源实例流量在目标实例上的回放速度，回放速度必须是正整数，取值：1~30，默认为 1。示例值:1
SmartPressureTimestring	生成压测的持续时间，单位为毫秒。展开详情示例值:86400000
DtsJobClassstring	DTS 迁移任务规格，您可以通过调用 DescribeCloudbenchTask 接口获取。展开详情示例值:medium
DtsJobIdstring	DTS 迁移任务 ID，您可调用 ConfigureDtsJob 接口获取。展开详情示例值:23127
SrcSuperAccountstring	源端实例高权限账号。取值：admin。展开详情示例值:admin
SrcSuperPasswordstring	源端实例高权限账号的密码。展开详情示例值:test123
DstSuperAccountstring	目标实例的高权限账号。示例值:root
DstSuperPasswordstring	目标实例高权限账号的密码。示例值:test123
DstTypestring	目标实例的类型。取值：展开详情示例值:Instance
DstConnectionStringstring	目标实例的连接地址，仅支持 RDS MySQL、PolarDB MySQL 版实例。展开详情示例值:rm-de21209****.mysql.rds.aliyuncs.com
DstPortstring	目标实例的端口。展开详情示例值:3306
WorkDirstring	压测生成的临时目录。示例值:/tmp/bench/
BackupIdstring	备份集 ID，可通过查询备份列表接口 DescribeBackups 获取。示例值:229132
BackupTimestring	备份的时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。示例值:2021-04-23T13:22:14Z
Amountstring	创建压测任务的总个数，取值：0~30，默认为 1。示例值:1
EndStatestring	压测任务结束后的状态。取值：展开详情示例值:WAIT_TARGET

返回参数

字段名称	字段详情
Codestring	返回的状态码。示例值:200
Messagestring	请求返回消息。展开详情示例值:Successful
RequestIdstring	请求 ID。示例值:B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring	请求是否执行成功：展开详情示例值:true
Dataobject

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InvalidParams	The request parameters are invalid.	诊断
403	NoPermission	You are not authorized to do this action.	诊断

变更历史

	变更时间	变更内容概要	操作
	2021-05-10	新增OpenAPI，创建压测任务