Get Virtual Center Monitor Info V3

Get Virtual Center Monitor Info V3

At least one of the listed privileges is required -

Privileges Description
GLOBAL_CONFIG_VIEW Caller should have permission to this privilege, to perform this operation.
VC_CONFIG_VIEW Caller should have permission to this privilege, to perform this operation.
Request
URI
GET
https://{api_host}/rest/monitor/v3/virtual-centers/{id}
COPY
Path Parameters
string
id
Required

id


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VirtualCenterMonitorInfoV3 of type(s) */*
{
    "connection_servers": [
        {
            "certificate": {
                "valid": true,
                "valid_from": 1561939200000,
                "valid_to": 1561939200000
            },
            "id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
            "last_updated_timestamp": 1582029025748,
            "name": "cs1.example.com",
            "status": "OK",
            "thumbprint_accepted": true
        }
    ],
    "datastores": [
        {
            "capacity_mb": 12345,
            "details": {
                "name": "vsandatastore",
                "path": "/datacenter1/vsandatastore",
                "url": "ds:///vmfs/volumes/vsan:52654c2aa8e79416-8ea7a3309e82c7b7/"
            },
            "free_space_mb": 12345,
            "status": "ACCESSIBLE",
            "type": "VSAN"
        }
    ],
    "desktop_pools_and_farms_count": 0,
    "details": {
        "api_version": "6.5",
        "build": "12345678.0.1",
        "version": "6.5.0"
    },
    "hosts_v2": [
        {
            "cpu_core_count": 16,
            "cpu_mhz": 2194,
            "details": {
                "api_version": "6.5",
                "cluster_name": "cluster-1",
                "name": "host1.example.com",
                "version": "6.5.0",
                "vgpu_types": [
                    "string"
                ]
            },
            "memory_size_mb": 12345,
            "overall_cpu_usage_mhz": 1209,
            "overall_memory_usage_mb": 66569,
            "status": "CONNECTED"
        }
    ],
    "id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
    "name": "vc1.example.com"
}
connection_servers
Optional

Information about the Virtual Center connections from each of the connection servers.

datastores
Optional

Information about the datastores of the Virtual Center.

integer As int32 As int32
desktop_pools_and_farms_count
Optional

Number of Desktop Pools And Farms managed by the virtual center

details
Optional

details

hosts_v2
Optional

Information about the ESX hosts added in the Virtual Center.

string
id
Required

Unique ID of the Virtual Center.

string
name
Required

Virtual Center server name or IP address.


401

User is not authenticated

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

Monitor Operations
GET
Get App Volumes Manager Monitor Info
GET
Get App Volumes Manager Monitor Info V2
GET
Get Connection Server Monitor Info V2
GET
Get Connection Server Monitor Info V3
GET
Get Desktop Monitor Info
GET
Get Event Database Monitor
GET
Get Farm Monitor Info
GET
Get Gateway Monitor Info
GET
Get Gateway Monitor Info V2
GET
Get License Usage Metrics
GET
Get Message Client Monitor
GET
Get Pod Monitor Info V2
GET
Get Pod Session Metrics Info
GET
Get RDS Server Monitors
GET
Get SAML Authenticator Monitor Info
GET
Get Session Metrics
GET
Get System Metrics Info
GET
Get True SSO Monitor Info
GET
Get View Composer By VC Id
GET
Get Virtual Center Monitor Info
GET
Get Virtual Center Monitor Info V3
GET
List AD Domain Monitor Infos V2
GET
List AD Domain Monitor Infos V3
GET
List AD Domain Monitors
GET
List App Volumes Manager Monitor Info V1
GET
List App Volumes Manager Monitor Info V2
GET
List Connection Server Monitors
GET
List Connection Server Monitors V2
GET
List Connection Server Monitors V3
GET
List Desktop Monitors
GET
List Desktop Pool Metrics
GET
List Desktop Pool Or Farm Datastore Usage Info
GET
List Farm Monitors
GET
List Gateway Monitor Info V1
GET
List Gateway Monitor Info V2
GET
List Gateway Monitor Info V3
GET
List Global Desktop Entitlements Metrics
GET
List Health Metrics Info
GET
List Message Clients Monitors
GET
List Pod Monitor Infos V1
GET
List Pod Monitor Infos V2
GET
List RDS Server Monitors
GET
List SAML Authenticator Monitors V1
GET
List SAML Authenticator Monitors V2
GET
List True SSO Monitor Infos
GET
List View Composer Monitors V1
GET
List View Composer Monitors V2
GET
List Virtual Center Monitors
GET
List Virtual Center Monitors V2
GET
List Virtual Center Monitors V3