DescribeSparkAuditLogRecords - 查询Spark Interactive资源组的SQL审计日志。

更新时间:

查询Spark Interactive资源组的SQL审计日志。

接口说明

仅当 SQL 审计状态为开启时,才能查询到 SQL 审计日志,且只支持查询 30 天内的 SQL 审计日志。如果中途关闭了 SQL 审计,再次打开时,仅能查询到再次打开后的 SQL 审计日志。

注意 本接口只能查询到,通过 Spark Interactive 型资源组执行的 SQL 审计日志。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeSparkAuditLogRecordslist
*DBClusterLakeVersion
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

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

集群 ID。

说明
  • 您可以调用 DescribeDBClusters 接口可以查询集群 ID。
  • amv-bp1j7******78j8i
    RegionIdstring

    地域 ID。

    说明 您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息,包括地域 ID。
    cn-shanghai
    StartTimestring

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

    说明 建议查询开始时间设置为 30 天内的任意时间点。
    2025-09-25T00:00Z
    EndTimestring

    查询结束时间,需要大于查询开始时间,且与查询开始时间间隔小于 1 天。 格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

    2025-09-25T01:00Z
    Userstring

    SQL 执行用户名。

    test_user
    Orderstring

    根据指定字段对 SQL 语句进行排序,格式为 JSON,是一个有序 JSON 数组,按输入数组的顺序进行复合排序,包含FieldType两个字段,例如[{"Field":"TotalTime", "Type": "desc" }]。其中:

    • Field表示需要排序的字段名,支持如下字段:

      • ResourceGroupName:资源组名称。
      • Status:SQL 执行状态。
      • User:SQL 执行用户名。
      • ExecuteTime:SQL 执行开始时间。
      • TotalTime:SQL 执行时长。
      • ProcessId:查询 ID。
      • ClientIp:访问源地址。
      • StatementSource:查询发起来源。
    • Type表示排序类型,支持如下取值(取值均不区分大小写):

      • Desc:降序。
      • Asc:升序。
    [{\"Field\":\"ExecuteTime\",\"Type\":\"Desc\"}]
    PageSizeinteger

    每页记录数。

    30
    PageNumberinteger

    页码。

    1
    ProxyUserstring

    废弃参数。

    user
    ResourceGroupNamestring

    资源组名称。

    说明 您可以调用 DescribeDBResourceGroup 接口查看集群的资源组 ID。
    test_job
    Statusstring

    SQL 执行状态。

    枚举值:
    • cancel已取消。
    • finish执行成功。
    • error执行失败。
    • timeout执行超时。
    finish
    StatementIdstring

    Statement ID。

    fbd22066-1c03-xxxx-aa16-6ae28288****
    TotalTimestring

    SQL 执行时长,单位:毫秒(ms)。

    3000
    SQLTextstring

    SQL 语句中的关键词。

    test_table_name
    ProcessIdstring

    查询 ID。

    999f2439-6b10-xxxx-a5d3-daf3b35c****
    ClientIpstring

    访问源地址。

    192.168.XX.XX
    StatementSourcestring

    查询发起来源。

    枚举值:
    • SQL_EDITORSQL_EDITOR
    • JDBCJDBC
    SQL_EDITOR

    返回参数

    名称类型描述示例值
    object
    TotalCountstring

    总记录数。

    100
    PageSizestring

    每页记录数。

    30
    RequestIdstring

    请求 ID。

    2D5867CF-423F-559F-BBB1-199A289E****
    PageNumberstring

    页码。

    1
    DBClusterIdstring

    集群 ID。

    amv-bp1j7******78j8i
    Itemsarray<object>

    SQL 记录列表。

    itemsobject

    详情。

    SQLTextstring

    SQL 语句详情。

    SELECT * FROM adb_hdfs_import_source
    TotalTimelong

    SQL 执行时长,单位:毫秒(ms)。

    40000
    ExecuteTimestring

    SQL 执行开始时间,UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。

    2022-01-23T16:05:08Z
    Userstring

    SQL 执行用户名。

    test_user
    StatementIdstring

    Statement ID。

    fbd22066-1c03-xxxx-aa16-6ae28288****
    Statusstring

    SQL 执行状态。

    枚举值:
    • cancel已取消。
    • finish执行成功。
    • error执行失败。
    • timeout执行超时。
    finish
    ResourceGroupNamestring

    资源组名称。

    test_job
    AppIdstring

    Spark 应用 ID。

    s202411061011hzc5d6476000****
    InnerQueryIdstring

    Spark 应用内部 query 执行 ID。

    1
    IsDiagnosableboolean

    是否可诊断。

    true
    ClientIpstring

    访问源地址。

    192.168.XX.XX
    ProcessIdstring

    查询 ID。

    999f2439-6b10-xxxx-a5d3-daf3b35c****
    StatementSourcestring

    查询发起来源。

    枚举值:
    • SQL_EDITORSQL_EDITOR
    • JDBCJDBC
    SQL_EDITOR
    ErrorMsgstring

    SQL 执行错误信息。

    notFoundIp
    ErrorTracestring

    SQL 执行错误堆栈。

    notFoundIpException
    AccessDeniedDetailstring

    访问被拒绝详细信息;只有 Ram 校验失败才会返回此字段

    { "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "1*****************7", "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "2***************9", "NoPermissionType": "ImplicitDeny", "AuthAction": "adb:DescribeExcessivePrimaryKeys" }

    示例

    正常返回示例

    JSON格式

    {
      "TotalCount": 100,
      "PageSize": 30,
      "RequestId": "2D5867CF-423F-559F-BBB1-199A289E****",
      "PageNumber": 1,
      "DBClusterId": "amv-bp1j7******78j8i",
      "Items": [
        {
          "SQLText": "SELECT * FROM adb_hdfs_import_source",
          "TotalTime": 40000,
          "ExecuteTime": "2022-01-23T16:05:08Z",
          "User": "test_user",
          "StatementId": "fbd22066-1c03-xxxx-aa16-6ae28288****",
          "Status": "finish",
          "ResourceGroupName": "test_job",
          "AppId": "s202411061011hzc5d6476000****",
          "InnerQueryId": 1,
          "IsDiagnosable": true,
          "ClientIp": "192.168.XX.XX",
          "ProcessId": "999f2439-6b10-xxxx-a5d3-daf3b35c****",
          "StatementSource": "SQL_EDITOR",
          "ErrorMsg": "notFoundIp",
          "ErrorTrace": "notFoundIpException"
        }
      ],
      "AccessDeniedDetail": {
        "PolicyType": "AccountLevelIdentityBasedPolicy",
        "AuthPrincipalOwnerId": "1*****************7",
        "EncodedDiagnosticMessage": "AQIBIAAAAOPdwKY2QLOvgMEc7SkkoJfj1kvZwsaRqNYMh10Tv0wTe0fCzaCdrvgazfNb0EnJKETgXyhR+3BIQjx9WAqZryejBsp1Bl4qI5En/D9dEhcXAtKCxCmE2kZCiEzpy8BoEUt+bs0DmlaGWO5xkEpttypLIB4rUhDvZd+zwPg4EXk4KSSWSWsurxtqDkKEMshKlQFBTKvJcKwyhk62IeYly4hQ+5IpXjkh1GQXuDRCQ==",
        "AuthPrincipalType": "SubUser",
        "AuthPrincipalDisplayName": "2***************9",
        "NoPermissionType": "ImplicitDeny",
        "AuthAction": "adb:DescribeExcessivePrimaryKeys"
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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