All Products
Search

This Product

    AnalyticDB:DownloadDiagnosisRecords

    Document Center

    AnalyticDB:DownloadDiagnosisRecords

    Last Updated:Aug 28, 2026

    Downloads diagnostic information about SQL statements that meet specified conditions in an AnalyticDB for MySQL cluster.

    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

    adb:DownloadDiagnosisRecords

    create

    DBCluster

    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    Note

    You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.

    am-bp1r053byu48p****
    StartTime

    string

    Yes

    The beginning of the time range to query. Set this parameter to a UNIX timestamp in milliseconds.

    Note

    Only data within the last 14 days can be queried.

    1625220210000
    EndTime

    string

    Yes

    The end of the time range to query. Set this parameter to a UNIX timestamp in milliseconds.

    Note

    • The end time must be later than the start time.

    • The maximum time range that can be specified is 24 hours.

    1625220213000
    RegionId

    string

    Yes

    The region ID of the cluster.

    Note

    You can call the DescribeRegions operation to query the most recent region list.

    cn-hangzhou
    QueryCondition

    string

    Yes

    The query condition for SQL statements, which can contain a combination of Type and Value fields, or Type, Min, and Max fields in JSON format. Type specifies the query dimension. Valid values: maxCost, status, and cost. Valid values:

    • {"Type":"maxCost","Value":"100"}: queries the top 100 most time-consuming SQL statements.

    • {"Type":"status","Value":"finished"}: queries executed SQL statements, including successful and failed SQL statements. You can set Value to running to query SQL statements that are being executed, or to failed to query SQL statements that failed.

    • {"Type":"cost","Min":"10","Max":"200"}: queries SQL statements whose execution duration is 10 to 200 milliseconds. You can specify custom values for Min and Max.

    {"Type":"status","Value":"finished"}
    Keyword

    string

    No

    The keyword for the query.

    select
    MinPeakMemory

    integer

    No

    The minimum peak memory of the SQL statements, in bytes.

    88000000
    MaxPeakMemory

    integer

    No

    The maximum peak memory of the SQL statements, in bytes.

    88000000
    MinScanSize

    integer

    No

    The minimum scan size of the SQL statements, in bytes.

    100000000
    MaxScanSize

    integer

    No

    The maximum scan size of the SQL statements, in bytes.

    110000000
    ResourceGroup

    string

    No

    The resource group of the SQL statements.

    Note

    You can call the DescribeDiagnosisDimensions operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.

    user_default
    UserName

    string

    No

    The username used to execute the SQL statements.

    Note

    You can call the DescribeDiagnosisDimensions operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.

    test_user
    Database

    string

    No

    The database on which the SQL statements are executed.

    Note

    You can call the DescribeDiagnosisDimensions operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.

    adb_demo
    ClientIp

    string

    No

    The source IP addresses.

    Note

    You can call the DescribeDiagnosisDimensions operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.

    106.11.XX.XX
    Lang

    string

    No

    The language of file titles and error messages. Valid values:

    • zh (default): simplified Chinese.

    • en: English.

    • ja: Japanese.

    • zh-tw: traditional Chinese.

    zh

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    DownloadId

    integer

    The ID of the download task.

    68
    RequestId

    string

    The request ID.

    D4ACF4E0-2952-3A87-9A2C-474058******

    Examples

    Success response

    JSON format

    {
  "DownloadId": 68,
  "RequestId": "D4ACF4E0-2952-3A87-9A2C-474058******"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.