文档

DescribeSQLLogCount - 获取SQL审计日志数量

更新时间:

获取AnalyticDB PostgreSQL版实例的审计日志数量。

接口说明

本接口不支持实例类型为存储预留模式的实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:DescribeSQLLogCountRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 版实例的详情,包括实例 ID。
gp-xxxxxxxx
QueryKeywordsstring

查询关键词。

test
StartTimestring

查询开始时间。格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

2020-12-12T11:22Z
Databasestring

数据库名称。

testdb
Userstring

数据库用户名。

adbpgadmin
EndTimestring

查询结束时间。格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

说明 查询结束时间需晚于开始时间,且开始时间和结束时间的时间间隔不能超过七天。
2020-12-14T11:22Z
ExecuteCoststring

执行时长,单位为秒(s)。

100
SourceIPstring

来源 IP。

10.**.**.13
ExecuteStatestring

执行状态。取值如下:

  • 取值为 1:成功
  • 取值为 0:失败
  • 取值为 0,1 或 1,0:全部
1
OperationClassstring

操作类别。取值如下:

  • DQL
  • DML
  • DDL
  • DCL
  • TCL
DQL
OperationTypestring

执行 SQL 的类型。

说明
  • 如果设置了 OperationClass 参数,则 OperationType 的值必须属于对应的语言类型。例如 OperationClass 的值为 DQL,则 OperationType 的值必须为 DQL 类型的 SQL,例如 SELECT
    • 如果没有设置 OperationClass 参数,则 OperationType 的值可以是任意类型 SQL。
    • 如果没有设置 OperationClass 参数也没有设置 OperationType 参数,则表示返回所有类型 SQL。
    SELECT
    MaxExecuteCoststring

    慢 SQL 最大耗时,取值需大于等于 0,单位为秒(s)。

    1000
    MinExecuteCoststring

    慢 SQL 最小耗时,取值需大于等于 0,单位为秒(s)。

    10

    返回参数

    名称类型描述示例值
    object
    EndTimestring

    查询结束时间。

    2020-12-14T11:22Z
    RequestIdstring

    请求 ID。

    7565770E-7C45-462D-BA4A-8A**********
    StartTimestring

    查询开始时间。

    2020-12-12T11:22Z
    DBClusterIdstring

    实例 ID。

    gp-xxxxxxxx
    Itemsobject []

    返回项目列表。

    Seriesobject []

    返回值集合。

    Valuesobject []

    返回值。

    Pointarray

    string

    审计日志生成时间与数量。

    2020-12-14T11:00:00Z,100
    Namestring

    实例名称。

    gp-xxxxxxxx

    示例

    正常返回示例

    JSON格式

    {
      "EndTime": "2020-12-14T11:22Z",
      "RequestId": "7565770E-7C45-462D-BA4A-8A**********",
      "StartTime": "2020-12-12T11:22Z",
      "DBClusterId": "gp-xxxxxxxx",
      "Items": [
        {
          "Series": [
            {
              "Values": [
                {
                  "Point": [
                    "2020-12-14T11:00:00Z,100"
                  ]
                }
              ]
            }
          ],
          "Name": "gp-xxxxxxxx"
        }
      ]
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    文档反馈