Skip to main content

Query DB for Service Binding Maps (v2.0)

POST 

/sdwan/v2.0/api/servicebindingmaps/query

Query the DB for limit number of service binding maps that match query parameters.

Request

Body

Query details for service bindings

    aggregate Aggregate

    The aggregate number of service binding maps 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

    The field value.

    name string

    The name of the query response.

    operator string

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

    The operator values.

    statistic string

    The aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of service binding maps deleted for a time frame.

    group_by string[]

    Group the service binding maps for the query.

    id string

    Lists the service binding maps 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.

    total_count int64

    Total number.

    items ServiceBindingMap[]
  • Array [
  • description

    The description of the service binding map. Max size = 256.

    id string

    The ID of the service binding map.

    name stringrequired

    The name of the service binding map. Max size = 128.

    service_bindings ServiceBinding[]required

    The service binding endpoint IDs and labels.

  • Array [
  • service_endpoint_ids string[]

    The service endpoint IDs.

    service_label_id string

    The service label ID.

  • ]
  • tags string[]

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

  • ]
Loading...