View role audit events

View a specified role’s operations in chronological order. You can filter by operation, actor, or result.

HTTP
GET $CLOUDSIGMA_API_BASE/workspaces/{workspace_id}/iam/roles/{role_id}/audit-events

Before you call this API

Configure the regional API endpoint and authentication, and select the target workspace.

First select the role. Keep the cursor returned by the previous page if you need to continue reading.

Request parameters

Shell
curl -G "$CLOUDSIGMA_API_BASE/workspaces/$WORKSPACE_ID/iam/roles/$ROLE_ID/audit-events" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  --data-urlencode "limit=20"

Path parameters

Parameter

Type

Required

Description

workspace_id

string

Yes

Target workspace ID.

role_id

string

Yes

Target role ID.

Query parameters

Parameter

Type

Required

Description

cursor

string

No

Cursor returned by the previous page.

limit

integer

No

Items per page. Default: 20; range: 1–100.

operation

string

No

Filters by operation type.

actor

string

No

Filters by actor principal ID.

status

string

No

Filters by audit-event status.

When data.next_cursor is not empty, use it as cursor for the next request and retain the other filters. Stop when data.next_cursor is empty.

Successful response

On success, returns structured role audit events for the current page and the next-page cursor.

JSON
{"code": "OK", "msg": "OK", "data": {"events": [], "next_cursor": "", "request_id": "req-001", "trace_id": "trace-001"}}

Field

Type

Description

code

string

OK on success.

msg

string

OK on success.

data.events

object[]

Role audit events on the current page.

data.next_cursor

string

Cursor for the next page; empty when there is no next page.

data.request_id

string

Request correlation ID.

data.trace_id

string

Trace ID.

Error response

JSON
{"code": "ErrParamInvalid", "msg": "请求参数无效", "data": null}

Field

Type

Description

code

string

Error code.

msg

string

Error message.

data

null

—
Last updated on