AI 助理
备案控制台
首页 数据库自治服务 开发参考 API参考 API目录 智能压测 DescribeCloudbenchTask - 查询压测任务

DescribeCloudbenchTask - 查询压测任务

更新时间: 2024-11-14 23:27:47

调用DescribeCloudbenchTask接口，查询压测任务。

接口说明

数据库自治服务 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

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

DtsJobNamestring

DTS 的任务名称。

RDS间迁移
ErrorMessagestring

任务失败的错误提示。

DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].
Externalstring

其他信息。

Null
BackupTypestring

备份类型。取值：

  • TIMESTAMP：按备份时间。
  • BACKUPID：按备份集 ID。
TIMESTAMP
UserIdstring

阿里云账号 ID。

109141182625****
DstTypestring

目标实例的类型。取值：

  • Instance（默认）：实例 ID。
  • ConnectionString：实例的连接地址。
Instance
EcsInstanceIdstring

ECS 的实例 ID。

i-bp1ecr5go2go1****
DstInstanceUuidstring

目标实例的唯一标识符号。

hdm_d887b5ccf99fa0dc9a1e5aaac368****
TaskTypestring

压测任务类型。取值：

  • pressure test（默认）：智能压测，将从源实例上捕获的流量，按照目标实例规格支持的极限速度，在目标实例上进行回放。
  • smart pressure test：生成压测，通过分析和学习短时间内在源实例上捕获的流量，生成和原始流量的业务模型和流量分布基本一致的流量进行持续压测，减少从源实例采集数据的时间，降低存储成本和性能开销。
pressure test
BenchStepstring

压测的子步骤。取值：

  • NEW：任务初始化。
  • WAIT_BUY_ECS：新购 ECS 实例。
  • WAIT_START_ECS：ECS 实例启动。
  • WAIT_INSTALL_JDK：安装 JDK。
  • WAIT_INSTALL_DBGATEWAY：安装 DBGateway。
  • ADD_SECURITY_IPS_STEP：配置安全组白名单。
  • ARCHIVE：全量 SQL 归档。
  • DOWNLOAD：下载全量 SQL 文件。
  • PROCEED：预处理全量 SQL 文件。
  • PRE_LOAD：预加载全量 SQL 文件。
  • VALIDATE：功能验证。
  • PRESSURE：性能压测。
PROCEED
Versionstring

压测任务版本。取值：

  • V2.0
  • V3.0
V3.0
EndStatestring

压测任务结束后的状态。取值：

  • WAIT_TARGET：准备压测的目标实例。
  • WAIT_DBGATEWAY：准备压测部署。
  • WAIT_SQL：准备全量 SQL。
  • WAIT_LOGIC：准备开始回放流量。
说明 当压测任务执行完 EndState 设置的状态之后，任务将直接到达完成状态。
WAIT_LOGIC
SrcInstanceUuidstring

源实例的唯一标识符号。

a364e414-e68b-4e5c-9166-65b3a153****
ClientTypestring

压测机器类型。取值：

  • ECS：您需要自己准备数据库网关。
  • DAS_ECS：DAS 自动购买和部署的 ECS。
ECS
Statestring

目前压测任务的状态。取值：

  • WAIT_TARGET：准备压测的目标实例。
  • WAIT_DBGATEWAY：准备压测部署。
  • WAIT_SQL：准备全量 SQL。
  • WAIT_LOGIC：准备开始回放流量。
WAIT_TARGET
DstIpstring

备用参数。

None
SrcPublicIpstring

备用参数。

None
BackupIdstring

备份集 ID，可通过查询备份列表接口 DescribeBackups 获取。

229132
SqlCompleteReusestring

全量 SQL 的复用信息。

{"sqlUuid":"task_a37d2f07-45cb-****-a2a6-c66c62****","metaUuid":"task_211e2561-5c0c-486b-864c-56b511****","sqlFile":"cl-1620057600000-1800626.sc","metaFile":"cl-1620057600000-180****.meta"}
SmartPressureTimeinteger

生成压测时间，单位为毫秒。

86400000
ArchiveStateinteger

SQL 归档状态，取值：

  • 0：未开始。
  • 1：完成。
  • 2：错误。
  • 3：运行中。
  • 4：无需下载。
1
Statusstring

压测任务的运行状态。取值：

  • SUCCESS：成功。
  • IGNORED：忽略。
  • RUNNING：运行中。
  • EXCEPTION：异常。
RUNNING
WorkDirstring

压测生成的临时目录。

/tmp/bench/
ArchiveOssTableNamestring

归档的 OSS 表名。

custins15546355_161604665****
DtsJobIdstring

DTS 迁移任务 ID。

i03e3zty16i****
DtsJobStateinteger

DTS 任务状态，取值：

  • NOT_STARTED：未启动。
  • PRE_CHECKING：预检查中。
  • PRE_CHECK_FAILED：预检查失败。
  • CHECKING：检查中。
  • MIGRATING：迁移中。
  • CATCHED：已经追平。
  • SUSPENDING：暂停中。
  • MIGRATION_FAILED：迁移失败。
  • FINISHED：完成。
  • INITIALIZING：同步初始化。
  • INITIALIZE_FAILED：同步初始化失败。
  • SYNCHRONIZING：同步中。
  • MODIFYING：同步对象变更中。
  • SWITCHING：切换中。
  • FAILED：失败。
CHECKING
DstPortinteger

目标实例的端口。

3306
DtsJobClassstring

DTS 任务规格。

medium
ClientGatewayIdstring

压测机的数据库网关 ID。

58598b2af48a0193dfc16fc6964ef****
Descriptionstring

压测任务描述。

test-das-bench-0501
ErrorCodestring

压测内部任务返回的错误码。

10910
TableSchemastring

压测中涉及的表名。

[{"TABLE_NAME":"customer1","TABLE_SCHEMA":"tpcc"}]
DtsJobStatusstring

DTS 任务状态，取值：

  • NOT_STARTED：未启动。
  • PRE_CHECKING：预检查中。
  • PRE_CHECK_FAILED：预检查失败。
  • CHECKING：检查中。
  • MIGRATING：迁移中。
  • CATCHED：已经追平。
  • SUSPENDING：暂停中。
  • MIGRATION_FAILED：迁移失败。
  • FINISHED：完成。
  • INITIALIZING：同步初始化。
  • INITIALIZE_FAILED：同步初始化失败。
  • SYNCHRONIZING：同步中。
  • MODIFYING：同步对象变更中。
  • SWITCHING：切换中。
  • FAILED：失败。
PRE_CHECKING
SrcInstanceAreastring

源实例的数据库类型。

RDS
BenchStepStatusstring

压测子步骤状态。取值：

  • NEW：任务初始化。
  • RUNNING：正在执行。
  • FAILED：失败。
  • FINISHED：已完成。
  • Terminated：已终止。
  • Deleted：已删除。
FINISHED
Sourcestring

任务来源。取值：

  • DAS。
  • OPEN_API。
DAS
ArchiveJobIdstring

归档任务 ID。

'202105211430070112231480820340758****
Topicstring

kafka 的消费 Topic。

das
RequestDurationlong

压测任务的持续时间。

864000
TaskIdstring

任务 ID。

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

压测倍率。回放倍率必须是正整数，取值范围为：0~30，默认为 1。

1

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "DtsJobName": "RDS间迁移",
    "ErrorMessage": "DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\\n\\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].",
    "External": "Null",
    "BackupType": "TIMESTAMP",
    "UserId": "109141182625****",
    "DstType": "Instance",
    "EcsInstanceId": "i-bp1ecr5go2go1****",
    "DstInstanceUuid": "hdm_d887b5ccf99fa0dc9a1e5aaac368****",
    "TaskType": "pressure test",
    "BenchStep": "PROCEED",
    "Version": "V3.0",
    "EndState": "WAIT_LOGIC",
    "SrcInstanceUuid": "a364e414-e68b-4e5c-9166-65b3a153****",
    "ClientType": "ECS",
    "State": "WAIT_TARGET",
    "DstIp": "None",
    "SrcPublicIp": "None",
    "BackupId": "229132",
    "SqlCompleteReuse": "{\"sqlUuid\":\"task_a37d2f07-45cb-****-a2a6-c66c62****\",\"metaUuid\":\"task_211e2561-5c0c-486b-864c-56b511****\",\"sqlFile\":\"cl-1620057600000-1800626.sc\",\"metaFile\":\"cl-1620057600000-180****.meta\"}",
    "SmartPressureTime": 86400000,
    "ArchiveState": 1,
    "Status": "RUNNING",
    "WorkDir": "/tmp/bench/",
    "ArchiveOssTableName": "custins15546355_161604665****",
    "DtsJobId": "i03e3zty16i****",
    "DtsJobState": 0,
    "DstPort": 3306,
    "DtsJobClass": "medium",
    "ClientGatewayId": "58598b2af48a0193dfc16fc6964ef****",
    "Description": "test-das-bench-0501",
    "ErrorCode": "10910",
    "TableSchema": "[{\"TABLE_NAME\":\"customer1\",\"TABLE_SCHEMA\":\"tpcc\"}]",
    "DtsJobStatus": "PRE_CHECKING",
    "SrcInstanceArea": "RDS",
    "BenchStepStatus": "FINISHED",
    "Source": "DAS",
    "ArchiveJobId": "'202105211430070112231480820340758****",
    "Topic": "das",
    "RequestDuration": 864000,
    "TaskId": "e5cec704-0518-430f-8263-76f4dcds****",
    "Rate": 1
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: DescribeCloudbenchTaskConfig - 查询压测任务配置 下一篇: DescribeCloudBenchTasks - 查询压测任务列表
文档推荐
阿里云首页 数据库自治服务 相关技术圈