All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeSQLLogs

Last Updated:Mar 05, 2024

Queries the SQL execution logs of an AnalyticDB for PostgreSQL instance.

Operation description

Note This operation is no longer used. To query SQL execution logs, call the DescribeSQLLogsV2 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:DescribeSQLLogsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

Note You can call the DescribeDBInstances operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.
gp-xxxxxxxx
QueryKeywordsstringNo

The keywords of the SQL statement.

select 1
StartTimestringYes

The beginning 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.

2021-03-10T06:30Z
DatabasestringNo

The name of the database.

adbpgadmin
UserstringNo

The name of the database account.

testadmin
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 maximum time range that can be specified is seven days.
2021-03-17T06:30Z
PageSizeintegerNo

The number of entries per page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

30
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
ExecuteCoststringNo

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

1
SourceIPstringNo

The source IP address.

100.**.**.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 OperationClass is specified, the value of OperationType must belong to the corresponding query language. For example, if OperationClass is set to DQL, the value of OperationType must be a DQL statement such as SELECT.

  • If OperationClass is not specified, the value of OperationType can be an SQL statement of any query language.

  • If OperationClass and OperationType are not specified, all types of SQL statements are returned.

SELECT
MaxExecuteCoststringNo

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

1000
MinExecuteCoststringNo

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

1

Response parameters

ParameterTypeDescriptionExample
object
PageRecordCountinteger

The number of entries per page.

1
RequestIdstring

The request ID.

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

The page number.

1
Itemsobject []

The queried SQL execution 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
SQLPlanstring

The SQL execution plan.

""
ReturnRowCountslong

The total 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",
      "SQLPlan": "\"\"",
      "ReturnRowCounts": 1,
      "DBName": "adbpgadmin",
      "OperationExecuteTime": "2021-03-15T17:02:32Z",
      "ScanRowCounts": 1,
      "AccountName": "testadmin"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history