List Aws Vpcs
Returns a list of Vpcs. Support optional query parameters like account_id, region_id, cidr and/or op_status
Request
URI
GET
https://nsxmanager.your.domain/api/v1/csm/aws-vpcs
COPY
Query Parameters
string
account_id
Optional
Identifier for account based on which vpcs are to be filtered
string
cidr
Optional
IPV4 CIDR Block for the Vpc
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
included_fields
Optional
Comma separated list of fields that should be included to result of query
string
op_status
Optional
Identifier for state based on which vpcs are to be filtered
Possible values are : NSX_MANAGED, NSX_UNMANAGED,
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
string
region_id
Optional
Identifier for region based on which vpcs are to be filtered
boolean
sort_ascending
Optional
sort_ascending
string
sort_by
Optional
Field by which records are sorted
string
vpc_id
Optional
Identifier for vpc based on which the list can be filtered or can be used to validate that hierarchy is correct
Responses
200
Success
Returns AwsVpcListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineAwsVpcListResult1
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"cursor": "string",
"sort_ascending": false,
"sort_by": "string",
"result_count": 0,
"results": [
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_revision": 0,
"_create_time": 0,
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_last_modified_time": 0,
"_create_user": "string",
"_last_modified_user": "string",
"id": "string",
"resource_type": "string",
"gateway_info": {
"gateway_status": {
"gateway_cluster_id": "string",
"gateway_instances_status": [
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"gateway_tn_id": "string",
"gateway_ha_index": 0,
"error_message": "string",
"gateway_name": "string",
"gateway_status": "string",
"gateway_instance_id": "string",
"is_gateway_active": false,
"public_ip": "string",
"error_code": 0,
"private_ip": "string",
"deployment_state": "string",
"gateway_node_id": "string",
"deployment_status": 0
}
]
},
"configuration": {
"ami_id": "string",
"nsx_manager_connection": "string",
"gateway_ha_configuration": [
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"gateway_ha_index": 0,
"management_subnet": "string",
"downlink_subnet": "string",
"uplink_subnet": "string",
"availability_zone": "string"
}
],
"is_ha_enabled": false,
"default_quarantine_policy_enabled": false,
"key_pair_name": "string"
}
},
"ami_id": "string",
"instance_stats": {
"unmanaged": 0,
"vcpus": 0,
"managed": 0,
"error": 0
},
"region_id": "string",
"op_status": "string",
"cidr": "string",
"is_management_vpc": false,
"transport_zones": [
{
"is_underlay_transport_zone": false,
"transport_zone_id": "string",
"transport_zone_display_name": "string",
"logical_switches": [
{
"logical_switch_id": "string",
"instances_count": 0,
"logical_switch_display_name": "string",
"is_default_logical_switch": false,
"nsx_switch_tag": "string"
}
]
}
]
}
]
}
412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure
500
Operation doesn't return any data structure
503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure
Cloud Service Manager Operations
GET
Aws Account Info
GET
Aws Region Info
GET
Aws Vpc Info
GET
Cloud Virtual Machine Info
POST
Create Aws Account
POST
Create Nsx Manager Account
DELETE
Delete Aws Account
DELETE
Delete Aws Gateway Ami
DELETE
Delete Nsx Manager Account
POST
Deploy Aws Gateway Deploy
GET
Get Aws Account Status
GET
Get Aws Gateway Ami Info
GET
Get Aws Gateway Config
GET
Get Aws Gateway Status
GET
Get Csm Status
GET
List Aws Accounts
GET
List Aws Gateway Amis
GET
List Aws Gateways
GET
List Aws Key Pairs
GET
List Aws Regions
GET
List Aws Subnets
GET
List Aws Vpcs
GET
List Cloud Virtual Machines
GET
List Nsx Manager Accounts
GET
Nsx Manager Account Info
POST
Register Aws Gateway Ami
POST
Sync Aws Account Inventory Sync Inventory
POST
Undeploy Aws Gateway Undeploy
PUT
Update Aws Account
PUT
Update Aws Gateway Ami
PUT
Update Aws Gateway Config
PUT
Update Nsx Manager Account