Get Metrics

Get Metrics

This endpoint returns memory and CPU consumption metrics for this PVDC.

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

pvdcUrn


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProviderVdcMetrics of type(s) application/json;version=38.1
{
    "totalMemoryMB": 0,
    "memoryUsedMB": 0,
    "memoryAllocatedMB": 0,
    "memoryReservedMB": 0,
    "memoryOverheadMB": 0,
    "totalCpuMHz": 0,
    "cpuUsedMHz": 0,
    "cpuAllocatedMHz": 0,
    "cpuReservedMHz": 0,
    "cpuOverheadMHz": 0
}
integer As int64 As int64
totalMemoryMB
Optional

Total memory available in this PVDC. When looking at this metric from an organization's context that has a projection created from this PVDC, the field's value represents the projected memory capacity in MB. When looked from the System organization, this field represents the total memory available in the underlying physical infrastructure.

integer As int64 As int64
memoryUsedMB
Optional

Total memory reservation given to all the VDCs from this PVDC and actual memory reservation used by running VMs in Pay As You Go type of VDCs when queried without any organization context. When looking at this metric from an organization's context that has a projection created from this PVDC, the field's value represents the total memory reservation used by running virtual machines from this PVDC in this organization.

integer As int64 As int64
memoryAllocatedMB
Optional

Total memory allocated from this PVDC to tenants and their VDCs. When looking at this field from System organization, this field includes all the memory allocation that is provided to sub provider organizations by using Provider VDC projection mechanism and the total memory allocated from this PVDC to all the VDCs and all the deployed VMs in Pay As You Go type of VDCs in organizations directly managed by System organization. When looking at this field from an organization's context that has a projection created from this PVDC, this field represents the total memory in MB allocated only to VDCs/VMs in this organization.

integer As int64 As int64
memoryReservedMB
Optional

Total memory reserved from this PVDC for all the tenants. When looking at this field from System organization, this field includes all the memory reservation that is provided to sub provider organizations by using Provider VC projection mechanism and the total memory reservation allocated from this PVDC to all the VDCs and all the deployed VMs in Pay As You GO type of VDCs in organizations directly managed by System organization. When looking at this field from an organization's context that has a projection created from this PVDC, this field represents the total memory in MB reserved only to VDCs in this organization from the given PVDC.

integer As int64 As int64
memoryOverheadMB
Optional

Total memory overhead in this PVDC. Includes memory overhead of all running VMs in this PVDC and also memory consumed in System vDC. When looking at this field from an organization's context that has a projection created from this PVDC, this field's value is always zero.

integer As int64 As int64
totalCpuMHz
Optional

Total CPU resources in MHz available in this PVDC. When looking at this metric from an organization's context that has a projection created from this PVDC, the field's value represents the projected CPU capacity in MHz. When looked from the System organization, this field represents the total CPU resources available in MHz in the underlying physical infrastructure.

integer As int64 As int64
cpuUsedMHz
Optional

Total CPU reservation given to all the VDCs from this PVDC and actual CPU reservation used by running VMs in Pay As You Go type of VDCs when queried without any organization context. When looking at this metric from an organization's context that has a projection created from this PVDC, the field's value represents the total CPU reservation used by running virtual machines from this PVDC in this organization.

integer As int64 As int64
cpuAllocatedMHz
Optional

Total CPU in MHz allocated from this PVDC to tenants and their VDCs. When looking at this field from System organization, this field includes all the CPU allocation that is provided to sub provider organizations by using Provider VDC projection mechanism and the total CPU allocated from this PVDC to all the VDCs and all the deployed VMs in Pay As You Go type of VDCs in organizations directly managed by System organization. When looking at this field from an organization's context that has a projection created from this PVDC, this field represents the total CPU in MHz allocated only to VDCs/VMs in this organization.

integer As int64 As int64
cpuReservedMHz
Optional

Total CPU in MHz reserved from this PVDC for all the tenants. When looking at this field from System organization, this field includes all the CPU reservation in MHz that is provided to sub provider organizations by using Provider VC projection mechanism and the total CPU reservation allocated from this PVDC to all the VDCs and all the deployed VMs in Pay As You GO type of VDCs in organizations directly managed by System organization. When looking at this field from an organization's context that has a projection created from this PVDC, this field represents the total CPU in MHz reserved only to VDCs in this organization.

integer As int64 As int64
cpuOverheadMHz
Optional

Total CPU overhead in this PVDC. Includes CPU resources consumed in the System vDC associated to this PVDC. When looking at this field from an organization's context that has a projection created from this PVDC, this field's value is always zero.