Get domain sync statistics for the given identifier
(Deprecated)
Deprecated: Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/sync-stats
Request:
URI Path(s):
/api/v1/directory/domains/{domain-id}/sync-stats
Example Request:
GET https://<nsx-mgr>/api/v1/directory/domains/123e4567-e89b-12d3-a456-426655440000/sync-stats
Successful Response:
Response Headers:
Content-type: application/json
Response Body:
DirectoryDomainSyncStats+
| avg_delta_sync_time |
Average time spent for all historical delta sync
All the historical delta sync are counted in calculating the average delta sync time in milliseconds. |
integer |
Readonly |
| avg_full_sync_time |
Average time spent for all historical full sync
All the historical full sync are counted in calculating the average full sync time in milliseconds. |
integer |
Readonly |
| current_state |
Current state of directory domain sync context
Current running state of the directory domain in synchronization life cycle. It could be one of the following five states. SELECTIVE_FULL_SYNC and SELECTIVE_DELTA_SYNC are sync states for selective sync. |
string |
Required
Readonly
Enum: IDLE, FULL_SYNC, DELTA_SYNC, SELECTIVE_FULL_SYNC, SELECTIVE_DELTA_SYNC |
| current_state_begin_time |
Current state elapsed time
Since what time the current state has begun. The time is expressed in millisecond epoch time. |
EpochMsTimestamp |
Required
Readonly |
| num_delta_sync |
Total number of successful delta sync
number of successful historical delta sync initiated either by system or by API request. |
integer |
Readonly |
| num_full_sync |
Total number of successful full sync
number of successful historical full sync initiated either by system or by API request. |
integer |
Readonly |
| prev_sync_end_time |
Previous sync ended time
Directory domain previous sync ending time expressed in millisecond epoch time. |
EpochMsTimestamp |
Required
Readonly |
| prev_sync_error |
Previous sync error
Directory domain previous sync status error if last status was failure. |
string |
Readonly |
| prev_sync_status |
Previous sync status
Directory domain previous sync status. It could be one of the following two states. |
string |
Required
Readonly
Enum: SUCCESS, FAILURE, UNKNOWN |
| prev_sync_type |
Previous sync type
Directory domain previous sync type. It could be one of the following five states. Right after the directory domain is configured, this field is set to IDLE. |
string |
Required
Readonly
Enum: IDLE, FULL_SYNC, DELTA_SYNC, SELECTIVE_FULL_SYNC, SELECTIVE_DELTA_SYNC |
Example Response:
{
"current_state": "FULL_SYNC",
"current_state_begin_time": 1507573933,
"avg_full_sync_time": 25,
"num_full_sync": 234,
"avg_delta_sync_time": 2,
"num_delta_sync": 12345,
"prev_sync_type": "DeltaSync",
"prev_sync_status": "Success",
"prev_sync_error": "Failed due to improper LDAP server",
"prev_sync_finish_time": 1507578611,
}
Required Permissions:
read
Feature:
directory_service
Additional Errors: