Skip to main content

Query DB for Tenant Level Probe Profiles (v2.0)



Query the DB for the limit number of tenant level probe profiles that match query parameters.


Path Parameters

    tenant_id stringrequired

    The tenant ID.


Query Details for ProbeProfile

    aggregate Aggregate

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

    group_by string[]

    Group the probe profiles for the query.

    id string

    List the probe 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
    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 ProbeProfileQueryFilter[]
  • Array [
  • description

    The description of the probe profile. Max size = 256.

    id string

    The probe profile ID.

    name stringrequired

    The probe profile name. Max size = 128.

    probe_config_ids string[]required

    The probe configuration IDs. Max number = 8.

    tags string[]

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

  • ]