DescribeCloudbenchTaskConfig - Database Autonomy Service

Queries the configurations of 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The 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	object	The detailed information, including the error codes and the number of entries that are returned.
WorkDir	string	The path of the temporary directory that is generated for stress testing.	/tmp/bench/
ArchiveFolder	string	The path in which the files are archived.	/tmp/das/cloudbench/archive-sqls/
MetaFilePath	string	The path to 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 stored in Object Storage Service (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 command that was run to start the stress testing task.	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 file that stores the analysis result of full SQL statistics and that is stored 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 that was run to preload the file that stores the analysis result of full SQL statistics.	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 where the RocksDB storage system is deployed in the stress testing client.	/tmp/das/cloudbench/rocksdb
ParseCmd	string	The command that was run to parse the file that stores the analysis result of full SQL statistics.	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 file that stores the analysis result of full SQL statistics.	cl-1621353601000-360****.sc
ClientJarPath	string	The path to the JAR file that is used for stress testing.	/tmp/das/cloudbench/CloudBenchClient.jar
SqlFilePath	string	The path to the file that stores the analysis result of full SQL statistics.	/tmp/das/cloudbench/cl-1621353601000-360****.sc
ParseFilePath	string	The path to the file that is parsed. The file stores the analysis result of full SQL statistics.	/tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc****.archiveSql
JarOnOss	string	The path to the JAR file that is stored in OSS. The JAR file is used for stress testing.	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

Sample success responses

JSONformat

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