全部產品
Search
文件中心

Database Autonomy Service:DescribeCloudbenchTaskConfig - 查詢壓測任務配置

更新時間:Apr 21, 2026

調用DescribeCloudbenchTaskConfig介面,查詢壓測任務配置資訊。

介面說明

資料庫自治服務 DAS 提供智能壓測功能,協助您驗證您的執行個體規格是否需要擴容,有效應對業務流量高峰。更多資訊,請參見智能壓測

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:DescribeCloudbenchTaskConfig

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

TaskId

string

任務 ID,您可通過 DescribeCloudBenchTasks 介面擷取。

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

返回參數

名稱

類型

描述

樣本值

object

Code

string

返回的狀態代碼。

200

Message

string

請求返回訊息。

說明

請求成功時該參數返回 Successful,請求失敗時會返回請求異常資訊(如錯誤碼等)。

Successful

RequestId

string

請求 ID。

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

Success

string

請求是否執行成功:

  • true:執行成功。

  • false:執行失敗。

true

Data

object

詳細資料列表,包括資訊總數、錯誤碼等。

WorkDir

string

壓測產生的臨時目錄。

/tmp/bench/

ArchiveFolder

string

歸檔檔案路徑。

/tmp/das/cloudbench/archive-sqls/

MetaFilePath

string

元檔案路徑。

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

MetaFileName

string

元檔案名稱。

cl-1621353601000-360****.meta

MetaFileOnOss

string

元檔案在 OSS 的名稱。

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

UserId

string

阿里雲帳號 ID。

1091411816252****

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

SqlFileOnOss

string

全量 SQL 檔案在 OSS 的名稱。

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

LoadCmd

string

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

RocksDbPath

string

RocksDB 儲存系統在壓測機中的位置。

/tmp/das/cloudbench/rocksdb

ParseCmd

string

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

SqlFileName

string

全量 SQL 檔案名稱。

cl-1621353601000-360****.sc

ClientJarPath

string

壓測 Jar 包路徑。

/tmp/das/cloudbench/CloudBenchClient.jar

SqlFilePath

string

SQL 檔案路徑。

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

ParseFilePath

string

解析後的 SQL 檔案路徑。

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

JarOnOss

string

壓測 Jar 包在 OSS 的路徑。

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

TaskId

string

任務 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

錯誤碼

錯誤資訊

描述

400 InvalidParams The request parameters are invalid. 請求參數錯誤
403 NoPermission You are not authorized to do this action. 沒有許可權執行該操作

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情