跳转到主要内容
API Explorer|API Explorer
平台运维/云平台监控相关接口/监控报警/通知服务/监控报警相关接口/审计
GETAudit Operations起始版本 2.3同步需要认证

获取审计数据

获取审计数据

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • startTimeLong

    起始时间

  • endTimeLong

    结束时间

  • limitInteger

    最大返回条数

  • labelsList

    过滤标签列表

  • auditTypeAuditType

    审计类型，默认为Resource

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • auditsList必填

    详情参考audits

    • resourceUuidString必填

      资源UUID

    • resourceTypeString必填

      资源类型

    • apiNameString必填

      API名称

    • errorString必填

      错误详情

      • codeString必填

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

      • descriptionString必填

        错误的概要描述

      • detailsString必填

        错误的详细信息

      • elaborationString必填

        保留字段，默认为null

      • opaqueLinkedHashMap必填

        保留字段，默认为null

      • causeErrorCode必填

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

    • operatorAccountUuidString必填

      发起API账号UUID

    • durationlong必填

      API耗时

    • requestUuidString必填

      API请求UUID

    • responseUuidString必填

      API返回UUID

    • sessionUuidString必填

      会话UUID

    • requestDumpString必填

      API请求JSON存档

    • responseDumpString必填

      API返回JSON存档

    • timelong必填

      记录生成时间

请求地址

GET/zstack/v1/zwatch/audits

/zstack/v1/zwatch/audits

操作 ID

GetAuditData

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/zwatch/audits?startTime=1&endTime=1&limit=1&labels=<labels>&auditType=<auditType>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "audits": [ { "resourceUuid": "b1ca3fab6ebc4302ad9249d5402cb06c", "resourceType": "VmInstanceVO", "clientIp": "172.0.0.1", "clientBrowser": "Chrome/69.0.3497.81", "apiName": "org.zstack.header.vm.APISetVmRDPMsg", "operatorAccountUuid": "36c27e8ff05c4780bf6d2fa65700f22e", "duration": 22.0, "requestUuid": "d78093c0b2fb3850b3ce563b3a0b029d", "responseUuid": "08cf3fd2c4614811b4acc0620e20a98e", "sessionUuid": "05e5c663eb794faab5c5606c38103a17", "responseDump": "{\"success\":true}", "time": 1.512037844556E12 } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史