执行压测任务的API接口_数据库自治服务(DAS)-阿里云帮助中心

调用RunCloudBenchTask接口，执行压测任务。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
hdm:RunCloudBenchTask	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
TaskId	string	是	任务 ID，您可通过 DescribeCloudBenchTasks 接口获取。	e5cec704-0518-430f-8263-76f4dcds****

返回参数

名称	类型	描述	示例值
	object
Code	string	返回的状态码。	200
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	请求是否执行成功： true：执行成功。 false：执行失败。	true
Data	object []	详细信息列表，包括信息总数、错误码等。
Status	string	任务的运行状态。取值： SUCCESS：成功。 IGNORED：忽略。 RUNNING：运行中。 EXCEPTION：异常。	SUCCESS
Order	integer	检查项的顺序，取值范围：0~10。	0
Code	integer	返回的状态码。	200
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
Name	string	检查项。取值： SqlArchiveStatusChecker：检查 SQL 洞察数据是否可用。 BenchClientEnvChecker：检查压测机上程序运行环境是否可用。 SpecChecker：检查压测目标规格和压测机规格是否可用。 SourceInstanceChecker：检查压测源实例账号和网络是否可用。 BenchTargetChecker：检查压测目标实例账号和网络是否可用。	BenchTargetChecker
Details	string	检查项的详细信息。	"Data": { "total": 1, "list":[...] }, "Code": 200, "Success": true }

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "PreCheckItem": [
      {
        "Status": "SUCCESS",
        "Order": 0,
        "Code": 200,
        "Message": "Successful",
        "Name": "BenchTargetChecker",
        "Details": "\"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.	没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史