doc/api/methods/keep_services.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "keep_services"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_services@
  12
  13 UUID type: @bi6l4@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 The keep_services resource storage servers and proxies available on the cluster for persistent storage and retrieval of keep blocks.
  20
  21 Each KeepService has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Attribute|_. Type|_. Description|_. Example|
  25 |service_host|string|||
  26 |service_port|integer|||
  27 |service_ssl_flag|boolean|||
  28 |service_type|string|||
  29
  30 h2. Methods
  31
  32 h3. accessible
  33
  34 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.
  35
  36 table(table table-bordered table-condensed).
  37 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  38
  39 h3. create
  40
  41 Create a new KeepService.
  42
  43 Arguments:
  44
  45 table(table table-bordered table-condensed).
  46 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  47 |keep_disk|object||query||
  48
  49 h3. delete
  50
  51 Delete an existing KeepService.
  52
  53 Arguments:
  54
  55 table(table table-bordered table-condensed).
  56 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  57 {background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
  58
  59 h3. get
  60
  61 Gets a KeepService's metadata by UUID.
  62
  63 Arguments:
  64
  65 table(table table-bordered table-condensed).
  66 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  67 {background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
  68
  69 h3. list
  70
  71 List keep_services.
  72
  73 Arguments:
  74
  75 table(table table-bordered table-condensed).
  76 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  77 |limit|integer (default 100)|Maximum number of keep_services to return.|query||
  78 |order|string|Order in which to return matching keep_services.|query||
  79 |filters|array|Conditions for filtering keep_services.|query||
  80
  81 h3. update
  82
  83 Update attributes of an existing KeepService.
  84
  85 Arguments:
  86
  87 table(table table-bordered table-condensed).
  88 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  89 {background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
  90 |keep_service|object||query||