Jump to

• Request
• Response
• Examples

Returns LDAP connection counts

get

/oid/metrics/api/v1/counts/connections/ldap

Returns LDAP client connection counts.

Request

Query Parameters

• beginTime(optional): string
  Beginning timestamp of the metric
• state(optional): string
  State of LDAP connection (valid values - open, new and closed)

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 LDAPConnCount

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

Nested Schema : LDAPConnCount

Type: object

Show Source

• count(optional): integer(int64)
  Example: 30
• instance(optional): string
  OID server Instance

  Example: oid1
• time(optional): string
  Timestamp of the metric

  Example: 20201110231239z

{
    "type":"object",
    "properties":{
        "time":{
            "type":"string",
            "example":"20201110231239z",
            "description":"Timestamp of the metric"
        },
        "count":{
            "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 total number of LDAP client connections. 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/counts/connections/ldap

curl  -H "Content-Type: application/json"  -X GET  -u username:password
https://pseudo.com/oid/metrics/api/v1/counts/connections/ldap?state=open

curl  -H "Content-Type: application/json"  -X GET  -u username:password
https://pseudo.com/oid/metrics/api/v1/counts/connections/ldap?state=new

curl  -H "Content-Type: application/json"  -X GET  -u username:password
https://pseudo.com/oid/metrics/api/v1/counts/connections/ldap?state=closed

curl  -H "Content-Type: application/json"  -X GET  -u username:password
https://pseudo.com/oid/metrics/api/v1/counts/connections/ldap?beginTime=20210707092419z

Example of GET Response Body

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

[
{"time":"20210707092419z","count":19,"instance":"/oid1/oid1/1"},
{"time":"20210707095419z","count":19,"instance":"/oid1/oid1/1"},
{"time":"20210707102419z","count":19,"instance":"/oid1/oid1/1"}
]

Back to Top