All Products
Search

This Product

    AnalyticDB for PostgreSQL:DownloadDiagnosisRecords

    Document Center

    AnalyticDB for PostgreSQL:DownloadDiagnosisRecords

    Last Updated:May 09, 2024

    Downloads the information about query diagnostics of an AnalyticDB for PostgreSQL instance.

    Operation description

    You can call this operation to download the query diagnostic information of an AnalyticDB for PostgreSQL instance. After the download is complete, you can call the DescribeDownloadRecords operation to query download records and download URLs.

    This operation is available only for instances of V6.3.10.1 or later in elastic storage mode. For more information about how to view and update the minor engine version of an instance, see View the minor engine version and Update the minor engine version.

    Limits

    You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

    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
    gpdb:DownloadDiagnosisRecordsWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.
    		gp-bp12ga6v69h86****
    UserstringNo

    The name of the database account.

    		adbpguser
    DatabasestringYes

    The name of the database.

    		adbtest
    StartTimestringNo

    The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

    		2022-05-07T06:59Z
    EndTimestringNo

    The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

    		2022-05-07T07:59Z
    QueryConditionstringNo

    The filter condition on queries. The value is in the JSON format. Valid values:

    • {"Type":"maxCost", "Value":"100"}: filters the top 100 queries that are the most time-consuming.
    • {"Type":"status","Value":"finished"}: filters completed queries.
    • {"Type":"status","Value":"running"}: filters running queries.
    • {"Type":"cost","Max":"200"}: filters the queries that consume less than 200 milliseconds.
    • {"Type":"cost","Min":"200","Max":"60000"}: filters the queries that consume 200 milliseconds or more and less than 1 minute.
    • {"Type":"cost","Min":"60000"}: filters the queries that consume 1 minute or more.
    • {"Type":"cost","Min":"30","Max":"50"}: filters the queries that consume 30 milliseconds or more and less than 50 milliseconds. You can customize a filter condition by setting Min and Max.
    		{ "Type":"maxCost", "Value":"100" }
    LangstringNo

    The language of the file that contains the query diagnostic information. Valid values:

    • zh: simplified Chinese
    • en: English
    • ja: Japanese
    • zh-tw: traditional Chinese
    		zh
    ResourceGroupIdstringNo

    The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see View basic information of a resource group.

    		rg-bp67acfmxazb4p****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
    DownloadIdstring

    The ID of the download task.

    		11
    DBInstanceIdstring

    The ID of the instance.

    		gp-bp12ga6v69h86****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "DownloadId": "11",
  "DBInstanceId": "gp-bp12ga6v69h86****"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-09-11The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.