Get Virtual Center Metrics

Get Virtual Center Metrics

Retrieve the metrics of a registered vCenter server.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/virtualCenters/{vcUrn}/metrics
COPY
Path Parameters
string
vcUrn
Required

vcUrn

Authentication
This operation uses the following authentication methods.
Responses
200
Returns VCenterServerMetrics of type(s) application/json;version=39.0 
{
    "vcId": "urn:vcloud:vimserver:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "clustersCount": 0,
    "totalVmCount": 0,
    "poweredOnVmCount": 0,
    "totalMemMb": 0,
    "reservedMemMb": 0,
    "demandedMemMb": 0,
    "totalCpuMhz": 0,
    "reservedCpuMhz": 0,
    "demandedCpuMhz": 0,
    "totalStorageMb": 0,
    "freeStorageMb": 0,
    "uncommittedStorageMb": 0
}
string
vcId
Optional

URN of the associated vCenter server.

integer
clustersCount
Optional

The number of clusters in this vCenter server.

integer
totalVmCount
Optional

The number of VMs in this vCenter server.

integer
poweredOnVmCount
Optional

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

integer
totalMemMb
Optional

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

integer
reservedMemMb
Optional

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

integer
demandedMemMb
Optional

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

integer
totalCpuMhz
Optional

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

integer
reservedCpuMhz
Optional

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

integer
demandedCpuMhz
Optional

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

integer
totalStorageMb
Optional

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

integer
freeStorageMb
Optional

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

integer
uncommittedStorageMb
Optional

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


400

Invalid configuration.

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


404

The specified resource was not found

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 34.0
On This Page
Virtual Center Operations
POST
Attach Virtual Center
DELETE
Delete Virtual Center
GET
Get All Resource Pools
GET
Get Child Resource Pools
GET
Get Nsx V Manager Settings
GET
Get Resource Pool Kubernetes Config
GET
Get Root Resource Pools
GET
Get Storage Profiles
GET
Get Supported Hardware Versions
GET
Get Unmanaged Virtual Disks
GET
Get Unmanaged Virtual Machines
GET
Get Vc Storage Policy Capabilities
GET
Get Virtual Center
GET
Get Virtual Center Metrics
GET
Query Virtual Centers
GET
Query Virtual Machine Classes
GET
Retrieve Vsphere Vmca
PUT
Update Nsx V Manager Settings
PUT
Update Virtual Center