GET /api/lunasa/hsms/{hsmid}/metrics

GET /api/lunasa/hsms/{hsmid}/metrics

Gets all utilization metrics information associated with partitons of the HSM. This resource requires SO authentication and policy 49 which allows partition utilization metrics needs to be changed to 1.

Parameters

hsmid

The serial number of the HSM of interest.

Use: Required

JSON Schema:

   Object
   type: integer
   format: int64
   minimum: 1
   maximum: 9999999999

Responses

200

The set of all utilization metrics information associated with partitions of the HSM.

JSON Schema: Metrics

400

FRAMEWORK_BAD_REQUEST

Returned when the input data does not conform to the required validation schema.

404

HSM does not exist.

Example Request

   GET
   https://1.2.3.4:8443/api/lunasa/hsms/67848/metrics

Example Result

{
    "actions":"/api/lunasa/hsms/67848/metrics/actions",
    "metrics":[{"bins":[{"binId":"DECRYPT","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"ENCRYPT","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"KEY_DERIVATION","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"KEY_GENERATION","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"SIGN","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"VERIFY","counters":[{"count":0,"counterId":"REQUESTS"}]}],
                "label":"",
                "partitionId":157970905488
                },
               {"bins":[{"binId":"DECRYPT","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"ENCRYPT","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"KEY_DERIVATION","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"KEY_GENERATION","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"SIGN","counters":[{"count":0,"counterId":"REQUESTS"}]},
                        {"binId":"VERIFY","counters":[{"count":0,"counterId":"REQUESTS"}]}],
                "label":"",
                "partitionId":157970905522
               }
              ],
    "resetTime":"2018-07-05T13:38:56"
}

See Also

GET /api/lunasa/hsms/{hsmid}/metrics/actions