esg dashboards
Overview
Provides information from instances of the esg role.
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Getting aggregate quantitative metrics from esg roles by sites |
Common request scope parameters
The parameters below are used in the URL (?param=value) to limit the request application scope (the set of role instances to which the request applies).
All are optional and may be absent.
It makes sense to specify no more than one of them, or none at all.
| Name | Type | Description |
|---|---|---|
|
|
Site name from the configuration. For example |
|
|
Comma-separated list of site names. For example |
|
|
Server alias. Can be an IP address, a number, or a full server name from the configuration. For example |
|
|
Comma-separated list of server aliases. For example |
Getting the list of available dashboards
Response
Returns the list of esg role dashboards and relative URLs for obtaining them.
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"name": "info",
"_links": {
"self": {
"href": "/rest/v1/master/logicalroles/esg/dashboards/info",
"params": []
}
}
},
{
"name": "count",
"_links": {
"self": {
"href": "/rest/v1/master/logicalroles/esg/dashboards/count",
"params": []
}
}
},
{
"name": "sites",
"_links": {
"self": {
"href": "/rest/v1/master/logicalroles/esg/dashboards/sites",
"params": []
}
}
}
]
Getting complete information about esg roles
Provides information about all instances of the esg role within the request scope specified by URL scope parameters.
Request
The URL may contain additional scope parameters.
| Name | Type | Description |
|---|---|---|
|
|
Show active provider accounts and their registration states. |
|
|
Provider code. Used together with |
GET /rest/v1/master/logicalroles/esg/dashboards/info HTTP/1.1
Response
Returns an object with information about the composition of sites, each containing a composition of servers/nodes, each containing an esg role instance.
| Level | Field | Description |
|---|---|---|
|
|
Number of dialogs served by all esg role instances within the request scope. |
|
|
Number of dialog legs served by esg role instances within the request scope. |
|
|
List of sites containing esg role instances according to the configuration. |
|
|
Site name. |
|
|
Number of dialogs served by esg role instances within the request scope on this site. |
|
|
Number of dialog legs served by esg role instances within the request scope on this site. |
|
|
Numeric identifier of this node (roleid from the configuration). |
|
|
Name of this node. |
|
|
Availability flag of this node from the web server executing the API request. |
|
|
IP address of the esg role on this node. Specified only if the node is available. |
|
|
Number of dialogs served by the esg role instance on this node. Specified for available nodes. |
|
|
Number of dialog legs served by the esg role instance on this node. Specified for available nodes. |
|
|
List of accounts served by the esg role instance on this node. Applies to the |
|
|
Provider account code. |
|
|
Internal cluster domain to which this provider account belongs. |
|
|
Username of the provider account. |
|
|
Domain of the provider account sent outside. |
|
|
SIP server port to which the provider account connects. |
|
|
Protocol used by the provider account. Possible values: |
|
|
List of addresses of the SIP server(s) to which the provider account connects. |
|
|
|
|
|
|
|
|
List of headers of the last SIP server response to the sent REGISTER request. |
|
|
Number of active trunks in use. |
| State | Description |
|---|---|
|
The account operates without registration. |
|
The account is registered. |
|
The account is being registered. |
|
The account is waiting for the next registration attempt. |
|
The account is being disconnected. |
| State | Description |
|---|---|
|
The account operates without connection checking. |
|
The last connection check passed successfully. |
|
The last connection check failed. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"callcount": 0,
"dlgcount": 0,
"sites": [
{
"site": "SITE1",
"callcount": 0,
"dlgcount": 0,
"servers": [
{
"srvidx": 1,
"node": "site1_h1@192.168.0.12",
"addr": "192.168.0.12",
"online": true,
"callcount": 0,
"dlgcount": 0,
"domains": [],
"regs": [
{
"code": "ceceron",
"d": "test.rootdomain.ru",
"user": "sip4",
"domain": "test.ceceron.ru",
"port": 5060,
"proto": "udp",
"addrs": [
"test.ceceron.ru",
"192.168.0.84"
],
"regstate": "registered",
"pingstate": "disabled",
"last_response": [
"SIP/2.0 200 OK",
"Via: SIP/2.0/UDP 192.168.0.12:5080;rport=5080;received=192.168.0.12;branch=z9hG4bK4d9MzT-4TRPTu",
"From: <sip:sip4@test.ceceron.ru>;tag=4WUgbJ",
"To: <sip:sip4@test.ceceron.ru>;tag=rB2-00A-TTsq",
"Call-ID: avLICRwnMr6mjNV7HkWwcKX6RJ0",
"CSeq: 199253986 REGISTER",
"Max-Forwards: 70",
"Content-Length: 0",
"Contact: <sip:sip4@192.168.0.12:5080>;expires=120",
"Contact: <sip:sip4@192.168.0.204:5062>;expires=313",
"Supported: path",
"Allow: REGISTER,INVITE,ACK,CANCEL,BYE,REFER,NOTIFY,OPTIONS,INFO,SUBSCRIBE,MESSAGE,UPDATE",
"Date: Tue, 05 Nov 2019 11:41:09 GMT",
"Path: <sip:r_Q37WFY3@192.168.0.84:5060;transport=tcp;lr>"
],
"onlinetrunkcount": 0
},
{
"code": "rtest",
"d": "test.rootdomain.ru",
"user": "sip8",
"domain": "test.rootdomain.ru",
"port": 5060,
"proto": "tcp",
"addrs": [
"test.rootdomain.ru",
"192.168.0.12"
],
"regstate": "registered",
"pingstate": "ok",
"last_response": [
"SIP/2.0 200 OK",
"Via: SIP/2.0/TCP 192.168.0.12:5080;rport=4005;received=192.168.0.12;branch=z9hG4bK3aut66-2ymB9o",
"From: <sip:sip8@test.rootdomain.ru>;tag=FtT6WP",
"To: <sip:sip8@test.rootdomain.ru>;tag=rB2-002-Qj4c",
"Call-ID: 5DSlqsHIBWDPKaesn2JKzTjhRXA",
"CSeq: 199349124 REGISTER",
"Max-Forwards: 70",
"Content-Length: 0",
"Contact: <sip:sip8@192.168.0.12:5080;transport=TCP>;expires=34",
"Supported: path",
"Allow: REGISTER,INVITE,ACK,CANCEL,BYE,REFER,NOTIFY,OPTIONS,INFO,SUBSCRIBE,MESSAGE,UPDATE",
"Date: Tue, 05 Nov 2019 11:42:08 GMT",
"Path: <sip:r_Q1CJaRf@192.168.0.12:5060;transport=tcp;lr>"
],
"onlinetrunkcount": 0
}
]
},
{
"srvidx": 32,
"node": "site1_h11@192.168.0.12",
"online": false
}
]
},
{
"site": "SITE2",
"callcount": 0,
"dlgcount": 0,
"servers": [
{
"srvidx": 101,
"node": "site2_h1@192.168.0.12",
"online": false
}
]
}
]
}
Getting aggregate quantitative metrics from esg roles
Provides information about the aggregate number of dialogs and dialog legs from all instances of the esg role within the request scope specified by URL scope parameters.
Returns a limited data set from request Getting complete information about esg roles.
Request
The URL may contain additional scope parameters.
GET /rest/v1/master/master/logicalroles/esg/dashboards/count HTTP/1.1
Response
| Field | Description |
|---|---|
|
Number of dialogs served by all esg role instances within the request scope. |
|
Number of dialog legs served by esg role instances within the request scope. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"callcount": 24,
"dlgcount": 12
}
Getting aggregate quantitative metrics from esg roles by sites
Provides information about the aggregate number of dialogs and dialog legs from all instances of the esg role within the request scope specified by URL scope parameters. Returns data by sites and totals.
Returns a limited data set from request Getting complete information about esg roles.
Request
The URL may contain additional scope parameters.
Response
| Level | Field | Description |
|---|---|---|
|
|
Number of dialogs served by all esg role instances within the request scope. |
|
|
Number of dialog legs served by esg role instances within the request scope. |
|
|
List of sites containing esg role instances according to the configuration. |
|
|
Site name. |
|
|
Number of dialogs served by esg role instances within the request scope on this site. |
|
|
Number of dialog legs served by esg role instances within the request scope on this site. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"dlgcount": 24,
"callcount": 12,
"sites": [
{
"site": "SITE3",
"callcount": 2,
"dlgcount": 1
},
{
"site": "SITE2",
"callcount": 6,
"dlgcount": 3
},
{
"site": "SITE1",
"callcount": 16,
"dlgcount": 8
}
]
}
See also
-
esg role
-
Provider account entity