Query Policy Sets (v2.0)

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

Queries all the NAT policy sets.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Query details for Policy Set

clone_from string

The policy set that has been cloned from.

description

The description of the NAT policy set. Max size = 256.

destination_zone_policyrule_order string[]

The destination zone where the policy rule order is clasified.

id string

The ID of the policy set.

name stringrequired

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

source_zone_policyrule_order string[]

The order of the NAT policy source zone rules.

tags string[]

A information field that can be added to identify the NAT policy set. 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.

tenant_id string

The tenant ID.

total_count int64

Total number.

items NATPolicySetQueryFilter[]
Array [
clone_from string
The policy set that has been cloned from.
description
The description of the NAT policy set. Max size = 256.
destination_zone_policyrule_order string[]
The destination zone where the policy rule order is clasified.
id string
The ID of the policy set.
name stringrequired
The name of the NAT policy set. Max size = 128.
source_zone_policyrule_order string[]
The order of the NAT policy source zone rules.
tags string[]
A information field that can be added to identify the NAT policy set. 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": [
    {
      "clone_from": "string",
      "destination_zone_policyrule_order": [
        "string"
      ],
      "id": "string",
      "name": "string",
      "source_zone_policyrule_order": [
        "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...