RunCloudBenchTask - Database Autonomy Service

Runs a stress testing task.

Operation description

Database Autonomy Service (DAS) provides the intelligent stress testing feature. This feature helps you check whether your instance needs to be scaled up to effectively handle traffic spikes. For more information, see Intelligent stress testing.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:RunCloudBenchTask	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code returned.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, 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 false	true
Data	array<object>	The detailed information, including the error codes and the number of returned entries.
PreCheckItem	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: An error occurred.	SUCCESS
Order	integer	The sequence number of the check item. Valid values: 0 to 10.	0
Code	integer	The HTTP status code returned.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
Name	string	The name of the check item. Valid values: SqlArchiveStatusChecker: checks whether SQL Explorer is available. BenchClientEnvChecker: checks whether the runtime environment for programs on the stress testing client is available. SpecChecker: checks whether the destination instance type and the instance type of the stress testing client support this API operation. SourceInstanceChecker: checks whether the account of the source instance is available and whether the source instance is connected to the destination instance. BenchTargetChecker: checks whether the account of the destination instance is available and whether the source instance is connected to the destination instance.	BenchTargetChecker
Details	string	The detailed information of the check item.	"Data": { "total": 1, "list":[...] }, "Code": 200, "Success": true }

Examples

Sample success responses

JSONformat

{
  "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
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history