Remote Service Resource

Cloud Admin	Enterprise Admin	User

Contents:

RemoteService resource offers the functionality of managing the remote services of a datacenter in a logical way.

RemoteService Data Model

Configuration errors

Sometimes the remote services need extra configuration steps in background but get its address. If any unexpected error occurs during these configuration steps the remote service is created properly and we return back the list of problems under the element `configurationErrors`. This is a list of the same Error element that we can find when the api returns simple errors but are included under the remote service element. This is an example of a remote service with configuration errors when we couldn't connect with the remote server:

Methods related to RemoteService Resource

Retrieve a list of RemoteServices

Synopsis: GET http://example.com/api/admin/datacenters/{$datacenterId}/remoteServices
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Retrieve a list of the RemoteServices of a Datacenter.

Response Headers: Content-Length, Content-Type.
Response Message Body: RemoteServices
Response Status: 200, 401, 403.
Example Response: Response of the GET over RemoteServices

Create a new RemoteService

Synopsis: POST http://example.com/api/admin/datacenters/{$datacenterId}/remoteServices
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: RemoteService
Request example: Create new RemoteService on a Datacenter

Response Headers: Content-Length, Content-Type, Location.
Response Message Body: RemoteService.
Response Status: 201, 400, 401, 403.
Response example: The creation response

Retrieve a RemoteService

Synopsis: GET http://example.com/api/admin/datacenters/{$datacenterId}/remoteServices/{$type}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Retrieve information about a RemoteService.

Response Headers: Content-Length, Content-Type.
Response Message Body: RemoteService
Response Status: 200, 401, 403.
Example Response: Response of the GET over a RemoteService

Update an existing RemoteService

Synopsis: PUT http://example.com/api/admin/datacenters/{$datacenterId}/remoteServices/{$type}
Request Headers: Accept, Content-Type
Request Parameters: N/A.
Request Message Body: RemoteService
Example Request: Update RemoteService entity.

Response Headers: Content-Length, Content-Type.
Response Message Body: N/A.
Response Status: 200, 400, 401, 403.

Delete a RemoteService

Synopsis: DELETE http://example.com/api/admin/datacenters/{$datacenterId}/remoteServices/{$type}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Delete RemoteService entity.

Response Headers: Content-Length, Content-Type.
Response Message Body: N/A.
Response Status: 200, 401, 403, 409
Example Response: Response of the deletion

Remote services' actions

Each one of the remote services defines a collection of links that represent the actions that can be performed with them. Those links have the format:

Those actions are deeply described within their own section:

• [Node Collector (Discovery Manager)]
• [Storage system monitor (Storage manager)]

Check the status of a RemoteService

Synopsis: GET http://example.com/api/admin/datacenters/{$datacenterId}/remoteServices/{$type}/action/check
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Retrieve information about a RemoteService.

Response Headers: Content-Length, Content-Type.
Response Message Body: RemoteService
Response Status: 200, 401, 403.
Example Response: Response of the GET over a RemoteService status