blob: d170fa053f7a228f14ed17a6a18f0de65f21539b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
.. -*- rst -*-
================================================
Listing Volume resources by Node (nodes, volume)
================================================
.. versionadded:: 1.32
Given a Node identifier (``uuid`` or ``name``), the API exposes the list of,
and details of, all Volume resources associated with that Node.
These endpoints do not allow modification of the Volume connectors and Volume
targets; that should be done by accessing the Volume resources under the
``/v1/volume/connectors`` and ``/v1/volume/targets`` endpoint.
List Links of Volume Resources by Node
======================================
.. rest_method:: GET /v1/nodes/{node_ident}/volume
Return a list of links to all volume resources associated with ``node_ident``.
Normal response code: 200
Request
-------
.. rest_parameters:: parameters.yaml
- node_ident: node_ident
Response
--------
.. rest_parameters:: parameters.yaml
- connectors: volume_connectors_link
- targets: volume_targets_link
- links: links
**Example Volume list response:**
.. literalinclude:: samples/node-volume-list-response.json
:language: javascript
List Volume connectors by Node
==============================
.. rest_method:: GET /v1/nodes/{node_ident}/volume/connectors
Return a list of bare metal Volume connectors associated with ``node_ident``.
Normal response code: 200
Error codes: 400,401,403,404
Request
-------
.. rest_parameters:: parameters.yaml
- node_ident: node_ident
- fields: fields
- limit: limit
- marker: marker
- sort_dir: sort_dir
- sort_key: sort_key
Response
--------
.. rest_parameters:: parameters.yaml
- connectors: volume_connectors
- uuid: uuid
- type: volume_connector_type
- connector_id: volume_connector_connector_id
- node_uuid: node_uuid
- extra: extra
- links: links
- next: next
**Example list of Node's Volume connectors:**
.. literalinclude:: samples/node-volume-connector-list-response.json
**Example detailed list of Node's Volume connectors:**
.. literalinclude:: samples/node-volume-connector-detail-response.json
List Volume targets by Node
===========================
.. rest_method:: GET /v1/nodes/{node_ident}/volume/targets
Return a list of bare metal Volume targets associated with ``node_ident``.
Normal response code: 200
Error codes: 400,401,403,404
Request
-------
.. rest_parameters:: parameters.yaml
- node_ident: node_ident
- fields: fields
- limit: limit
- marker: marker
- sort_dir: sort_dir
- sort_key: sort_key
Response
--------
.. rest_parameters:: parameters.yaml
- targets: volume_targets
- uuid: uuid
- volume_type: volume_target_volume_type
- properties: volume_target_properties
- boot_index: volume_target_boot_index
- volume_id: volume_target_volume_id
- extra: extra
- node_uuid: node_uuid
- links: links
- next: next
**Example list of Node's Volume targets:**
.. literalinclude:: samples/node-volume-target-list-response.json
**Example detailed list of Node's Volume targets:**
.. literalinclude:: samples/node-volume-target-detail-response.json
|
