Serviceability API

Use the Serviceability API to view information about the system, such as API statistics and version information.

URL

https://<server>/unifiedconfig/config/serviceability

Operations

  • get: Returns serviceability information.

    • Query parameters:

      • category: Use this query parameter to reduce the number of parameters returned. The values allowed match the names of the parameters. For example, https://<server>/unifiedconfig/config/serviceability? category=systemValidationStatus&category=capacityInfo.

Parameters

  • currentTime: The time at which this web request was made.

  • instanceName: The name of the active Unified CCE instance.

  • version: Version information for Packaged CCE. Includes the following parameters:

    • buildDate: The date the application was built.

    • buildVersion: The build number of the application.

    • esVersion: The engineering special (ES) version.

    • maintenanceVersion: The maintenance version.

    • majorVersion: The major version.

    • minorVersion: The minor version.

    • srVersion: The SR version.

  • ucceVersion: Version information for Unified CCE. Includes the same parameters listed for the version parameter, above, as well as:

    • versionString: Textual representation of the Unified CCE version.

    • patchInfos: A collection of patch information, including majorVersion, minorVersion, maintenanceVersion, srVersion, and esVersion parameters.

  • capacityInfo: A collection of capacityRules indicating if the capacity limits are valid. Each rule contains the following parameters:

    • name: The name of the capacity rule.

    • max: The maximum number of items allowed for the rule.

    • actual: The current number of items configured for the rule.

  • systemValidationStatus: A collection of validationRules that show the potential errors regarding system configuration. For more information on the rules, see System Validation Rules. Each rule contains the following parameters:

    • name: The name of the rule.

    • isValid: Indicates if the rule is passing. Values are true/false.

    • min: The minimum number of items required to match for this rule.

    • max: The maximum number of items required to match for this rule.

    • actual: The current number of items configured that match this rule.

Example Get Response

<Serviceability>
  <currentTime>Tue Nov 29 04:00:45 EST 2011</currentTime>
  <instanceName>instance</instanceName>
  <version>
    <majorVersion>9</majorVersion>
    <minorVersion>0</minorVersion>
    <maintenanceVersion>0</maintenanceVersion>
    <srVersion>0</srVersion>
    <esVersion>0</esVersion>
    <buildVersion>1</buildVersion>
    <buildDate>1969-12-31T19:00:00-05:00</buildDate>
  </version>
  <ucceVersion>
    <majorVersion>9</majorVersion>
    <minorVersion>5</minorVersion>
    <maintenanceVersion>3</maintenanceVersion>
    <srVersion>0</srVersion>
    <esVersion>0</esVersion>
    <buildVersion>375</buildVersion>
    <versionString>9.5.3.0.0.375</versionString>
    <patchInfos>
      <patchInfo>
        <majorVersion>9</majorVersion>
        <minorVersion>5</minorVersion>
        <maintenanceVersion>3</maintenanceVersion>
        <srVersion>0</srVersion>
        <esVersion>0</esVersion>
      </patchInfo>
      <patchInfo>
        <majorVersion>9</majorVersion>
        <minorVersion>5</minorVersion>
        <maintenanceVersion>2</maintenanceVersion>
        <srVersion>0</srVersion>
        <esVersion>0</esVersion>
      </patchInfo>
    </patchInfos>
  </ucceVersion>
</Serviceability>