Summary:
List sync (change) history for all config sets, or filter by individual config set and/or member servers.
URL:
http(s)://{server hostname}/api/cfg/serverGroupConfigChanges?{serverGroupId}or{memberServerId}
Methods summary
GET Method - lists sync (change) history of all config sets, or filter by individual config sets and/or member servers.
GET Method detail
Lists changes to a config set, filtered by the config set itself or a member server.
Request:
The optional parameters are:
- serverGroupId
- memberServerId
Response:
Name | Description |
---|---|
serverId |
unique ID of the server. |
configurationChangeId | ID of the current configuration change, referred to in the table under the Sync History tab on the Multi-Server Configuration page. Each time a config set is updated, the set gains a new configuration change ID. This ID is an auto-incrementing number. |
timestampSec |
timestamp of the change |
triggeredBy | user who made the change. |
errorCode | code for the change outcome, e.g. 'Success'. |
errorMsg | details of an error, if applicable. |
serverGroupId | ID of the config set. |
serverGroupName | name of the config set. |
usersTotal | total number of users after this change on this config set or server. |
usersRemoved | number of users removed by this change from this config set or server. |
usersAdded | number of users added by this change to this config set or server. |
userGroupsTotal | number of user groups after this change on this config set or server. |
userGroupsRemoved | number of user groups removed by this change from this config set or server. |
userGroupsAdded | number of user groups added by this change to this config set or server. |
viewsTotal | number of Views after this change on this config set or server. |
viewsRemoved | number of Views removed by this change from this config set or server. |
viewsAdded | number of Views added by this change to this config set or server. |
count | total number of results from this call. |
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroups?media=json
OUTPUT
{
"items" : [ {
"serverId" : "8acd818b-e0e7-4e8f-83d5-20070c942d3a",
"configurationChangeId" : 73,
"timestampSec" : 1677510898,
"triggeredBy" : "kim1",
"errorCode" : "SUCCESS",
"errorMsg" : null,
"serverGroupId" : "bb816bfa-4f95-4337-9618-de220e055905",
"serverGroupName" : "Kim1",
"usersTotal" : 8,
"usersRemoved" : 1,
"usersAdded" : 0,
"userGroupsTotal" : 10,
"userGroupsRemoved" : 0,
"userGroupsAdded" : 0,
"viewsTotal" : 30,
"viewsRemoved" : 0,
"viewsAdded" : 0
}, {
"serverId" : "8acd818b-e0e7-4e8f-83d5-20070c942d3a",
"configurationChangeId" : 76,
"timestampSec" : 1677511085,
"triggeredBy" : "kim1",
"errorCode" : "SUCCESS",
"errorMsg" : null,
"serverGroupId" : "bb816bfa-4f95-4337-9618-de220e055905",
"serverGroupName" : "Kim1",
"usersTotal" : 9,
"usersRemoved" : 0,
"usersAdded" : 1,
"userGroupsTotal" : 10,
"userGroupsRemoved" : 0,
"userGroupsAdded" : 0,
"viewsTotal" : 30,
"viewsRemoved" : 0,
"viewsAdded" : 0
}, {
"serverId" : "d176aa00-d3d4-4ba1-9409-b480858f7a4d",
"configurationChangeId" : 73,
"timestampSec" : 1677510898,
"triggeredBy" : "kim1",
"errorCode" : "SUCCESS",
"errorMsg" : null,
"serverGroupId" : "bb816bfa-4f95-4337-9618-de220e055905",
"serverGroupName" : "Kim1",
"usersTotal" : 8,
"usersRemoved" : 2,
"usersAdded" : 0,
"userGroupsTotal" : 10,
"userGroupsRemoved" : 0,
"userGroupsAdded" : 0,
"viewsTotal" : 30,
"viewsRemoved" : 0,
"viewsAdded" : 0
}, {
"serverId" : "d176aa00-d3d4-4ba1-9409-b480858f7a4d",
"configurationChangeId" : 74,
"timestampSec" : 1677510940,
"triggeredBy" : "kim1",
"errorCode" : "SUCCESS",
"errorMsg" : null,
"serverGroupId" : "bb816bfa-4f95-4337-9618-de220e055905",
"serverGroupName" : "Kim1",
"usersTotal" : 9,
"usersRemoved" : 0,
"usersAdded" : 1,
"userGroupsTotal" : 10,
"userGroupsRemoved" : 0,
"userGroupsAdded" : 0,
"viewsTotal" : 30,
"viewsRemoved" : 0,
"viewsAdded" : 0
}, {
"serverId" : "8acd818b-e0e7-4e8f-83d5-20070c942d3a",
"configurationChangeId" : 74,
"timestampSec" : 1677510940,
"triggeredBy" : "kim1",
"errorCode" : "SUCCESS",
"errorMsg" : null,
"serverGroupId" : "bb816bfa-4f95-4337-9618-de220e055905",
"serverGroupName" : "Kim1",
"usersTotal" : 9,
"usersRemoved" : 0,
"usersAdded" : 1,
"userGroupsTotal" : 10,
"userGroupsRemoved" : 0,
"userGroupsAdded" : 0,
"viewsTotal" : 30,
"viewsRemoved" : 0,
"viewsAdded" : 0
}, {
"serverId" : "d176aa00-d3d4-4ba1-9409-b480858f7a4d",
"configurationChangeId" : 75,
"timestampSec" : 1677510992,
"triggeredBy" : "kim1",
"errorCode" : "ERROR_SYNCHRONIZATION_FAILURE",
"errorMsg" : "Server ENTLONWBPC01 unreachable (last seen: 2023-02-27 15:15:23Z)",
"serverGroupId" : "bb816bfa-4f95-4337-9618-de220e055905",
"serverGroupName" : "Kim1",
"usersTotal" : null,
"usersRemoved" : null,
"usersAdded" : null,
"userGroupsTotal" : null,
"userGroupsRemoved" : null,
"userGroupsAdded" : null,
"viewsTotal" : null,
"viewsRemoved" : null,
"viewsAdded" : null
}, {
"serverId" : "8acd818b-e0e7-4e8f-83d5-20070c942d3a",
"configurationChangeId" : 75,
"timestampSec" : 1677510992,
"triggeredBy" : "kim1",
"errorCode" : "SUCCESS",
"errorMsg" : null,
"serverGroupId" : "bb816bfa-4f95-4337-9618-de220e055905",
"serverGroupName" : "Kim1",
"usersTotal" : 8,
"usersRemoved" : 1,
"usersAdded" : 0,
"userGroupsTotal" : 10,
"userGroupsRemoved" : 0,
"userGroupsAdded" : 0,
"viewsTotal" : 30, "viewsRemoved" : 0,
"viewsAdded" : 0
}, {
"serverId" : "d176aa00-d3d4-4ba1-9409-b480858f7a4d",
"configurationChangeId" : 76,
"timestampSec" : 1677511085,
"triggeredBy" : "kim1",
"errorCode" : "ERROR_SYNCHRONIZATION_FAILURE",
"errorMsg" : "Server ENTLONWBPC01 unreachable (last seen: 2023-02-27 15:15:23Z)",
"serverGroupId" : "bb816bfa-4f95-4337-9618-de220e055905",
"serverGroupName" : "Kim1",
"usersTotal" : null,
"usersRemoved" : null,
"usersAdded" : null,
"userGroupsTotal" : null,
"userGroupsRemoved" : null,
"userGroupsAdded" : null,
"viewsTotal" : null,
"viewsRemoved" : null,
"viewsAdded" : null
} ],
"count" : 8
}
Comments
0 comments
Please sign in to leave a comment.