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