跳转到主要内容
平台运维/云平台监控相关接口/监控报警/通知服务/监控报警相关接口/审计

获取审计数据

获取审计数据

GET/zstack/v1/zwatch/audits

操作 ID

GetAuditData

起始版本

2.3

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • startTime
    Long

    起始时间

  • endTime
    Long

    结束时间

  • limit
    Integer

    最大返回条数

  • labels
    List

    过滤标签列表

  • auditType
    AuditType

    审计类型,默认为Resource

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段,默认为null

    • opaque
      LinkedHashMap必填

      保留字段,默认为null

    • cause
      ErrorCode必填

      根错误,引发当前错误的源错误,若无原错误,该字段为null

  • audits
    List必填

    详情参考audits

    • resourceUuid
      String必填

      资源UUID

    • resourceType
      String必填

      资源类型

    • apiName
      String必填

      API名称

    • error
      String必填

      错误详情

      • code
        String必填

        错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001

      • description
        String必填

        错误的概要描述

      • details
        String必填

        错误的详细信息

      • elaboration
        String必填

        保留字段,默认为null

      • opaque
        LinkedHashMap必填

        保留字段,默认为null

      • cause
        ErrorCode必填

        根错误,引发当前错误的源错误,若无原错误,该字段为null

    • operatorAccountUuid
      String必填

      发起API账号UUID

    • duration
      long必填

      API耗时

    • requestUuid
      String必填

      API请求UUID

    • responseUuid
      String必填

      API返回UUID

    • sessionUuid
      String必填

      会话UUID

    • requestDump
      String必填

      API请求JSON存档

    • responseDump
      String必填

      API返回JSON存档

    • time
      long必填

      记录生成时间