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
   9
  10
  11 Required arguments are displayed in %{background:#ccffcc}green%.
  12
  13
  14 h2. create
  15
  16 Create a new KeepDisk.
  17
  18 Arguments:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  22 |keep_disk|object||query||
  23
  24 h2. delete
  25
  26 Delete an existing KeepDisk.
  27
  28 Arguments:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  32 {background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path||
  33
  34 h2. destroy
  35
  36 destroy keep_disks
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 {background:#ccffcc}.|uuid|string||path||
  43
  44 h2. get
  45
  46 Gets a KeepDisk's metadata by UUID.
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52 {background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path||
  53
  54 h2. index
  55
  56 index keep_disks
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62 |order|string||query||
  63 |where|object||query||
  64
  65 h2. list
  66
  67 List keep_disks.
  68
  69 Arguments:
  70
  71 table(table table-bordered table-condensed).
  72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  73 |limit|integer (default 100)|Maximum number of keep_disks to return.|query||
  74 |order|string|Order in which to return matching keep_disks.|query||
  75 |pageToken|string|Page token.|query||
  76 |q|string|Query string for searching keep_disks.|query||
  77 |where|object|Conditions for filtering keep_disks.|query||
  78
  79 h2. ping
  80
  81 ping keep_disks
  82
  83 Arguments:
  84
  85 table(table table-bordered table-condensed).
  86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  87 {background:#ccffcc}.|ping_secret|string||query||
  88 {background:#ccffcc}.|service_port|string||query||
  89 {background:#ccffcc}.|service_ssl_flag|string||query||
  90 |filesystem_uuid|string||query||
  91 |node_uuid|string||query||
  92 |service_host|string||query||
  93 |uuid|string||query||
  94
  95 h2. show
  96
  97 show keep_disks
  98
  99 Arguments:
 100
 101 table(table table-bordered table-condensed).
 102 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 103 {background:#ccffcc}.|uuid|string||path||
 104
 105 h2. update
 106
 107 Update attributes of an existing KeepDisk.
 108
 109 Arguments:
 110
 111 table(table table-bordered table-condensed).
 112 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 113 {background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path||
 114 |keep_disk|object||query||