Enrollment Campaigns Api Get Enrollment Metrics
Gauges of the resources enrollment shares (campaign workers, simultaneous vCenter token exchanges and how many were throttled) and one row per vCenter: queued, claimed and active counts, jobs completed, failed, cancelled and retried in the window, throughput per hour, and queue wait and slot occupancy percentiles. Queue wait is creation to start; slot occupancy is start to completion and is dominated by the wait for the Agent's first heartbeat. The number of rows is the number of vCenters, so the response does not grow with the number of hosts. No host name, credential or token appears. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.
Length of the window in minutes, 5 to 1440 (default 60). A value outside the range answers 400 INVALID_WINDOW
60
200 OK successful response envelope. The enrollment metrics
{
"windowMinutes": 60,
"workers": {
"campaignWorkerPoolSize": 10,
"campaignWorkersActive": 2,
"campaignWorkerQueueDepth": 0,
"vmwareCallGlobalCap": 10,
"vmwareCallsInFlight": 1,
"vmwareCallsThrottledTotal": 0,
"removalWorkerPoolSize": 3,
"removalWorkersActive": 0,
"removalWorkerQueueDepth": 0
},
"vib": {
"queriesTotal": 1065,
"confirmedTotal": 1060,
"inconclusiveTotal": 5,
"under1Second": 900,
"under5Seconds": 140,
"under10Seconds": 20,
"under30Seconds": 3,
"over30Seconds": 2,
"inconclusiveByReason": [
{
"reasonCode": "TIMEOUT",
"count": 5
}
]
},
"vcenters": [
{
"vcenterConnectionId": "db-1",
"displayName": "Primary vCenter",
"effectiveSlots": 5,
"queuedJobs": 120,
"claimedJobs": 0,
"activeSlots": 5,
"completedInWindow": 110,
"failedInWindow": 1,
"cancelledInWindow": 0,
"retriedInWindow": 3,
"throughputPerHour": 110,
"queueWaitP50Seconds": 1800,
"queueWaitP95Seconds": 3300,
"slotOccupancyP50Seconds": 142,
"slotOccupancyP95Seconds": 290
}
]
}
Length of the window the finished-job counts and percentiles cover, in minutes
Fixed set of gauges for the shared resources, so the number of values never grows with the fleet.
VIB verification query counters since the Console started: bounded by five duration buckets and the stable reason codes, with no host, address or secret.
One entry per connected vCenter, ordered by connection
400 Bad Request: INVALID_WINDOW when windowMinutes is outside 5 and 1440
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/hypervisors/campaigns/metrics