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