List Global Desktop Entitlements Metrics

• Monitor

Note: CPA must be initialized for the pod for invoking this API. All the listed privileges are required -

Privileges	Description
FEDERATED_LDAP_VIEW	Caller should have permission to this privilege, to perform this operation.
POOL_VIEW	Caller should have permission to this privilege, to perform this operation.

Request

URI

GET

https://{api_host}/rest/monitor/v1/global-desktop-entitlements/metrics

COPY

Query Parameters

string of array

ids

Required

Global desktop entitlements IDs

---

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Hide Details

OK

[
    {
        "id": "6f93b3a5-e7d0-4ad6-a1e3-48268dd1ed80",
        "local_capacity": 10,
        "local_connected_sessions": 30,
        "local_occupancy_count": 80
    }
]

401

Hide Details

User is not authenticated

Operation doesn't return any data structure

403

Hide Details

Access to the resource is forbidden

Operation doesn't return any data structure

409

Hide Details

Conflict | CPA not initialized for the pod

Operation doesn't return any data structure

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

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