SAP Sailing Analytics Webservices API Version 1.0

URL: /sailinglandscape/api/landscape/removoeapplicationreplicaset

Description:

Removes an application replica set without archiving its contents and without touching its database. The master and replica processes are stopped, and if they were the last on their nodes then the node is terminated. The load balancing rules and the corresponding target groups are removed. If this turns a load balancer empty (other than its default rule), the load balancer is removed too, unless it was the dynamic load balancer. Any DNS record for the replica set (in case of a DNS-mapped load balancer being used) is removed, too, and so are the launch template and auto-scaling group in case they exist.


Webservice Type: POST
Output format: json
Mandatory query parameters:
regionId, region where to set up the replica set, e.g., eu-west-1
replicaSetName, name of the replica set; used as the hostname to which the domain name is appended, as well as for the database and RabbitMQ exchange name
keyName, the name of the SSH key to use; must identify an existing SSH key by that name in the region specified and will be used to log on to existing and new instances using a root ssh connection.
privateKeyEncryptionPassphrase, the pass phrase to decrypt the private key for the key specified by the keyName parameter
mongoUriToArchiveDbTo, if provided, this must identify a full-fledged database-specific MongoDB URI, such as mongodb://172.16.0.123/mynewevent?replicaSet=archive&retryWrites=true&readPreference=nearest. If provided, it specified the database end point to which to move the replica set's original DB content. After moving, the DB content will be compared by hashing original and copy, and only if this comparison was successful will the original be dropped. Note: although you must specify a DB name ("mynewevent" in the example above), the DB name in the URI will be ignored, and the original DB name will be used under all circumstances for the copy.
Optional query parameters:
timeoutInMilliseconds, timeout in milliseconds to wait for responses from nodes when analyzing the replica sets existing in the region; if not specified, waiting will not time out.
force, boolean value defaulting to false. Before removing the replica set, it is checked for live content, that is, races that are currently being tracked live. Since removal stops the master and replica processes and tears down the load balancing, target groups, DNS records and, where present, the launch template and auto-scaling group, doing so while a race is tracked live would interrupt that live tracking. If live content is detected and force is false (the default), the operation is aborted and the service responds with HTTP status 409 Conflict and a JSON body describing the offending replica set(s), events and races (the body has the same structure as the response of the live-content service). Set force to true to bypass this safety check and remove the replica set regardless of any live content, knowingly accepting the disruption of any live tracking.
Request method: POST
Example: curl -X POST -d 'regionId=eu-west-2' -d 'replicaSetName=mynewevent' -d 'keyName=Horst' --data-urlencode 'privateKeyEncryptionPassphrase=HorstsSuperSecretPassword' -H 'Authorization: Bearer RwGK+DV38LKjeuDu+Bx87/3blLJHD7Ff+NCLeud9nRQ=' "https://sapsailing.com/sailinglandscape/api/landscape/removeapplicationreplicaset"
produces no output and a 200 status code if things worked.
Back to Web Service Overview