Skip to main content

Query DB for MSTP Instances (v2.0)

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

Query the DB for limit number of MSTP Instances that match query params.

Request​

Path Parameters

    tenant_id stringrequired

    The tenant ID.

Body

    aggregate Aggregate

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

    group_by string[]

    Group By

    id string

    List the MSTP instances 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
    description

    The MSTP instance description. Max limit = 256.

    id string

    The MSTP instance ID.

    instance_number int32

    The MSTP instance number. Valid values are 0-255.

    instance_priority integer

    The MSTP instance priority. Valid values are 0-15.

    name stringrequired

    The name of the MSTP instance. Max limit = 128.

    tags string[]

    A information field that can be added to identify the MSTP instance. Maximum 10 unique tags of length 128 each are allowed.

Loading...