跳转到正文
皓量云擎文档
接口参考审计日志

查询审计记录

GET /api/v1/tenants/{tenant_id}/audit-logs,listTenantAudits 的请求参数和响应结构。

GET /api/v1/tenants/{tenant_id}/audit-logs

项目内容
操作标识listTenantAudits
认证登录会话 Cookie

PostgreSQL 持久化;角色、租户状态与成员资格在每次请求的数据库事务中重新校验。未配置 DATABASE_URL 时返回 503。

请求参数

名称位置必填类型说明与约束
tenant_idpath是string格式:uuid
pagequery否integer最小值 1;最大值 1000000;默认 1
page_sizequery否integer最小值 1;最大值 100;默认 20
keywordquery否string—
actionquery否string—
startquery否string格式:date-time
endquery否string格式:date-time
outcomequery否string可选值:"succeeded"、"accepted"、"failed"、"denied"

响应

HTTP 状态含义
200成功
400参数错误
401登录无效或已撤销
403权限、范围或 CSRF 校验失败
404记录不存在
409引用或唯一性冲突
429请求过于频繁
503数据库未配置或不可用
200 · application/json 响应结构
字段类型必填说明与约束
dataIAMAudit[]是—
request_idstring是—
metaPageInfo是—
{
  "$ref": "#/$defs/IAMAuditListResponse",
  "$defs": {
    "IAMAuditListResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/IAMAudit"
          }
        },
        "request_id": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/$defs/PageInfo"
        }
      },
      "required": [
        "data",
        "request_id",
        "meta"
      ]
    },
    "IAMAudit": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "tenant_id": {
          "type": "string",
          "format": "uuid",
          "nullable": true
        },
        "actor_id": {
          "type": "string",
          "format": "uuid",
          "nullable": true
        },
        "action": {
          "type": "string"
        },
        "resource_id": {
          "type": "string"
        },
        "request_id": {
          "type": "string"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "actor_name": {
          "type": "string"
        },
        "actor_username": {
          "type": "string"
        },
        "tenant_name": {
          "type": "string"
        },
        "source_ip": {
          "type": "string"
        },
        "request_method": {
          "type": "string"
        },
        "request_path": {
          "type": "string"
        },
        "outcome": {
          "type": "string"
        },
        "operation_id": {
          "type": "string",
          "format": "uuid",
          "nullable": true
        }
      },
      "required": [
        "id",
        "tenant_id",
        "actor_id",
        "action",
        "resource_id",
        "request_id",
        "created_at",
        "actor_name",
        "actor_username",
        "tenant_name",
        "source_ip",
        "request_method",
        "request_path",
        "outcome",
        "operation_id"
      ]
    },
    "PageInfo": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "page": {
          "type": "integer",
          "minimum": 1
        },
        "page_size": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "total": {
          "type": "integer",
          "minimum": 0
        }
      },
      "required": [
        "page",
        "page_size",
        "total"
      ]
    }
  }
}
400 / 401 / 403 / 404 / 409 / 429 / 503 · application/json 响应结构
{
  "$ref": "#/$defs/ErrorResponse",
  "$defs": {
    "ErrorResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "error": {
          "$ref": "#/$defs/ErrorDetail"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "error",
        "request_id"
      ]
    },
    "ErrorDetail": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "NOT_IMPLEMENTED",
            "NOT_FOUND",
            "AUTH_REQUIRED",
            "FORBIDDEN",
            "VALIDATION_FAILED",
            "CONFLICT",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR",
            "RATE_LIMITED"
          ]
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "code",
        "message",
        "retryable"
      ]
    }
  }
}

响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。

本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。

本页目录