Operation details
GET /v1/audit-logs
List rendered operation log rows, newest first
- operationId
listAuditLogs- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
All of：platform.admin identity.self.read
Parameters
listAuditLogs Parameters| Name | In | Type | Required | Description |
|---|
category | query | string | const all | No | — |
|---|
exclude_category | query | string | No | Drop one category (the admin log center's operation tab excludes auth) |
|---|
scope_id | query | string(uuid) | No | Platform administrators only; tenants may only pass their own scope |
|---|
since | query | string(date-time) | No | — |
|---|
until | query | string(date-time) | No | — |
|---|
actor | query | string | No | Username (exact |
|---|
actor_user_id | query | string(uuid) | No | — |
|---|
source_ip | query | string | No | — |
|---|
resource_type | query | string | No | — |
|---|
resource_id | query | string | No | — |
|---|
result | query | string: success / denied / failure | No | — |
|---|
action | query | string | No | — |
|---|
cursor | query | string | No | — |
|---|
limit | query | integer | No | — |
|---|
tz | query | string | No | IANA time zone for the rendered time (default Asia/Shanghai) |
|---|
lang | query | string | No | Overrides Accept-Language |
|---|
Responses
listAuditLogs Responses| Status | Description |
|---|
200 | One page of rows Fields：items: array<Row> next_cursor?: string |
|---|
400 | Invalid filter (audit_log_invalid_request) |
|---|
401 | Unauthenticated |
|---|
403 | Permission denied |
|---|
503 | Log storage unavailable (audit_log_unavailable) |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list
GET /v1/audit-logs/categories
Event categories with labels and default retention days
- operationId
listAuditLogCategories- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
All of：platform.admin identity.self.read
Parameters
listAuditLogCategories Parameters| Name | In | Type | Required | Description |
|---|
lang | query | string | No | Overrides Accept-Language |
|---|
Responses
listAuditLogCategories Responses| Status | Description |
|---|
200 | Categories in display order Fields：items: array<CategoryInfo> |
|---|
401 | Unauthenticated |
|---|
403 | Permission denied |
|---|
What to do on failure
401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
↑ Back to list
GET /v1/audit-logs/export
Export the filtered rows as UTF-8 CSV (at most 10000 rows; the export itself is audited as system.audit_log.export)
- operationId
exportAuditLogs- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
All of：platform.admin identity.self.read
Responses
exportAuditLogs Responses| Status | Description |
|---|
200 | CSV file |
|---|
400 | Invalid filter (audit_log_invalid_request) |
|---|
401 | Unauthenticated |
|---|
403 | Permission denied |
|---|
503 | Log storage or audit unavailable (audit_log_unavailable) |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list