sg dashboards
Overview
Provides information from instances of the sg role.
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
Getting information about registered users by sg role instances and domains |
|
|
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 sg 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/sg/dashboards/info",
"params": []
}
}
},
{
"name": "sipusers",
"_links": {
"self": {
"href": "/rest/v1/master/logicalroles/sg/dashboards/sipusers",
"params": []
}
}
},
{
"name": "regcount",
"_links": {
"self": {
"href": "/rest/v1/master/logicalroles/sg/dashboards/regcount",
"params": []
}
}
}
]
Getting information about sg role instances
Provides information about all instances of the sg role within the request scope specified by URL scope parameters.
Request
The URL may contain scope parameters.
GET /rest/v1/master/logicalroles/sg/dashboards/info HTTP/1.1
Response
Returns a list of objects representing servers/nodes, each containing an sg role instance.
| Field | Description |
|---|---|
|
Site name. |
|
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. |
|
Object representing the number of processed SIP requests of the main types. Object fields:
Each of these field values contains the number of processed requests over the last second ( Specified for available nodes. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"site": "SITE1",
"srvidx": 7,
"node": "site1_h7@192.168.0.10",
"addr": "192.168.0.10",
"online": true,
"load": {
"count_all_req": {
"sec1": 0,
"sec20": 12
},
"count_invite": {
"sec1": 0,
"sec20": 0
},
"count_notify": {
"sec1": 0,
"sec20": 4
},
"count_register": {
"sec1": 0,
"sec20": 3
},
"count_subscribe": {
"sec1": 0,
"sec20": 4
}
}
},
{
"site": "SITE1",
"srvidx": 4,
"node": "site1_h4@192.168.0.10",
"addr": "192.168.0.10",
"online": true,
"load": {
"count_all_req": {
"sec1": 1,
"sec20": 0
},
"count_invite": {
"sec1": 0,
"sec20": 0
},
"count_notify": {
"sec1": 0,
"sec20": 0
},
"count_register": {
"sec1": 1,
"sec20": 0
},
"count_subscribe": {
"sec1": 0,
"sec20": 0
}
}
},
{
"site": "SITE2",
"srvidx": 104,
"node": "site2_h4@192.168.0.10",
"addr": "192.168.0.10",
"online": false
}
]
Getting information about registered users by sg role instances and domains
Returns information about the composition of registered SIP user accounts. Information is returned from sg role instances within the request scope specified by URL scope parameters.
The sg role instance that served the REGISTER request ends up in the servicing route of other requests coming both from the SIP device and to the SIP device.
Request
The URL may contain scope parameters.
GET /rest/v1/master/master/logicalroles/sg/dashboards/sipusers?site=SITE1 HTTP/1.1
Response
Returns an object with information about the composition of sites, servers, domains, and SIP user accounts registered through them.
| Level | Field | Description |
|---|---|---|
|
|
List of sites containing esg role instances according to the configuration. Each site is represented as an object. |
|
|
Site name. |
|
|
List of nodes on this site running an sg role instance. Each node is represented as an object. |
|
|
Numeric identifier of this node (roleid from the configuration). |
|
|
Name of this node. |
|
|
List of ports of the sg role instance running on this node. Each port is represented as an object. |
|
|
Local port of the sg role instance. |
|
|
List of domains with registrations on this port/node/site. Each domain is represented as an object. |
|
|
Domain name. |
|
|
List of registrations of SIP user accounts of this domain served on this port/node/site. Each value in the list has the contact URI format: One account can have several registrations. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"sites": [
{
"site": "SITE1",
"gates": [
{
"srvidx": 4,
"node": "site1_h4@192.168.0.10",
"ports": [
{
"port": 5060,
"domains": [
{
"domain": "test.rootdomain.ru",
"regs": [
"udp:sip3@192.168.0.203:5062",
"udp:sip6@192.168.0.200:5060"
]
}
]
}
]
},
{
"srvidx": 7,
"node": "site1_h7@192.168.0.10",
"ports": []
}
]
}
]
}
Getting the number of registered users by sg role instances
Returns information about the number of registered SIP user accounts. Information is returned from sg role instances within the request scope specified by URL scope parameters.
The sg role instance that served the REGISTER request ends up in the servicing route of other requests coming both from the SIP device and to the SIP device.
Request
The URL may contain scope parameters.
GET /rest/v1/master/logicalroles/sg/dashboards/regcount HTTP/1.1
Response
Returns an object with information about the composition of sites, servers, and the number of SIP user accounts registered through them.
| Level | Field | Description |
|---|---|---|
|
|
List of sites containing esg role instances according to the configuration. Each site is represented as an object. |
|
|
Site name. |
|
|
List of nodes on this site running an sg role instance. Each node is represented as an object. |
|
|
Numeric identifier of this node (roleid from the configuration). |
|
|
Name of this node. |
|
|
List of ports of the sg role instance running on this node. Each port is represented as an object. |
|
|
Local port of the sg role instance. |
|
|
Number of registrations of SIP user accounts served on this port/node/site. One account can have several registrations. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"sites": [
{
"site": "SITE1",
"gates": [
{
"srvidx": 4,
"node": "site1_h4@192.168.0.10",
"ports": [
{
"port": 5060,
"regcount": 2
}
]
},
{
"srvidx": 7,
"node": "site1_h7@192.168.0.10",
"ports": []
}
]
},
{
"site": "SITE2",
"gates": [
{
"srvidx": 104,
"node": "site2_h4@192.168.0.10",
"ports": []
}
]
}
]
}
See also
-
sg role
-
SIP user account entity