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

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