DescribeCloudbenchTaskConfig - Database Autonomy Service

Retrieves the detailed configuration, file paths, and execution commands for a specific stress test task.

Operation description

Call this API to get the configuration details of a stress testing task for advanced debugging, or to understand how the Database Autonomy Service (DAS) stress testing feature operates. 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:DescribeCloudbenchTaskConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The unique ID of the stress test task. You can call the DescribeCloudBenchTasks API to get 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 When the request is successful, this parameter returns Successful. When the request fails, this parameter returns exception information (such as error codes).	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request is successful: true: The request is successful. false: The request fails.	true
Data	object	The list of detailed information, including the total number of information items, error codes, and other details.
WorkDir	string	The temporary directory generated for stress testing.	/tmp/bench/
ArchiveFolder	string	The path of archived objects.	/tmp/das/cloudbench/archive-sqls/
MetaFilePath	string	The path of the metadata file.	/tmp/das/cloudbench/cl-1621353601000-360****.meta
MetaFileName	string	The name of the metadata file.	cl-1621353601000-360****.meta
MetaFileOnOss	string	The name of the metadata file in OSS.	"https://cb-rm-bp1w9g06h560l**.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360.meta?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK&Expires=1622441372&Signature=Qsehg3tzeA57M%2BIixAbWPWAtvl**
UserId	string	The Alibaba Cloud account ID.	1091411816252****
BenchCmd	string	The stress testing command.	java -jar /tmp/das/cloudbench/CloudBenchClient.jar --bench --rocksdb /tmp/das/cloudbench/rocksdb --meta /tmp/das/cloudbench/cl-1621353601000-360**.meta --task_name 2777bba9-a836-49e6-9f70-1c3822fc9239 --result_file /tmp/das/cloudbench/null.result --user cloudb --pwd \"cloudbench@\" --host rm-bp1j5f8s5x26kq79216**.mysql.rds.aliyuncs.com --port 3306 --charset utf8mb4 --interval 1 --bench_time 3600 --rate_factor 1.0 --start_time 1621353601 --rt > /tmp/das/cloudbench/null.log
SqlFileOnOss	string	The name of the full SQL file in OSS.	https://cb-rm-bp1w9g06h560l**.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360.sc?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK&Expires=1622441372&Signature=LYMADwo%2BRrJeqR3e4d8OlIkVmw**
LoadCmd	string	The command for preloading the SQL file.	java -jar /tmp/das/cloudbench/CloudBenchClient.jar --load --out /tmp/das/cloudbench/cl-1621353601000-360**.sc --meta /tmp/das/cloudbench/cl-1621353601000-360.meta --task_name 2777bba9--49e6-9f70-1c3822fc** --rocksdb /tmp/das/cloudbench/rocksdb
RocksDbPath	string	The location of the RocksDB storage system in the stress testing machine.	/tmp/das/cloudbench/rocksdb
ParseCmd	string	The command for parsing the SQL file.	cd /tmp/das/cloudbench && java -jar CloudBenchClient.jar --parse --threads 32 --file /tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc9239.archiveSql --meta /tmp/das/cloudbench/cl-1621353601000-360**.meta --out /tmp/das/cloudbench/cl-1621353601000-360.sc --parent_patmp/das/cloudbench --source RDS --h /thost rm-bp1j5f8s5x266.mysql.rds.aliyuncs.com --port 3306 --user cloudb --pwd \"cloudbench@**\" --cutSqlLen 8192 --db_black_list=information_schema,test,unknow,null
SqlFileName	string	The name of the full SQL file.	cl-1621353601000-360****.sc
ClientJarPath	string	The path of the stress testing JAR package.	/tmp/das/cloudbench/CloudBenchClient.jar
SqlFilePath	string	The path of the SQL file.	/tmp/das/cloudbench/cl-1621353601000-360****.sc
ParseFilePath	string	The path of the parsed SQL file.	/tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc****.archiveSql
JarOnOss	string	The path of the stress testing JAR package in OSS.	https://cloudbench-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/CloudBenchClient.jar?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK**&Expires=1622441372&Signature=28p%2BCe4tNHpr9VPOcHc3Si9iOb**
TaskId	string	The task ID.	e5cec704-0518-430f-8263-76f4dcds****

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "WorkDir": "/tmp/bench/",
    "ArchiveFolder": "/tmp/das/cloudbench/archive-sqls/",
    "MetaFilePath": "/tmp/das/cloudbench/cl-1621353601000-360****.meta",
    "MetaFileName": "cl-1621353601000-360****.meta",
    "MetaFileOnOss": "\"https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.meta?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=Qsehg3tzeA57M%2BIixAbWPWAtvl****",
    "UserId": "1091411816252****",
    "BenchCmd": "java -jar /tmp/das/cloudbench/CloudBenchClient.jar --bench --rocksdb /tmp/das/cloudbench/rocksdb --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --task_name 2777bba9-a836-49e6-9f70-1c3822fc9239 --result_file /tmp/das/cloudbench/null.result --user cloudb**** --pwd \\\"cloudbench@****\\\" --host rm-bp1j5f8s5x26kq79216****.mysql.rds.aliyuncs.com --port 3306 --charset utf8mb4 --interval 1 --bench_time 3600 --rate_factor 1.0 --start_time 1621353601 --rt > /tmp/das/cloudbench/null.log",
    "SqlFileOnOss": "https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.sc?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=LYMADwo%2BRrJeqR3e4d8OlIkVmw****",
    "LoadCmd": "java -jar /tmp/das/cloudbench/CloudBenchClient.jar --load --out /tmp/das/cloudbench/cl-1621353601000-360****.sc --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --task_name 2777bba9-****-49e6-9f70-1c3822fc**** --rocksdb /tmp/das/cloudbench/rocksdb",
    "RocksDbPath": "/tmp/das/cloudbench/rocksdb",
    "ParseCmd": "cd /tmp/das/cloudbench && java -jar CloudBenchClient.jar --parse --threads 32 --file /tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc9239.archiveSql --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --out /tmp/das/cloudbench/cl-1621353601000-360****.sc --parent_patmp/das/cloudbench --source RDS --h /thost rm-bp1j5f8s5x266****.mysql.rds.aliyuncs.com --port 3306 --user cloudb**** --pwd \\\"cloudbench@****\\\" --cutSqlLen 8192 --db_black_list=information_schema,test,unknow,null",
    "SqlFileName": "cl-1621353601000-360****.sc",
    "ClientJarPath": "/tmp/das/cloudbench/CloudBenchClient.jar",
    "SqlFilePath": "/tmp/das/cloudbench/cl-1621353601000-360****.sc",
    "ParseFilePath": "/tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc****.archiveSql",
    "JarOnOss": "https://cloudbench-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/CloudBenchClient.jar?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=28p%2BCe4tNHpr9VPOcHc3Si9iOb****",
    "TaskId": "e5cec704-0518-430f-8263-76f4dcds****"
  }
}

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.