Query Virtual Centers | VMware Cloud Director OpenAPI

Query Virtual Centers

Retrieves a paged list of all Virtual Center servers in the system.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/virtualCenters

COPY

Query Parameters

string

filter

Optional

Filter for a query. FIQL format.

string

sortAsc

Optional

Field to use for ascending sort

string

sortDesc

Optional

Field to use for descending sort

integer

page

Required

Page to fetch, zero offset.

integer

pageSize

Required

Results per page to fetch.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns VCenterServers of type(s) application/json;version=38.0

This response body class contains all of the following: Page , InlineVCenterServers1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "vcId": "urn:vcloud:vimserver:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "name": "vCenter Sample Name",
            "description": "vCenter Sample Description",
            "username": "string",
            "password": "string",
            "url": "https://sampleVc.vmware.com",
            "isEnabled": false,
            "vsphereWebClientServerUrl": "string",
            "hasProxy": false,
            "rootFolder": "string",
            "vcNoneNetwork": "string",
            "tenantVisibleName": "string",
            "isConnected": false,
            "mode": "string",
            "listenerState": "string",
            "clusterHealthStatus": "string",
            "vcVersion": "6.7.0",
            "buildNumber": "12345",
            "uuid": "string",
            "nsxVManager": {
                "username": "string",
                "password": "string",
                "url": "https://sampleVsm.vmware.com",
                "softwareVersion": "string"
            },
            "proxyConfigurationUrn": "string"
        }
    ]
}

Availability

Added in 34.0

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Virtual Center Operations

POST

Attach Virtual Center