9 Copyright (C) The Arvados Authors. All rights reserved.
11 SPDX-License-Identifier: CC-BY-SA-3.0
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' %}
18 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_disks@
22 Example UUID: @zzzzz-penuu-0123456789abcde@
26 Obsoleted by "keep_services":{{site.baseurl}}/api/methods/keep_services.html
28 Each KeepDisk has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
30 table(table table-bordered table-condensed).
31 |_. Attribute|_. Type|_. Description|_. Example|
32 |ping_secret|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|||
46 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
48 Required arguments are displayed in %{background:#ccffcc}green%.
52 Create a new KeepDisk.
56 table(table table-bordered table-condensed).
57 |_. Argument |_. Type |_. Description |_. Location |_. Example |
58 |keep_disk|object||query||
62 Delete an existing KeepDisk.
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||
72 Gets a KeepDisk's metadata by UUID.
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||
84 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
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||
104 Update attributes of an existing KeepDisk.
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||