调用DescribeSQLLogs接口查询指定时间段的SQL执行记录。
接口说明
该接口不支持实例资源类型为存储预留模式的实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
gpdb:DescribeSQLLogsV2 | get | *DBInstance acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceGroupId | string | 否 | 该参数已废弃,无需传入该参数。 | null |
StartTime | string | 是 | 查询开始时间。格式为YYYY-MM-DDThh:mmZ(UTC 时间)。 | 2022-03-10T06:30Z |
EndTime | string | 是 | 查询结束时间。格式为YYYY-MM-DDThh:mmZ(UTC 时间)。 说明
查询结束时间需晚于开始时间,且开始时间和结束时间的时间间隔不能超过 24 小时。
| 2022-03-17T06:30Z |
RegionId | string | 是 | 地域 ID。 说明
您可以调用 DescribeRegions 接口查看可用的地域 ID。
| cn-hangzhou |
DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 版实例的详情,包括实例 ID。
| gp-xxxxxxxx |
QueryKeywords | string | 否 | SQL 关键字。 | select 1 |
Database | string | 否 | 数据库名称。 | adbpgadmin |
User | string | 否 | 用户名。 | testadmin |
ExecuteCost | string | 否 | 执行耗时,单位为秒(s)。 | 1 |
SourceIP | string | 否 | 来源 IP。 | 100.XX.XX.90 |
ExecuteState | string | 否 | 执行状态。取值如下:
| 1 |
OperationClass | string | 否 | 操作类别,取值如下:
| DQL |
OperationType | string | 否 | 执行 SQL 的类型。 说明
| SELECT |
MaxExecuteCost | string | 否 | 慢 SQL 最大耗时,取值需大于等于 0,单位为秒(s)。 | 1000 |
MinExecuteCost | string | 否 | 慢 SQL 最小耗时,取值需大于等于 0,单位为秒(s)。 | 1 |
PageNumber | string | 否 | 页码,大于 0 且不超过 Integer 的最大值,默认值:1。 | 1 |
PageSize | string | 否 | 每页记录数,取值说明:
| 30 |
返回参数
示例
正常返回示例
JSON
格式
{
"AccessDeniedDetail": "account name invalid",
"Items": [
{
"AccountName": "testadmin",
"DBName": "adbpgadmin",
"DBRole": "master",
"ErrorCode": "InternalError",
"ErrorMsg": "User not authorized to operate on the specified resource.",
"ExecuteCost": 2,
"ExecuteState": "success",
"OperationClass": "DQL",
"OperationExecuteTime": "2021-03-15T17:02:32Z",
"OperationType": "SELECT",
"ReturnRowCounts": 1,
"SQLText": "select 1",
"ScanRowCounts": 1,
"SourceIP": "100.**.**.90",
"SourcePort": 50514,
"QueryId": "2548026401648157601713924318883",
"SessionId": "3a74656836ec5255a4793def0a447b02"
}
],
"PageNumber": 1,
"PageRecordCount": 1,
"RequestId": "A7941C94-B92F-46A0-BD3E-2D**********"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | IdempotentParameterMismatch | The 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. |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-08-02 | OpenAPI 错误码发生变更 | 查看变更详情 |