Queries the configuration of a stress testing task.

Database Autonomy Service (DAS) provides the intelligent stress testing feature. This feature checks whether your instance specifications need to be scaled up to efficiently handle workloads during peak hours. For more information, see Intelligent stress testing.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCloudbenchTaskConfig

The operation that you want to perform. Set the value to DescribeCloudbenchTaskConfig.

TaskId String Yes e5cec704-0518-430f-8263-76f4dcds****

The ID of the stress testing task. You can call the DescribeCloudBenchTasks operation to query the ID.

Response parameters

Parameter Type Example Description
Code String 200

The returned HTTP status code.

Message String Successful

The message that is returned for the request.

Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

The ID of the request.

Success String true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
Data Object

The details of the response, such as the HTTP status code and the number of returned entries.

WorkDir String /tmp/bench/

The temporary directory generated for stress testing.

ArchiveFolder String /tmp/das/cloudbench/archive-sqls/

The path in which the files are archived.

MetaFilePath String /tmp/das/cloudbench/cl-1621353601000-360****.meta

The path to the metadata file.

MetaFileName String cl-1621353601000-360****.meta

The name of the metadata file.

MetaFileOnOss String "https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.meta?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=Qsehg3tzeA57M%2BIixAbWPWAtvl****

The name of the metadata file stored in Object Storage Service (OSS).

UserId String 1091411816252****

The ID of the Alibaba Cloud account.

BenchCmd String 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

The command used to start the stress testing task.

SqlFileOnOss String https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.sc?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=LYMADwo%2BRrJeqR3e4d8OlIkVmw****

The name of the file that stores the analysis result of full SQL statistics and that is stored in OSS.

LoadCmd String 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

The command used to preload the file that stores the analysis result of full SQL statistics.

RocksDbPath String /tmp/das/cloudbench/rocksdb

The location where the RocksDB storage system is deployed in the stress testing client.

ParseCmd String 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

The command used to parse the file that stores the analysis result of full SQL statistics.

SqlFileName String cl-1621353601000-360****.sc

The name of the file that stores the analysis result of full SQL statistics.

ClientJarPath String /tmp/das/cloudbench/CloudBenchClient.jar

The path to the JAR file that is used for stress testing.

SqlFilePath String /tmp/das/cloudbench/cl-1621353601000-360****.sc

The path to the file that stores the analysis result of full SQL statistics.

ParseFilePath String /tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc****.archiveSql

The path to the file that is parsed. The file is the one that stores the analysis result of full SQL statistics.

JarOnOss String https://cloudbench-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/CloudBenchClient.jar?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=28p%2BCe4tNHpr9VPOcHc3Si9iOb****

The path to the JAR file that is stored in OSS. The JAR file is used for stress testing.

TaskId String e5cec704-0518-430f-8263-76f4dcds****

The ID of the stress testing task.

Examples

Sample requests

http(s)://das.cn-shanghai.aliyuncs.com/?Action=DescribeCloudbenchTaskConfig
&TaskId=e5cec704-0518-430f-8263-76f4dcds****
&<Common request parameters>

Sample responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCloudbenchTaskConfigResponse>
    <Code>200</Code>
    <Message>Successful</Message>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Success>true</Success>
    <Data>
        <WorkDir>/tmp/bench/</WorkDir>
        <ArchiveFolder>/tmp/das/cloudbench/archive-sqls/</ArchiveFolder>
        <MetaFilePath>/tmp/das/cloudbench/cl-1621353601000-360****.meta</MetaFilePath>
        <MetaFileName>cl-1621353601000-360****.meta</MetaFileName>
        <MetaFileOnOss>"https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.meta?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&amp;Expires=1622441372&amp;Signature=Qsehg3tzeA57M%2BIixAbWPWAtvl****</MetaFileOnOss>
        <UserId>1091411816252****</UserId>
        <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 &gt; /tmp/das/cloudbench/null.log</BenchCmd>
        <SqlFileOnOss>https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.sc?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&amp;Expires=1622441372&amp;Signature=LYMADwo%2BRrJeqR3e4d8OlIkVmw****</SqlFileOnOss>
        <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</LoadCmd>
        <RocksDbPath>/tmp/das/cloudbench/rocksdb</RocksDbPath>
        <ParseCmd>cd /tmp/das/cloudbench &amp;&amp; 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</ParseCmd>
        <SqlFileName>cl-1621353601000-360****.sc</SqlFileName>
        <ClientJarPath>/tmp/das/cloudbench/CloudBenchClient.jar</ClientJarPath>
        <SqlFilePath>/tmp/das/cloudbench/cl-1621353601000-360****.sc</SqlFilePath>
        <ParseFilePath>/tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc****.archiveSql</ParseFilePath>
        <JarOnOss>https://cloudbench-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/CloudBenchClient.jar?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&amp;Expires=1622441372&amp;Signature=28p%2BCe4tNHpr9VPOcHc3Si9iOb****</JarOnOss>
        <TaskId>e5cec704-0518-430f-8263-76f4dcds****</TaskId>
    </Data>
</DescribeCloudbenchTaskConfigResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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****&amp;Expires=1622441372&amp;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 &gt; /tmp/das/cloudbench/null.log",
    "SqlFileOnOss" : "https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.sc?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&amp;Expires=1622441372&amp;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 &amp;&amp; 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****&amp;Expires=1622441372&amp;Signature=28p%2BCe4tNHpr9VPOcHc3Si9iOb****",
    "TaskId" : "e5cec704-0518-430f-8263-76f4dcds****"
  }
}

Error codes

HttpCode Error code Error message Description
400 InvalidParams The request parameters are invalid. The error message returned because the specified request parameters are invalid.

For a list of error codes, visit the API Error Center.