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