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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCloudbenchTask

系统规定参数。取值:DescribeCloudbenchTask

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

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

返回数据

名称 类型 示例值 描述
Code String 200

返回的状态码。

Message String Successful

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

请求ID。

Success String true

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
Data Object

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

DtsJobName String RDS间迁移

DTS的任务名称。

ErrorMessage String 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 String Null

其他信息。

BackupType String TIMESTAMP

备份类型。取值:

  • TIMESTAMP:按备份时间。
  • BACKUPID:按备份集ID。
UserId String 109141182625****

阿里云账号ID。

DstType String Instance

目标实例的类型。取值:

  • Instance(默认):实例ID。
  • ConnectionString:实例的连接地址。
EcsInstanceId String i-bp1ecr5go2go1****

ECS的实例ID。

DstInstanceUuid String hdm_d887b5ccf99fa0dc9a1e5aaac368****

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

TaskType String pressure test

压测任务类型。取值:

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

压测的子步骤。取值:

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

压测任务版本。取值:

  • V2.0
  • V3.0
EndState String WAIT_LOGIC

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

  • WAIT_TARGET:准备压测的目标实例。
  • WAIT_DBGATEWAY:准备压测部署。
  • WAIT_SQL:准备全量SQL。
  • WAIT_LOGIC:准备开始回放流量。
说明 当压测任务执行完EndState设置的状态之后,任务将直接到达完成状态。
SrcInstanceUuid String a364e414-e68b-4e5c-9166-65b3a153****

源实例的唯一标识符号。

ClientType String ECS

压测机器类型。取值:

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

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

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

备用参数。

SrcPublicIp String None

备用参数。

BackupId String 229132

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

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

全量SQL的复用信息。

SmartPressureTime Integer 86400000

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

ArchiveState Integer 1

SQL归档状态,取值:

  • 0:未开始。
  • 1:完成。
  • 2:错误。
  • 3:运行中。
  • 4:无需下载。
Status String RUNNING

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

  • SUCCESS:成功。
  • IGNORED:忽略。
  • RUNNING:运行中。
  • EXCEPTION:异常。
WorkDir String /tmp/bench/

压测生成的临时目录。

ArchiveOssTableName String custins15546355_161604665****

归档的OSS表名。

DtsJobId String i03e3zty16i****

DTS迁移任务ID。

DtsJobState Integer CHECKING

DTS任务状态,取值:

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

目标实例的端口。

DtsJobClass String medium

DTS任务规格。

ClientGatewayId String 58598b2af48a0193dfc16fc6964ef****

压测机的数据库网关ID。

Description String test-das-bench-0501

压测任务描述。

ErrorCode String 10910

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

TableSchema String [{"TABLE_NAME":"customer1","TABLE_SCHEMA":"tpcc"}]

压测中涉及的表名。

DtsJobStatus String PRE_CHECKING

DTS任务状态,取值:

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

源实例的数据库类型。

BenchStepStatus String FINISHED

压测子步骤状态。取值:

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

任务来源。取值:

  • DAS
  • OPEN_API
ArchiveJobId String '202105211430070112231480820340758****

归档任务ID。

Topic String das

kafka的消费Topic。

RequestDuration Long 864000

压测任务的持续时间。

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

任务ID。

Rate Long 1

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

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=DescribeCloudbenchTask
&TaskId=e5cec704-0518-430f-8263-76f4dcds****
&公共请求参数

正常返回示例

XML格式

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

<DescribeCloudbenchTaskResponse>
    <Code>200</Code>
    <Message>Successful</Message>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Success>true</Success>
    <Data>
        <DtsJobName>RDS间迁移</DtsJobName>
        <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].</ErrorMessage>
        <External>Null</External>
        <BackupType>TIMESTAMP</BackupType>
        <UserId>109141182625****</UserId>
        <DstType>Instance</DstType>
        <EcsInstanceId>i-bp1ecr5go2go1****</EcsInstanceId>
        <DstInstanceUuid>hdm_d887b5ccf99fa0dc9a1e5aaac368****</DstInstanceUuid>
        <TaskType>pressure test</TaskType>
        <BenchStep>PROCEED</BenchStep>
        <Version>V3.0</Version>
        <EndState>WAIT_LOGIC</EndState>
        <SrcInstanceUuid>a364e414-e68b-4e5c-9166-65b3a153****</SrcInstanceUuid>
        <ClientType>ECS</ClientType>
        <State>WAIT_TARGET</State>
        <DstIp>rm-2ze1jdv45i7l64r****.mysql.rds.aliyuncs.com</DstIp>
        <SrcPublicIp>rm-2ze1jdv45i7l64r****.mysql.rds.aliyuncs.com</SrcPublicIp>
        <BackupId>12345</BackupId>
        <SqlCompleteReuse>{"sqlUuid":"task_a37d2f07-45cb-****-a2a6-c66c62****","metaUuid":"task_211e2561-5c0c-486b-864c-56b511****","sqlFile":"cl-1620057600000-1800626.sc","metaFile":"cl-1620057600000-180****.meta"}</SqlCompleteReuse>
        <SmartPressureTime>864000</SmartPressureTime>
        <ArchiveState>1</ArchiveState>
        <Status>RUNNING</Status>
        <WorkDir>/tmp/bench/</WorkDir>
        <ArchiveOssTableName>custins15546355_161604665****</ArchiveOssTableName>
        <DtsJobId>i03e3zty16i****</DtsJobId>
        <DstPort>3306</DstPort>
        <DtsJobClass>medium</DtsJobClass>
        <ClientGatewayId>58598b2af48a0193dfc16fc6964ef****</ClientGatewayId>
        <Description>test-das-bench-0501</Description>
        <ErrorCode>10910</ErrorCode>
        <TableSchema>[{"TABLE_NAME":"customer1","TABLE_SCHEMA":"tpcc"}]</TableSchema>
        <DtsJobStatus>PRE_CHECKING</DtsJobStatus>
        <SrcInstanceArea>RDS</SrcInstanceArea>
        <BenchStepStatus>FINISHED</BenchStepStatus>
        <Source>DAS</Source>
        <ArchiveJobId>'202105211430070112231480820340758****</ArchiveJobId>
        <Topic>das</Topic>
        <RequestDuration>864000</RequestDuration>
        <TaskId>e5cec704-0518-430f-8263-76f4dcds****</TaskId>
        <Rate>1</Rate>
    </Data>
</DescribeCloudbenchTaskResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "rm-2ze1jdv45i7l64r****.mysql.rds.aliyuncs.com",
    "SrcPublicIp" : "rm-2ze1jdv45i7l64r****.mysql.rds.aliyuncs.com",
    "BackupId" : "12345",
    "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" : 864000,
    "ArchiveState" : 1,
    "Status" : "RUNNING",
    "WorkDir" : "/tmp/bench/",
    "ArchiveOssTableName" : "custins15546355_161604665****",
    "DtsJobId" : "i03e3zty16i****",
    "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
  }
}

错误码

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