Query NAT Policy Pools (v2.0)

POST 
/sdwan/v2.0/api/natpolicypools/query

Queries all the NAT policy pools.

Request

application/json

Body

Details of the query for NAT policy pools.

description

The description for the NAT policy pool. Max size = 256.

id string

The ID of the NAT policy pool.

name stringrequired

The name of the NAT policy pool. Max size = 128.

tags string[]

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

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.

total_count int64

Total number.

items NATPolicyPoolQueryFilter[]
Array [
description
The description for the NAT policy pool. Max size = 256.
id string
The ID of the NAT policy pool.
name stringrequired
The name of the NAT policy pool. Max size = 128.
tags string[]
A information field that can be added to identify the NAT policy pool. 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": {},
  "total_count": 0,
  "items": [
    {
      "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"
      }
    ]
  }
}

Loading...