Aws Vpc Info | NSX-T Data Center REST API

Aws Vpc Info

Returns Vpc information

Request

URI

GET

https://nsxmanager.your.domain/api/v1/csm/aws-vpcs/{vpc-id}

COPY

Path Parameters

string

vpc-id

Required

ID of the Vpc

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns AwsVpc of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineAwsVpc1

{
    "_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"
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure