All Products
Search

This Product

    Database Autonomy Service:DescribeCloudbenchTask

    Document Center

    Database Autonomy Service:DescribeCloudbenchTask

    Last Updated:Aug 21, 2026

    Queries a stress testing task.

    Operation description

    Database Autonomy Service (DAS) provides stress testing features to help you verify whether your instance specifications need to be scaled up to effectively handle service traffic peaks. For more information, see Intelligent stress testing.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hdm:DescribeCloudbenchTask

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TaskId

    string

    Yes

    The task ID. You can call the DescribeCloudBenchTasks operation to obtain the task ID.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The returned status code.

    200
    Message

    string

    The returned message.

    Note

    If the request is successful, Successful is returned. If the request fails, an error message is returned, such as an error code.

    Successful
    RequestId

    string

    The request ID.

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

    string

    Indicates whether the request is successful. Valid values:

    • true: The request is successful.

    • false: The request fails.

    true
    Data

    object

    The detailed information, including the total number of entries and error codes.

    DtsJobName

    string

    The name of the Data Transmission Service (DTS) task.

    Migration between RDS instances
    ErrorMessage

    string

    The error message returned when the task fails.

    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

    The additional information.

    Null
    BackupType

    string

    The backup type. Valid values:

    • TIMESTAMP: by backup time.

    • BACKUPID: by backup set ID.

    TIMESTAMP
    UserId

    string

    The Alibaba Cloud account ID.

    109141182625****
    DstType

    string

    The type of the target instance. Valid values:

    • Instance (default): instance ID.

    • ConnectionString: endpoint of the instance.

    Instance
    EcsInstanceId

    string

    The ECS instance ID.

    i-bp1ecr5go2go1****
    DstInstanceUuid

    string

    The unique identity of the target instance.

    hdm_d887b5ccf99fa0dc9a1e5aaac368****
    TaskType

    string

    The type of the stress testing task. Valid values:

    • pressure test (default): intelligent stress testing. The traffic captured from the target instance is replayed on the destination instance at the maximum speed supported by the destination instance specifications.

    • smart pressure test: generated stress testing. By analyzing and learning the traffic captured from the target instance within a short period of time, traffic that is consistent with the business model and traffic distribution of the original traffic is generated for continuous stress testing. This reduces the time required to collect data from the target instance and lowers storage costs and performance overhead.

    pressure test
    BenchStep

    string

    The substep of the stress testing task. Valid values:

    • NEW: task initialization.

    • WAIT_BUY_ECS: purchasing an ECS instance.

    • WAIT_START_ECS: starting the ECS instance.

    • WAIT_INSTALL_JDK: installing JDK.

    • WAIT_INSTALL_DBGATEWAY: installing DBGateway.

    • ADD_SECURITY_IPS_STEP: configuring the security group whitelist.

    • ARCHIVE: archiving full SQL.

    • DOWNLOAD: downloading the full SQL file.

    • PROCEED: preprocessing the full SQL file.

    • PRE_LOAD: preloading the full SQL file.

    • VALIDATE: functional verification.

    • PRESSURE: performance stress testing.

    PROCEED
    Version

    string

    The version of the stress testing task. Valid values:

    • V2.0

    • V3.0

    V3.0
    EndState

    string

    The state after the stress testing task ends. Valid values:

    • WAIT_TARGET: preparing the target instance for stress testing.

    • WAIT_DBGATEWAY: preparing the stress testing deployment.

    • WAIT_SQL: preparing full SQL.

    • WAIT_LOGIC: preparing to start traffic replay.

    Note

    After the stress testing task executes the state specified by EndState, the task directly reaches the completed state.

    WAIT_LOGIC
    SrcInstanceUuid

    string

    The UUID of the source instance.

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

    string

    The type of the stress testing machine. Valid values:

    • ECS: You need to prepare the Database Gateway on your own.

    • DAS_ECS: an ECS instance automatically purchased and deployed by DAS.

    ECS
    State

    string

    The current state of the stress testing task. Valid values:

    • WAIT_TARGET: preparing the target instance for stress testing.

    • WAIT_DBGATEWAY: preparing the stress testing deployment.

    • WAIT_SQL: preparing full SQL.

    • WAIT_LOGIC: preparing to start traffic replay.

    WAIT_TARGET
    DstIp

    string

    The reserved parameter.

    None
    SrcPublicIp

    string

    The reserved parameter.

    None
    BackupId

    string

    The backup set ID. You can call the DescribeBackups operation to obtain the backup set ID.

    229132
    SqlCompleteReuse

    string

    The reuse information of the full SQL.

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

    integer

    The generated stress testing duration. Unit: milliseconds.

    86400000
    ArchiveState

    integer

    The SQL archiving state. Valid values:

    • 0: not started.

    • 1: completed.

    • 2: error.

    • 3: running.

    • 4: no download required.

    1
    Status

    string

    The running status of the stress testing task. Valid values:

    • SUCCESS: successful.

    • IGNORED: ignored.

    • RUNNING: running.

    • EXCEPTION: abnormal.

    RUNNING
    WorkDir

    string

    The temporary directory generated by the stress testing task.

    /tmp/bench/
    ArchiveOssTableName

    string

    The name of the archived OSS table.

    custins15546355_161604665****
    DtsJobId

    string

    The ID of the DTS migration task.

    i03e3zty16i****
    DtsJobState

    integer

    The DTS task state. Valid values:

    • NOT_STARTED: not started.

    • PRE_CHECKING: precheck in progress.

    • PRE_CHECK_FAILED: precheck failed.

    • CHECKING: checking.

    • MIGRATING: migrating.

    • CATCHED: caught up.

    • SUSPENDING: suspending.

    • MIGRATION_FAILED: migration failed.

    • FINISHED: completed.

    • INITIALIZING: synchronization initializing.

    • INITIALIZE_FAILED: synchronization initialization failed.

    • SYNCHRONIZING: synchronizing.

    • MODIFYING: modifying synchronization objects.

    • SWITCHING: switching.

    • FAILED: failed.

    CHECKING
    DstPort

    integer

    The port of the target instance.

    3306
    DtsJobClass

    string

    The DTS task specification.

    medium
    ClientGatewayId

    string

    The database gateway ID of the stress testing machine.

    58598b2af48a0193dfc16fc6964ef****
    Description

    string

    The description of the stress testing task.

    test-das-bench-0501
    ErrorCode

    string

    The error code returned by the internal stress testing task.

    10910
    TableSchema

    string

    The table names involved in the stress testing task.

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

    string

    The DTS task state. Valid values:

    • NOT_STARTED: not started.

    • PRE_CHECKING: precheck in progress.

    • PRE_CHECK_FAILED: precheck failed.

    • CHECKING: checking.

    • MIGRATING: migrating.

    • CATCHED: caught up.

    • SUSPENDING: suspending.

    • MIGRATION_FAILED: migration failed.

    • FINISHED: completed.

    • INITIALIZING: synchronization initializing.

    • INITIALIZE_FAILED: synchronization initialization failed.

    • SYNCHRONIZING: synchronizing.

    • MODIFYING: modifying synchronization objects.

    • SWITCHING: switching.

    • FAILED: failed.

    PRE_CHECKING
    SrcInstanceArea

    string

    The database type of the source instance.

    RDS
    BenchStepStatus

    string

    The status of the stress testing substep. Valid values:

    • NEW: task initialization.

    • RUNNING: running.

    • FAILED: failed.

    • FINISHED: completed.

    • Terminated: terminated.

    • Deleted: deleted.

    FINISHED
    Source

    string

    The task source. Valid values:

    • DAS.

    • OPEN_API.

    DAS
    ArchiveJobId

    string

    The archiving task ID.

    '202105211430070112231480820340758****
    Topic

    string

    The Kafka consumption topic.

    das
    RequestDuration

    integer

    The duration of the stress testing task.

    864000
    TaskId

    string

    The task ID.

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

    integer

    The stress testing rate multiplier. The replay rate must be a positive integer. Valid values: 0 to 30. Default value: 1.

    1

    Examples

    Success response

    JSON format

    {
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "DtsJobName": "Migration between RDS instances",
    "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
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParams The request parameters are invalid. The request parameters are invalid.
    403 NoPermission You are not authorized to do this action. You do not have the permissions to perform this operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.