Skip to main content

Query Audit Logs for Tenant (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/auditlog/query

Query the audit logs for a given tenant as per specified query filters.

Request​

Path Parameters

    tenant_id stringrequired

    The tenant ID.

Body

Query fields

    aggregate Aggregate

    The aggregate number of queried elements.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
    • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
    • field string

    Field

    name string

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]

    Operator

    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of queried elements deleted for a time frame.

    group_by string[]

    Group the elements state for the query.

    id string

    List the element by ID.

    last_query_ts int64

    Return the ID of a specified query in the current session.

    limit int32

    The query limit.

    next_query object

    The limit.

    query_params object
    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object
    total_count int64

    The total number of query parameters.

Responses​

Successful Operation

Schema
    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.

    description

    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number.

    items AuditLog[]
  • Array [
    • esp_tenant_id string

    The audit log MSP tenant ID. Supported characters; = ^[a-z0-9]{1,50}$).

    id string

    The audit log ID.

    operator_id string

    The audit log operator ID. Supported characters; = ^[a-z0-9]{1,50}$).

    operator_tenant_id string

    The audit log tenant ID. Supported characters; = ^[a-z0-9]{1,50}$).

    request_body string

    The audit log request body.

    request_content_length int32

    The request content length.

    request_id stringrequired

    The audit log request ID.

    request_ts int64

    Request Ts

    request_type stringrequired

    The audit log request type (GET|POST|PUT|DELETE|PATCH)$).

    request_uri stringrequired

    The audit log request URL.

    resource_etag int64

    The audit log request Etag.

    resource_id string

    The audit log resource ID. Max length = 50.

    resource_key string

    The audit log resource key. Max length = 128.

    resource_version string

    The audit log resource version.

    response_body string

    The audit log response body.

    response_code int32

    Response Code

    response_content_length int32

    The audit log response content length.

    response_ts int64

    Response Ts

    session_key_c string

    The audit log session key C. Max length = 128.

    source_ip string

    The audit log source IP address. Max length = 128.

    tenant_id stringrequired

    The tenant ID.

    time_ms int64

    Time Ms

  • ]
Loading...