Domain center monitoring

Requests

HTTP verb Endpoint Description

GET

/api/monitor/v1/dc/currentload

Domain center state

Object alias: td.

Domain type: any (authorization domain and its subdomains).
The desttd parameter is the subdomain for which the request is made (from the master domain — any domain).

Domain center state

State of domain centers and entity counters of the domain and its subdomains.

Request

Table 1. Request parameters
Specification Description

Name: site
Type: str
Default: current site

Site whose domain centers are polled.

Name: down
Type: bool
Default: false

Output only unavailable and unloaded domains.

Name: providers
Type: bool
Default: false

Add the list of domain providers (providers).

Name: licused
Type: bool
Default: false

Add license usage (licused).

Name: licownused
Type: bool
Default: false

Add usage of the domain’s own licenses (licownused).

Example request
GET /api/monitor/v1/dc/currentload HTTP/1.1

Response

Example response
HTTP/1.1 200 OK

{
  "resultcode": 0,
  "resultmsg": "OK",
  "data": {
    "domains": [
      {
        "active": true,
        "parent": "rootdomain.ru",
        "domain": "test.rootdomain.ru",
        "is_loaded": true,
        "subdomain_count": 2,
        "licowned": {
          "devices": 100,
          "siptrunks": 10
        },
        "licsubdomain": {
          "devices": 20
        },
        "lictotal": {
          "devices": 100,
          "siptrunks": 10
        },
        "sipuser_count": 27,
        "user_count": 13,
        "provider_count": 18,
        "featurecode_count": 47,
        "redirect_count": 9,
        "route_inner_count": 11,
        "route_outer_count": 12,
        "route_cross_count": 13
      }
    ]
  }
}
Table 2. Key description
Name Description

active

Domain center responds. When false — the error code (error) and text (errormsg).

is_loaded

Domain is loaded.

*_count

Number of entities of the corresponding class.