Diagnostics



Diagnostics are defined for each specific release of any Poly infrastructure server. These diagnostics
provide information that helps administrators track the performance and/or operational status of the
server. The diagnostics are measured periodically and their values are recorded for reporting purposes.

This API allows a client to query the set of diagnostics that are being recorded and the time period for
which measurement data is available. The client can either request all diagnostics and their measurements
or any specific diagnostic and its measurements for any time period for which measurements exist.

[tags: INTERNAL]

Resource Root

https://localhost:8443/api/rest/diagnostics

Summary


Resources Methods
https://localhost:8443/api/rest/diagnostics

GET  Gets all of the available diagnostics for the entire duration of the period over which thay have been collected [tags: INTERNAL] .

https://localhost:8443/api/rest/diagnostics/{diagnostic-identifier}

GET  Retrieves diagnostic description and measurements for a single specific diagnostic.

https://localhost:8443/api/rest/diagnostics/{diagnostic-identifier}/measurements

DELETE  Delete measurements for a specific diagnostic.

Resources


https://localhost:8443/api/rest/diagnostics


Methods

GET


Gets all of the available diagnostics for the entire duration of the period over which thay have been
collected
[tags: INTERNAL]

Request

Query Parameters

Name Type Description
include-measurements xs:boolean
Specifies whether to include the actual measurements for each diagnostic. This provides a means
by which a client can obtain a simple list of the diagnostics that are available without the
overhead of passing the actual measurement data.
node-id xs:string
Specifies the ID of a Super Cluster node from which the diagnostic data is desired.
earliest-measurement-date xs:dateTime Return only measurements taken at or after this time.
latest-measurement-date xs:dateTime Return only measurements taken at or before this time.

Response

Status Representation Description
200 application/vnd.plcm.plcm-diagnostic-list+xml
application/vnd.plcm.plcm-diagnostic-list+json
Command successfully received
304
Diagnostic data has not changed since the last retrieval.
Note: The API client must provide the "plcm-diagnostic" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical single diagnostic retrieval in the "If-None-Match" header, then
the HTTP response will contain the diagnostic representation in the message
body.

The "plcm-diagnostic" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical diagnostic
identifier to ensure an equivalent ETag value. This also assumes no other API
client made changes to the diagnostic on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Current user does not have permission to request information. DMA roles required: administrator, provisioner, auditor

https://localhost:8443/api/rest/diagnostics/{diagnostic-identifier}


Template Parameters

Name Type Description
diagnostic-identifier xs:string The diagnostic identifier

Methods

GET


Retrieves diagnostic description and measurements for a single specific diagnostic.

[tags: INTERNAL]

Request

Query Parameters

Name Type Description
earliest-measurement-date xs:dateTime Return only measurements taken at or after this time.
latest-measurement-date xs:dateTime Return only measurements taken at or before this time.

Response

Status Representation Description
200 application/vnd.plcm.plcm-diagnostic+xml
application/vnd.plcm.plcm-diagnostic+json
Diagnostic was successfully retrieved
304
Diagnostic data has not changed since the last retrieval.
Note: The API client must provide the "plcm-diagnostic" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical single diagnostic retrieval in the "If-None-Match" header, then
the HTTP response will contain the diagnostic representation in the message
body.

The "plcm-diagnostic" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical diagnostic
identifier to ensure an equivalent ETag value. This also assumes no other API
client made changes to the diagnostic on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. The user must have Administrator, Provisioner or Auditor role.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No diagnostic was found on the server having the specified diagnostic-identifier.

https://localhost:8443/api/rest/diagnostics/{diagnostic-identifier}/measurements


Template Parameters

Name Type Description
diagnostic-identifier xs:string The diagnostic identifier

Methods

DELETE


Delete measurements for a specific diagnostic. If no parameters are specified, all measurements
will be deleted.

Request

Query Parameters

Name Type Description
delete-earlier-than xs:dateTime Delete measurements taken before this time.
delete-later-than xs:dateTime Delete measurements taken after this time.

Response

Status Representation Description
204
Measurements were deleted as requested
403
The user does not have sufficient privileges to delete the measurements. Only an administrator
may delete measurements.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The diagnostic measurement set has changed on the server since the last retrieval by the client.
Client must re-request the diagnostic to refresh the Etag.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The client has not provided the Etag in the delete request.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The client request could not be processed. Typically this is related to conflicts in date/time
parameters provided with the request.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

There were no measurements found matching the specified date/time parameters provided with the
request.