Skip to main content

Query VRF Context Profiles (v2.0)

POST 

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

Query VRF context profiles.

Request

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

Body

Query Details for the Vrf Context Profile

    aggregate Aggregate

    The aggregate number of VRF profiles 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 VRF profiles deleted for a time frame.

    group_by string[]

    Group the VRF profiles for the query.

    id string

    List the VRF profiles 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

    Query using query parameters.

    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object

    Specify the order in which you want the search criteria to display.

    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 VRFContextProfileQueryFilter[]
  • Array [
  • default_vrf_context_profile boolean

    VRF profile is enabled by default. True / False.

    description

    Description of the VRF profile. Max size = 256.

    id string

    The VRF profile ID.

    name stringrequired

    The name of the VRF profile. Max size = 128.

    tags string[]

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

    vrf_context_ids string[]

    The VRF context IDs.

    vrf_context_route_leak_rules VRFContextRouteLeakRule[]

    The valid VRF context leak rules.

  • Array [
  • description

    Description of the Route Leak Rule. Max size = 256.

    dest_vrf_context_id string

    The destination VRF ID for the Route Leak Rule.

    ipv4_prefixes string[]

    The leaked IPv4 prefixes of the Route Leak Rule. The leaked IPv4 prefix in the route leak rule must match the prefix configured on the interface.

    name string

    The name of the Route Leak Rule. Max size = 128.

    src_vrf_context_id string

    The SRC VRF ID.

  • ]
  • ]
Loading...