ReconfigureEndpointNoWait
- Supported with the Oracle source endpoint only.
-
Using this method, requires you to set up relevant Qlik Replicate task(s) with three separate source endpoints - two inactive source endpoints defined with the primary and secondary database connection settings, and one active source endpoint (initially defined with the primary database connection settings).
For detailed instructions, see Reconfiguring endpoints.
General
URL
https://[host]/attunityenterprisemanager/api/v1/servers/{server}/endpoints/{endpoint}/?action=reconfigure&configuration={configuration}&recycle={true|false}
Description
Call this method to override the source endpoint settings with settings from another endpoint of the same type. This method also supports automatically stopping and then resuming all tasks that are using the source endpoint (which is required for unplanned switchovers).
HTTP method
PUT
Required user role
See Required Enterprise Manager permissions.
Request parameters
Location | Name | Required | Description | Example |
---|---|---|---|---|
URL |
Host [string] |
Yes |
The host name of the computer on which the Replicate Server is running. |
computer.network.net |
URL |
ServerName [string] |
Yes |
The name of the Replicate server (as defined in Qlik Enterprise Manager) on which the task(s) are running. |
myrepsrv1 |
URL |
EndpointName [string] |
Yes |
The name of the source endpoint defined for the Replicate task(s). |
MyOracle |
URL |
ConfigurationName [string] |
Yes |
The name of the secondary endpoint (or the primary endpoint when reverting the settings). |
SecondaryOracle |
URL |
Recycle [bool] |
Optional (default is true) |
Whether to stop and resume the Replicate task(s) automatically. The default is "true", that is, when an unanticipated switchover occurs, tasks using the source endpoint will be automatically stopped and then resumed after the source endpoint is updated with the settings from the secondary endpoint. Set to "false" for planned switchovers (such as migrating to a production database or switching back to the primary database). |
true |
Header |
EnterpriseManager.APISessionID [string] |
Yes |
- |
wCo0_KvjEUFROvfHF5KGrw |
cURL example
curl -i -k -X PUT --header "Content-Length:0" --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGrw" "https://computer.network.net/attunityenterprisemanager/api/v1/servers/myrepsrv1/endpoints/MyOracle?action=reconfigure&configuration=SecondaryOracle&recycle=true"
Response
HTTP/1.1 200 OK
Cache-Control: no-cache, no-store
Content-Length: 0
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Application-Status: 200
Application-Message: OK
Date: Sun, 19 Feb 2019 16:42:11 GMT
Error response
All of the general errors as well as the errors listed in the table below.
HTTP Code | Enterprise Manager Code | Text | Description |
---|---|---|---|
500 |
AEM_ENDPOINT_NOT_FOUND |
Replicate endpoint "{endpoint}" on server "{server}" could not be found. |
The specified endpoint could not be found. |
500 |
AEM_RECONFIGURE_ENDPOINT_INNER_ERR |
Failed to reconfigure endpoint "{endpoint}" on server "{server}". Error: "{message}" |
Qlik Enterprise Manager failed to reconfigure the endpoint with the settings of the failover endpoint. |