When database replication is configured between Address Manager servers, you can initiate
a read-only API session to call API methods with read-only support and retrieve
information from the Secondary or Tertiary Address Manager server. Since the Secondary
and Tertiary servers maintain a copy of the database from the Primary server, performing
read-only API calls to the Secondary or Tertiary server returns information in your
Address Manager environment while reducing the load on the Primary server. This
introduces a degree of load distribution for certain queries, such as search, that only
require near real-time data.
Attention:
- Since data on the Secondary and Tertiary Address Manager server is replicated from the Primary server, the information retrieved by API calls to the Secondary or Tertiary servers might not be as up-to-date as information retrieved from the Primary server.
- If you log in to the Address Manager API and you set the
isReadOnlyparameter to true, you must perform the login on the associated Secondary or Tertiary server. You cannot log in with this parameter set to true on the Primary server.
The following API methods include support for read-only API sessions:
- getEntities
- getEntitiesByName
- getEntitiesByNameUsingOptions
- getHostRecordsByHint
- getAliasesByHint
- getZonesByHint
- getIP4NetworksByHint
- getSharedNetworks
- getLinkedEntities
- getNetworkLinkedProperties
- getAccessRightsForEntity
- getAccessRightsForUser
- getDeploymentRoles
- getServerDeploymentRoles
- getDeploymentOptions
- getUserDefinedFields
- getKSK
- getAllUsedLocations
- getSystemInfo
- searchResponsePolicyItems
- searchByCategory
- searchByObjectTypes
- customSearch
- getConfigurationsByGroup
- findResponsePoliciesWithItem
- getUserDefinedLink
- getLinkedEntitiesEx
- getLinkedEntitiesByUDL
For more information on logging in to the Address Manager API using the
isReadOnly parameter, refer to GET /v1/loginWithOptions.