List Cloud Virtual Machines

Returns the list of all virtual machines created or imported under a particular account id. Supports optional query parameters like region id, vpc id, public_ip, is_gateway.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/csm/virtual-machines

COPY

Query Parameters

string

account_id

Optional

Identifier for account based on which virtual machines are to be filtered

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

instance_id

Optional

Identifier for virtual machine based on which the list can be filtered

boolean

is_gateway

Optional

Is the VM a gateway node?

string

logical_switch_id

Optional

Identifier for logical switch based on which Aws Virtual Machines are to be filtered

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

public_ip

Optional

Public IP address of the virtual machine

string

region_id

Optional

Identifier for region based on whicha Virtual Machines 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 Aws Virtual Machines are to be filtered

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns CloudVirtualMachinesListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineCloudVirtualMachinesListResult1

{
    "_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_ha_index": 0,
            "gateway_status": "string",
            "nsx_ip": "string",
            "is_gateway": false,
            "is_gateway_active": false,
            "error_messages": [
                {
                    "error_id": 0,
                    "detailed_message": "string"
                }
            ],
            "agent_status": "string",
            "logical_switch_id": "string",
            "logical_switch_display_name": "string",
            "private_ip": "string",
            "public_ip": "string",
            "os_details": "string",
            "managed_by_nsx": false,
            "quarantine_state": "string",
            "cloud_tags": [
                {
                    "value": "string",
                    "key": "string"
                }
            ],
            "os_type": "string",
            "agent_version": "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