NSX-T Data Center REST API

AwsVpcListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of Vpcs. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AwsVpcListRequestParameters", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "account_id": {
      "required": false, 
      "title": "Identifier for account based on which vpcs are to be filtered", 
      "type": "string"
    }, 
    "associated_transit_vpc_id": {
      "description": "Identifier for filtering all the compute VPCs which are NSX managed by the given transit VPC.", 
      "required": false, 
      "title": "Transit VPC ID", 
      "type": "string"
    }, 
    "cidr": {
      "format": "ipv4-cidr-block", 
      "required": false, 
      "title": "IPV4 CIDR Block for the Vpc", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "op_status": {
      "$ref": "AwsVpcOpStatus, 
      "description": "Operational status of the VPC.", 
      "title": "AWS VPC Operational Status"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": false, 
      "title": "Identifier for region based on which vpcs are to be filtered", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "status_filter": {
      "description": "MANAGED - VPC is managed by NSX UNMANAGED - VPC is not managed by NSX ERRORED - VPC is in error state", 
      "enum": [
        "MANAGED", 
        "UNMANAGED", 
        "ERRORED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Filter by overall VPC status", 
      "type": "string"
    }, 
    "vpc_id": {
      "required": false, 
      "title": "Identifier for vpc based on which the list can be filtered or can be\nused to validate that hierarchy is correct\n", 
      "type": "string"
    }
  }, 
  "type": "object"
}