Skip to main content

Query security policy v2 sets of a tenant (v2.0)



Query security policy v2 sets of a tenant


Path Parameters

    tenant_id stringrequired

    Tenant ID


    aggregate Aggregate

    The aggregate number of security policies V2 that match the query parameters.

    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 (ref.doc.key:0:Aggregate.field)

    name string

    The name of the query response.

    operator string

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

    Operator (ref.doc.key:0:Aggregate.operator)

    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of security policies V2 deleted for a time frame.

    group_by string[]

    Group the security policies V2 for the query.

    id string

    Lists the security policies V2 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.


Successful Operation

    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.


    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 SecurityPolicyV2SetQueryFilter[]
  • Array [
  • clone_from string

    Policy sets cloned from existing policy sets.

    defaultrule_policyset boolean

    The default rule of the policy set.


    The description of the security policy set. Max size = 256.

    id string

    The security policy set ID.

    name stringrequired

    The name of the security policy set. Max size = 128.

    policyrule_order string[]

    The order for the execution of the policy rule.

    tags string[]

    A information field that can be added to identify the security policy set. Maximum 10 unique tags of length 1024 each are allowed.

  • ]