Query DB for Community Lists (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/routing_ipcommunitylists/query

Queries the DB for limit number of community lists that match the query parameters.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

The ID of the site.

element_id stringrequired

The ID of the element.

application/json

Body

Query details for Routing Community

aggregate Aggregate

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

group_by string[]

Group the community lists for the query.

id string

Lists the community lists 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

200

Successful Operation

application/json

Schema

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 RoutingCommunityListQueryFilter[]
Array [
auto_generated boolean
The value true or false for auto-generated IP community lists.
community_list RoutingIPCommunity[]
The details of the IP community lists.
Array [
community_str stringrequired
The community string. Max size = 256.
permit boolean
The permit of the IP community sctring = Permit or Deny.
]
description
The description of the IP community list. Max size = 1024.
id string
The ID of the IP community list.
name stringrequired
The name of the IP community list. Max size = 128.
tags string[]
A information field that can be added to identify the IP community list. Maximum 10 unique tags of length 1024 each are allowed.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "auto_generated": true,
      "community_list": [
        {
          "community_str": "string",
          "permit": true
        }
      ],
      "id": "string",
      "name": "string",
      "tags": [
        "string"
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BAD_REQUEST"
      },
      {
        "code": "ELEMENT_NOT_ASSIGNED_TO_SITE"
      }
    ]
  }
}

Loading...