Skip to main content

Query DB for LAN Networks (v2.0)

POST 

/v2.0/api/tenants/:tenant_id/securitypolicyrules/query

Query the DB for limit number of LAN networks that match query parameters.

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

Body

Query details for LAN Networks

    aggregate Aggregate

    The aggregate number of LAN networks 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

    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 LAN networks deleted for a time frame.

    group_by string[]

    Group the LAN networks for the query.

    id string

    Lists the LAN networks 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 SecurityPolicyRuleQueryFilter[]
  • Array [
  • action string

    The action taken for traffic matching this rule. It determine how the traffic from the specified source zone to the specified destination zone should respond.

    application_ids string[]required

    The security policy rule application ID.

    description

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

    destination_filter_ids string[]

    The destination filter IDs. Max list of prefix IDs is 16.

    destination_zone_ids string[]required

    The destination zone IDs. Max list of zone IDs is 16.

    disabled_flag boolean

    The security policy rule, if disabled.

    id string

    The security policy rule ID.

    name stringrequired

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

    security_policyset_id string

    The security policy set ID.

    source_filter_ids string[]

    The source filter IDs. Max list of IDs is 16.

    source_zone_ids string[]required

    The source zone IDs. Max list of IDs is 16.

  • ]
Loading...