All Products
Search

This Product

    AnalyticDB:DownloadDiagnosisRecords

    Document Center

    AnalyticDB:DownloadDiagnosisRecords

    Last Updated:Aug 30, 2024

    Downloads the diagnostic information about SQL statements that meet a condition for an AnalyticDB for MySQL cluster.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    adb:DownloadDiagnosisRecordscreate
    • DBCluster
      acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    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****
    StartTimestringYes

    The beginning of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    Note Only data within the last 14 days can be queried.
    		1625220210000
    EndTimestringYes

    The end of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    Note

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

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

    		1625220213000
    RegionIdstringYes

    The region ID of the cluster.

    Note You can call the DescribeRegions operation to query the most recent region list.
    		cn-hangzhou
    QueryConditionstringYes

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

    • {"Type":"maxCost","Value":"100"}: queries the top 100 most time-consuming SQL statements. Set Value to 100.
    • {"Type":"status","Value":"finished"}: queries executed SQL statements. You can set Value to running to query SQL statements that are being executed. You can also set Value to failed to query SQL statements that failed to be executed.
    • {"Type":"cost","Min":"10","Max":"200"}: queries SQL statements whose execution durations are in the range of 10 to 200 milliseconds. You can also customize the maximum and minimum execution durations.
    		{"Type":"status","Value":"finished"}
    KeywordstringNo

    The keyword that is used for the query.

    		select
    MinPeakMemorylongNo

    The minimum peak memory of the SQL statements. Unit: bytes.

    		88000000
    MaxPeakMemorylongNo

    The maximum peak memory of the SQL statements. Unit: bytes.

    		88000000
    MinScanSizelongNo

    The minimum scan size of the SQL statements. Unit: bytes.

    		100000000
    MaxScanSizelongNo

    The maximum scan size of the SQL statements. Unit: bytes.

    		110000000
    ResourceGroupstringNo

    The resource group to which the SQL statements belong.

    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
    UserNamestringNo

    The username that is 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
    DatabasestringNo

    The name of 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
    ClientIpstringNo

    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
    LangstringNo

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

    • zh (default): simplified Chinese.
    • en: English.
    • ja: Japanese.
    • zh-tw: traditional Chinese.
    		zh

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    DownloadIdinteger

    The ID of the download task.

    		68
    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history