SAP Sailing Analytics Webservices API Version 1.0

URL: /sailinglandscape/api/landscape/gethostseligibleforreplicasetprocessdeployment

Description:

Returns the shared hosts that are eligible for deploying an additional process of the given application replica set, i.e., hosts on which the replica set's HTTP port is free and the server directory is available. This is a read-only query typically used to discover candidate hosts before calling deployreplicatoexistinghost with one of the returned instance IDs. If no eligible host exists, an empty array is returned.


Webservice Type: POST
Output format: json
Mandatory query parameters:
regionId, region where the replica set is located, e.g., eu-west-1
replicaSetName, name of the replica set for which eligible deployment hosts are requested; used as the hostname to which the domain name is appended, as well as for the database and RabbitMQ exchange name
Optional form parameters:
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. If not specified, the key used to launch an instance will be used for trying to connect to it, and a private key with matching name for the respective region will be looked up.
privateKeyEncryptionPassphrase, the pass phrase to decrypt the private key for the key specified by the keyName parameter
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.
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/gethostseligibleforreplicasetprocessdeployment"
produces output listing the eligible hosts:
            [
              {
                "instanceId": "i-0123456789abcdef0",
                "name": "SL Multi-Server",
                "availabilityZoneId": "euw2-az1",
                "availabilityZoneName": "eu-west-2a",
                "privateAddress": "172.31.36.221",
                "publicAddress": "18.130.0.1"
              }
            ]
        
Back to Web Service Overview