keep_services

API endpoint base: https://qr1hi.arvadosapi.com/arvados/v1/keep_services

Object type: bi6l4

Example UUID: zzzzz-bi6l4-0123456789abcde

Resource

The keep_services resource keep clients to discover storage servers and proxies available on the cluster for persistent storage and retrieval of keep blocks.

Each KeepService has, in addition to the Common resource fields:

Attribute Type Description Example
service_host string hostname of the server
service_port integer TCP port of the service
service_ssl_flag boolean if the server uses SSL
service_type string The service type, one of “disk”, “blob” (cloud object store) or “proxy” (keepproxy)

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

accessible

Get a list of keep services that are accessible to the requesting client. Unlike list, this is context-sensitive based on the requester, for example providing the list of actual Keep servers when inside the cluster, but providing a proxy service if client contacts Arvados from outside the cluster.

create

Create a new KeepService.

Arguments:

Argument Type Description Location Example
keep_service object query

delete

Delete an existing KeepService.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the KeepService in question. path

get

Gets a KeepService’s metadata by UUID.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the KeepService in question. path

list

List keep_services.

See common resource list method.

update

Update attributes of an existing KeepService.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the KeepService in question. path
keep_service object query

Previous: users Next: links

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.