[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get Virtual Center Metrics

Description

Retrieve the metrics of a registered vCenter server.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/virtualCenters/{vcUrn}/metrics
Copy

Path Parameters

Path Parameters

string
vcUrn Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns VCenterServerMetrics of type(s) application/json;version=36.3
{
    "vcId": "urn:vcloud:vimserver:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
integer
clustersCount Optional

The number of clusters in this vCenter server.


integer
demandedCpuMhz Optional

The demanded CPU (in MHz) in this vCenter server.


integer
demandedMemMb Optional

The demanded memory (in MB) in this vCenter server.


integer
freeStorageMb Optional

The size of free storage (in MB) of all datastores in this vCenter server.


integer
poweredOnVmCount Optional

The number of powered-on VMs in this vCenter server.


integer
reservedCpuMhz Optional

The reserved CPU (in MHz) in this vCenter server.


integer
reservedMemMb Optional

The reserved memory (in MB) in this vCenter server.


integer
totalCpuMhz Optional

The total CPU (in MHz) in this vCenter server.


integer
totalMemMb Optional

The total memory (in MB) in this vCenter server.


integer
totalStorageMb Optional

The size (in MB) of all datastores in this vCenter server.


integer
totalVmCount Optional

The number of VMs in this vCenter server.


integer
uncommittedStorageMb Optional

The size of uncommitted storage (in MB) of all datastores in this vCenter server.


string
vcId Optional

URN of the associated vCenter server.

Errors

Errors

Error
400

Invalid configuration.


Error
404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/virtualCenters/{vcUrn}/metrics


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?