RunCloudBenchTask - Database Autonomy Service - Alibaba Cloud Documentation Center

Calls the RunCloudBenchTask operation to execute a stress testing task.

Operation description

Database Autonomy Service (DAS) provides the intelligent stress testing feature. This feature helps you determine whether your instance type needs to be scaled out to handle peak service traffic. For more information, see Intelligent stress testing.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:RunCloudBenchTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The ID of the stress testing task. You can call the DescribeCloudBenchTasks operation to obtain the task ID.	e5cec704-0518-430f-8263-76f4dcds****

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The returned status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	object
PreCheckItem	array<object>	The list of detailed information, including the total number of information items, error codes, and more.
	object
Status	string	The status of the task. Valid values: SUCCESS: The task is successful. IGNORED: The task is ignored. RUNNING: The task is running. EXCEPTION: The task is abnormal.	SUCCESS
Order	integer	The order of the check item. Valid values: 0 to 10.	0
Code	integer	The returned status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
Name	string	The check item. Valid values: SqlArchiveStatusChecker: Checks whether the SQL insight data is available. BenchClientEnvChecker: Checks whether the execution environment on the stress testing client is available. SpecChecker: Checks whether the instance type of the destination instance and the instance type of the stress testing client are available. SourceInstanceChecker: Checks whether the account and network of the source instance are available. BenchTargetChecker: Checks whether the account and network of the destination instance are available.	BenchTargetChecker
Details	string	The details of the check item.	"Data": { "total": 1, "list":[...] }, "Code": 200, "Success": true }

Examples

Success response

JSON format

{
  "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 }"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.