文档

DescribeCloudbenchTaskConfig - 查询压测任务配置

更新时间:

调用DescribeCloudbenchTaskConfig接口,查询压测任务配置信息。

接口说明

数据库自治服务 DAS 提供智能压测功能,帮助您验证您的实例规格是否需要扩容,有效应对业务流量高峰。更多信息,请参见智能压测

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
TaskIdstring

任务 ID,您可通过 DescribeCloudBenchTasks 接口获取。

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

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true
Dataobject

详细信息列表,包括信息总数、错误码等。

WorkDirstring

压测生成的临时目录。

/tmp/bench/
ArchiveFolderstring

归档文件路径。

/tmp/das/cloudbench/archive-sqls/
MetaFilePathstring

元文件路径。

/tmp/das/cloudbench/cl-1621353601000-360****.meta
MetaFileNamestring

元文件名。

cl-1621353601000-360****.meta
MetaFileOnOssstring

元文件在 OSS 的名称。

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

阿里云账号 ID。

1091411816252****
BenchCmdstring

压测的命令。

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
SqlFileOnOssstring

全量 SQL 文件在 OSS 的名称。

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

SQL 文件预加载的命令。

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
RocksDbPathstring

RocksDB 存储系统在压测机中的位置。

/tmp/das/cloudbench/rocksdb
ParseCmdstring

SQL 文件解析的命令。

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
SqlFileNamestring

全量 SQL 文件名。

cl-1621353601000-360****.sc
ClientJarPathstring

压测 Jar 包路径。

/tmp/das/cloudbench/CloudBenchClient.jar
SqlFilePathstring

SQL 文件路径。

/tmp/das/cloudbench/cl-1621353601000-360****.sc
ParseFilePathstring

解析后的 SQL 文件路径。

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

压测 Jar 包在 OSS 的路径。

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

任务 ID。

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

示例

正常返回示例

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****&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****"
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈