All Products
Search

This Product

    AnalyticDB for PostgreSQL:DescribeSQLLogsV2

    Document Center

    AnalyticDB for PostgreSQL:DescribeSQLLogsV2

    Last Updated:Mar 05, 2024

    Queries SQL logs within a specific time range.

    Operation description

    You can call this operation to query SQL logs of an AnalyticDB for PostgreSQL instance within a specific time range.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ResourceGroupIdstringNo

    The ID of the resource group to which the instance belongs.

    		rg-bp67acfmxazb4p****
    StartTimestringYes

    The beginning of the time range. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

    		2022-03-10T06:30Z
    EndTimestringYes

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

    Note The end time must be later than the start time. The interval cannot be more than 24 hours.
    		2022-03-17T06:30Z
    RegionIdstringYes

    The region ID of the instance.

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

    The ID of instance.

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

    The keywords of the SQL statement.

    		select 1
    DatabasestringNo

    The name of the database.

    		adbpgadmin
    UserstringNo

    The name of the database account.

    		testadmin
    ExecuteCoststringNo

    The execution duration of the SQL statement. Unit: seconds.

    		1
    SourceIPstringNo

    The source IP address.

    		100.XX.XX.90
    ExecuteStatestringNo

    The execution status of the SQL statement. Valid values:

    • 1: successful.
    • 0: failed.
    		success
    OperationClassstringNo

    The type of the query language. Valid values:

    • DQL
    • DML
    • DDL
    • DCL
    • TCL
    		DQL
    OperationTypestringNo

    The type of the SQL statement.

    Note
  • If the OperationClass parameter is specified, the OperationType value must belong to the corresponding query language. For example, if the OperationClass value is DQL, the OperationType value must be a DQL SQL statement such as SELECT.
  • If the OperationClass parameter is not specified, the OperationType value can be an SQL statement of all query languages.
  • If neither of the OperationClass and OperationType parameters is specified, all types of SQL statements are returned.
    •
    		SELECT
    MaxExecuteCoststringNo

    The maximum amount of time consumed by a slow query. Minimum value: 0. Unit: seconds.

    		1000
    MinExecuteCoststringNo

    The minimum amount of time consumed by a slow query. Minimum value: 0. Unit: seconds.

    		1
    PageNumberstringNo

    The number of entries to return on each page.

    		10
    PageSizestringNo

    The number of the page to return. The maximum value is 200.

    		1

    Response parameters

    ParameterTypeDescriptionExample
    object
    PageRecordCountinteger

    The number of entries returned per page.

    		1
    RequestIdstring

    The ID of the request.

    		A7941C94-B92F-46A0-BD3E-2D**********
    PageNumberinteger

    The page number of the returned page.

    		1
    Itemsobject []

    Details of the SQL logs.

    OperationClassstring

    The type of the query language.

    		DQL
    ExecuteStatestring

    The execution status of the SQL statement. Valid values:

    • success
    • fail
    		success
    ExecuteCostfloat

    The execution duration of the SQL statement.

    		2
    SQLTextstring

    The SQL statement.

    		select 1
    SourcePortinteger

    The number of the source port.

    		50514
    DBRolestring

    The role of the database.

    		master
    OperationTypestring

    The type of the SQL statement.

    		SELECT
    SourceIPstring

    The source IP address.

    		100.**.**.90
    ReturnRowCountslong

    The number of entries returned.

    		1
    DBNamestring

    The name of the database.

    		adbpgadmin
    OperationExecuteTimestring

    The time when the SQL statement was executed.

    		2021-03-15T17:02:32Z
    ScanRowCountslong

    The number of entries scanned.

    		1
    AccountNamestring

    The database account that executes the SQL statement.

    		testadmin

    Examples

    Sample success responses

    JSONformat

    {
  "PageRecordCount": 1,
  "RequestId": "A7941C94-B92F-46A0-BD3E-2D**********",
  "PageNumber": 1,
  "Items": [
    {
      "OperationClass": "DQL",
      "ExecuteState": "success",
      "ExecuteCost": 2,
      "SQLText": "select 1",
      "SourcePort": 50514,
      "DBRole": "master",
      "OperationType": "SELECT",
      "SourceIP": "100.**.**.90",
      "ReturnRowCounts": 1,
      "DBName": "adbpgadmin",
      "OperationExecuteTime": "2021-03-15T17:02:32Z",
      "ScanRowCounts": 1,
      "AccountName": "testadmin"
    }
  ]
}

    Error codes

    HTTP status codeError codeError message
    400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

    Change history

    Change timeSummary of changesOperation
    2023-08-02The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400