NSX-T Data Center REST API
AwsVpcListRequestParameters (schema)
These paramaters will be used to filter the list of Vpcs.
Multiple parameters can be given as input to 'AND' them.
Name | Description | Type | Notes |
---|---|---|---|
account_id | Identifier for account based on which vpcs are to be filtered | string | |
associated_transit_vpc_id | Transit VPC ID Identifier for filtering all the compute VPCs which are NSX managed by the given transit VPC. |
string | |
cidr | IPV4 CIDR Block for the Vpc | string | Format: ipv4-cidr-block |
cursor | Opaque cursor to be used for getting next page of records (supplied by current result page) | string | |
included_fields | Comma separated list of fields that should be included in query result 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. |
string | |
op_status | AWS VPC Operational Status Operational status of the VPC. |
AwsVpcOpStatus | |
page_size | Maximum number of results to return in this page (server may return fewer) | integer | Minimum: 0 Maximum: 1000 Default: "1000" |
region_id | Identifier for region based on which vpcs are to be filtered | string | |
sort_ascending | boolean | ||
sort_by | Field by which records are sorted | string | |
status_filter | Filter by overall VPC status MANAGED - VPC is managed by NSX UNMANAGED - VPC is not managed by NSX ERRORED - VPC is in error state |
string | Readonly Enum: MANAGED, UNMANAGED, ERRORED |
vpc_id | Identifier for vpc based on which the list can be filtered or can be used to validate that hierarchy is correct | string |