All Products
Search

This Product

    AnalyticDB:DescribeDiagnosisMonitorPerformance

    Document Center

    AnalyticDB:DescribeDiagnosisMonitorPerformance

    Last Updated:Aug 30, 2024

    Queries the monitoring information about queries within a time range.

    Debugging

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

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

    Note You can call the DescribeDBClusters operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
    		am-bp108q1py5r78****
    StartTimestringYes

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

    		1671684348000
    EndTimestringYes

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

    		1671687948000
    RegionIdstringYes

    The region ID of the cluster.

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

    The query conditions for SQL statements, which can be a combination of the Type and Value fields or a combination of the Type, Min, and Max fields. Specify the conditions in the JSON format. Type specifies the query dimension. Valid values for Type: maxCost, status, and cost. Value, Min, or Max specifies the 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 the executed SQL statements. You can set Value to running to query the SQL statements that are being executed. You can also set Value to failed to query the SQL statements that failed to be executed.
    • {"Type":"cost","Min":"10","Max":"200"}: queries the SQL statements whose execution duration is in the range of 10 to 200 milliseconds. You can also specify custom values for the Min and Max fields.
    		{\"Type\":\"maxCost\",\"Value\":\"100\"}
    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
    PerformancesThresholdinteger

    The threshold for the number of queries displayed in a Gantt chart. Default value: 10000.

    Note Up to 10,000 queries can be displayed in a Gantt chart even if more queries exist.
    		10000
    PerformancesTruncatedboolean

    Indicates whether all queries are returned. Valid values:

    • true
    • false
    		false
    RequestIdstring

    The request ID.

    		0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8
    Performancesarray<object>

    The monitoring information about queries displayed in Gantt charts.

    object
    Statusstring

    The status of the SQL statement. Valid values:

    • running
    • finished
    • failed
    		running
    ProcessIdstring

    The query ID.

    		202210311015270330101470300315153****
    StartTimelong

    The execution start time of the SQL statement. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    		1669011260000
    Costlong

    The total execution duration. Unit: milliseconds.

    Note This value is the cumulative value of the QueuedTime, TotalPlanningTime, and ExecutionTime parameters.
    		252
    ScanRowslong

    The number of rows scanned.

    		2345
    PeakMemorylong

    The peak memory of the query. Unit: bytes.

    		123
    RcHoststring

    The IP address of the AnalyticDB for MySQL frontend node on which the SQL statement is executed.

    		192.168.XX.XX
    ScanSizelong

    The amount of scanned data. Unit: bytes.

    		123
    UserNamestring

    The database account that is used to submit the query.

    		rpt

    Examples

    Sample success responses

    JSONformat

    {
  "PerformancesThreshold": 10000,
  "PerformancesTruncated": false,
  "RequestId": "0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8",
  "Performances": [
    {
      "Status": "running",
      "ProcessId": "202210311015270330101470300315153****",
      "StartTime": 1669011260000,
      "Cost": 252,
      "ScanRows": 2345,
      "PeakMemory": 123,
      "RcHost": "192.168.XX.XX",
      "ScanSize": 123,
      "UserName": "rpt"
    }
  ]
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history