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 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_services@
  15
  16 Object type: @bi6l4@
  17
  18 Example UUID: @zzzzz-bi6l4-0123456789abcde@
  19
  20 h2. Resource
  21
  22 The keep_services resource keep clients to discover storage servers and proxies available on the cluster for persistent storage and retrieval of keep blocks.
  23
  24 Each KeepService has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  25
  26 table(table table-bordered table-condensed).
  27 |_. Attribute|_. Type|_. Description|_. Example|
  28 |service_host|string|hostname of the server||
  29 |service_port|integer|TCP port of the service||
  30 |service_ssl_flag|boolean|if the server uses SSL||
  31 |service_type|string|The service type, one of "disk", "blob" (cloud object store) or "proxy" (keepproxy)||
  32
  33 h2. Methods
  34
  35 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  36
  37 Required arguments are displayed in %{background:#ccffcc}green%.
  38
  39 h3. accessible
  40
  41 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.
  42
  43 h3. create
  44
  45 Create a new KeepService.
  46
  47 Arguments:
  48
  49 table(table table-bordered table-condensed).
  50 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  51 |keep_service|object||query||
  52
  53 h3. delete
  54
  55 Delete an existing KeepService.
  56
  57 Arguments:
  58
  59 table(table table-bordered table-condensed).
  60 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  61 {background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
  62
  63 h3. get
  64
  65 Gets a KeepService's metadata by UUID.
  66
  67 Arguments:
  68
  69 table(table table-bordered table-condensed).
  70 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  71 {background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
  72
  73 h3. list
  74
  75 List keep_services.
  76
  77 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  78
  79 h3. update
  80
  81 Update attributes of an existing KeepService.
  82
  83 Arguments:
  84
  85 table(table table-bordered table-condensed).
  86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  87 {background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
  88 |keep_service|object||query||