Query NAT Policy Rules (v2.0)

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

Queries all the NAT policy rules.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Details of the query for NAT Policy Rule

aggregate Aggregate

The aggregate number of NAT policy rules 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 NAT policy rules deleted for a time frame.

group_by string[]

Group the NAT policy rules for the query.

id string

Lists the NAT policy rules 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 NATPolicyRuleQueryFilter[]
Array [
actions NATAction[]required
The actions for the configured NAT policy rule. A maximum 4 actions can be specified in a NAT policy rule.
Array [
nat_pool_id string
The ID of the the NAT pool used in policy rules and bound to interfaces.
port integer
The port range of the action in the NAT policy rule.
protocols string[]
The protocol of the action for the NAT policy rule. Supports max 4 protocols.
type stringrequired
Possible values: [NO_NAT, SOURCE_NAT_DYNAMIC, SOURCE_NAT_STATIC, DESTINATION_NAT_DYNAMIC, DESTINATION_NAT_STATIC, ALG_DISABLE]
The type of action for NAT policy.
]
description
The description of the NAT policy rule. Max size = 256.
destination_ports PortRange[]
The start and end port for Port Ranges. A maximum of 16 port ranges is allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
destination_prefixes_id string
The ID of the destination prefix.
destination_zone_id string
The ID of the destination zone. Destination zone is based on the direction of the traffic with respect to the ION device.
enabled boolean
Lists if the NAT policy rule is enabled.
id string
The ID of the policy rule.
name stringrequired
The name of the NAT policy rule.
policyset_id string
The ID of the NAT policy set. NAT policy sets contain policy rules and are a part of NAT policy set stacks.
protocol integer
The protocol for the NAT policy rule. TCP or UDP.
source_ports PortRange[]
The start value of the port range. A maximum of 16 port ranges are allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
source_prefixes_id string
The ID of the source prefixes.
source_zone_id string
The ID of the NAT policy source zone. Source zones identify traffic that is sourced from a zone.
tags string[]
A information field that can be added to identify the NAT policy rule. 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": [
    {
      "actions": [
        {
          "nat_pool_id": "string",
          "port": 0,
          "protocols": [
            "string"
          ],
          "type": "NO_NAT"
        }
      ],
      "destination_ports": [
        {
          "from": 0,
          "to": 0
        }
      ],
      "destination_prefixes_id": "string",
      "destination_zone_id": "string",
      "enabled": true,
      "id": "string",
      "name": "string",
      "policyset_id": "string",
      "protocol": 0,
      "source_ports": [
        {
          "from": 0,
          "to": 0
        }
      ],
      "source_prefixes_id": "string",
      "source_zone_id": "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...