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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "keep_disks"
   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 {% include 'notebox_begin_warning' %}
  15 This is a legacy API.  This endpoint is deprecated, disabled by default in new installations, and slated to be removed entirely in a future major release of Arvados.  It is replaced by "keep services.":keep_services.html
  16 {% include 'notebox_end' %}
  17
  18 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_disks@
  19
  20 Object type: @penuu@
  21
  22 Example UUID: @zzzzz-penuu-0123456789abcde@
  23
  24 h2. Resource
  25
  26 Obsoleted by "keep_services":{{site.baseurl}}/api/methods/keep_services.html
  27
  28 Each KeepDisk has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Attribute|_. Type|_. Description|_. Example|
  32 |ping_secret|string|||
  33 |node_uuid|string|||
  34 |filesystem_uuid|string|||
  35 |bytes_total|integer|||
  36 |bytes_free|integer|||
  37 |is_readable|boolean|||
  38 |is_writable|boolean|||
  39 |last_read_at|datetime|||
  40 |last_write_at|datetime|||
  41 |last_ping_at|datetime|||
  42 |keep_service_uuid|string|||
  43
  44 h2. Methods
  45
  46 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  47
  48 Required arguments are displayed in %{background:#ccffcc}green%.
  49
  50 h3. create
  51
  52 Create a new KeepDisk.
  53
  54 Arguments:
  55
  56 table(table table-bordered table-condensed).
  57 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  58 |keep_disk|object||query||
  59
  60 h3. delete
  61
  62 Delete an existing KeepDisk.
  63
  64 Arguments:
  65
  66 table(table table-bordered table-condensed).
  67 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  68 {background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path||
  69
  70 h3. get
  71
  72 Gets a KeepDisk's metadata by UUID.
  73
  74 Arguments:
  75
  76 table(table table-bordered table-condensed).
  77 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  78 {background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path||
  79
  80 h3. list
  81
  82 List keep_disks.
  83
  84 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  85
  86 h3. ping
  87
  88 ping keep_disks
  89
  90 Arguments:
  91
  92 table(table table-bordered table-condensed).
  93 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  94 {background:#ccffcc}.|ping_secret|string||query||
  95 {background:#ccffcc}.|service_port|string||query||
  96 {background:#ccffcc}.|service_ssl_flag|string||query||
  97 |filesystem_uuid|string||query||
  98 |node_uuid|string||query||
  99 |service_host|string||query||
 100 |uuid|string||query||
 101
 102 h3. update
 103
 104 Update attributes of an existing KeepDisk.
 105
 106 Arguments:
 107
 108 table(table table-bordered table-condensed).
 109 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 110 {background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path||
 111 |keep_disk|object||query||