Jump to

• Request
• Response
• Examples

Returns average response time of all operations in micro seconds

get

/oid/metrics/api/v1/times/latencies/operations

based on given criteria

Request

Query Parameters

• beginTime(optional): string
  Beginning timestamp of the metric

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object OperationRespTime

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/OperationRespTime"
    }
}

Nested Schema : OperationRespTime

Type: object

Show Source

• instance(optional): string
  OID server Instance

  Example: oid1
• latency(optional): integer(int64)
  Example: 30
• time(optional): string
  Timestamp of the metric

  Example: 20201110231239z

{
    "type":"object",
    "properties":{
        "time":{
            "type":"string",
            "example":"20201110231239z",
            "description":"Timestamp of the metric"
        },
        "latency":{
            "type":"integer",
            "example":30,
            "format":"int64"
        },
        "instance":{
            "type":"string",
            "example":"oid1",
            "description":"OID server Instance"
        }
    }
}

400 Response

Bad Request

500 Response

Internal Server Error

Back to Top

Examples

This example retrieves average response time in micro seconds for all operations. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

The following shows example of cURL:

curl  -H "Content-Type: application/json"  -X GET  -u username:password
https://pseudo.com/oid/metrics/api/v1/times/latencies/operations

Example of GET Response Body

The following example shows the contents of the response body in JSON format :

[
{"time":"20210707092419z","latency":1503,"instance":"/oid1/oid1/1"},
{"time":"20210707095419z","latency":1909,"instance":"/oid1/oid1/1"},
{"time":"20210707102419z","latency":1333,"instance":"/oid1/oid1/1"}
]

Back to Top