[api-ref] Added share servers show and corrected path to details
Change-Id: Idc0fbd9f786b50dd4899258337aa5bcb61c4ab0a Closes-Bug: #1795604
This commit is contained in:
parent
9f0b35b807
commit
a84423a1be
@ -928,24 +928,6 @@ create_share_from_snapshot_support:
|
|||||||
required: false
|
required: false
|
||||||
type: boolean
|
type: boolean
|
||||||
min_version: 2.24
|
min_version: 2.24
|
||||||
created_at_11:
|
|
||||||
description: |
|
|
||||||
The date and time stamp when the share server was created.
|
|
||||||
|
|
||||||
The date and time stamp format is `ISO 8601
|
|
||||||
<https://en.wikipedia.org/wiki/ISO_8601>`_:
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
CCYY-MM-DDThh:mm:ss±hh:mm
|
|
||||||
|
|
||||||
The ``±hh:mm`` value, if included, returns the time zone as an
|
|
||||||
offset from UTC.
|
|
||||||
|
|
||||||
For example, ``2015-08-27T09:49:58-05:00``.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
created_at_4:
|
created_at_4:
|
||||||
description: |
|
description: |
|
||||||
The date and time stamp when the share was created.
|
The date and time stamp when the share was created.
|
||||||
@ -1008,6 +990,24 @@ created_at_9:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
created_at_share_server_body:
|
||||||
|
description: |
|
||||||
|
The date and time stamp when the share server was created.
|
||||||
|
|
||||||
|
The date and time stamp format is `ISO 8601
|
||||||
|
<https://en.wikipedia.org/wiki/ISO_8601>`_:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
CCYY-MM-DDThh:mm:ss±hh:mm
|
||||||
|
|
||||||
|
The ``±hh:mm`` value, if included, returns the time zone as an
|
||||||
|
offset from UTC.
|
||||||
|
|
||||||
|
For example, ``2015-08-27T09:49:58-05:00``.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
deny_access:
|
deny_access:
|
||||||
description: |
|
description: |
|
||||||
The ``deny_access`` object.
|
The ``deny_access`` object.
|
||||||
@ -1528,18 +1528,18 @@ host_6:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
host_8:
|
|
||||||
description: |
|
|
||||||
The share server host name or IP address.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
host_9:
|
host_9:
|
||||||
description: |
|
description: |
|
||||||
The share host name.
|
The share host name.
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
host_share_server_body:
|
||||||
|
description: |
|
||||||
|
The share server host name or IP address.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
id_12:
|
id_12:
|
||||||
description: |
|
description: |
|
||||||
The service ID.
|
The service ID.
|
||||||
@ -1552,12 +1552,6 @@ id_13:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
id_14:
|
|
||||||
description: |
|
|
||||||
The share server ID.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
id_16:
|
id_16:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the snapshot.
|
The UUID of the snapshot.
|
||||||
@ -2043,12 +2037,6 @@ project_id_4:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
project_id_7:
|
|
||||||
description: |
|
|
||||||
The project ID.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
project_id_8:
|
project_id_8:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the project where the share was
|
The UUID of the project where the share was
|
||||||
@ -2069,6 +2057,12 @@ project_id_messages_body:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
project_id_share_server_body:
|
||||||
|
description: |
|
||||||
|
The project ID.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
protocol:
|
protocol:
|
||||||
description: |
|
description: |
|
||||||
The Shared File Systems protocol of the share to
|
The Shared File Systems protocol of the share to
|
||||||
@ -2878,7 +2872,7 @@ share_network_id_4:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
share_network_id_6:
|
share_network_id_share_server_body:
|
||||||
description: |
|
description: |
|
||||||
The UUID of a share network that is associated
|
The UUID of a share network that is associated
|
||||||
with the share server.
|
with the share server.
|
||||||
@ -3476,13 +3470,6 @@ status_10:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
status_15:
|
|
||||||
description: |
|
|
||||||
The share server status, which is ``active``,
|
|
||||||
``error``, ``creating``, or ``deleting``.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
status_16:
|
status_16:
|
||||||
description: |
|
description: |
|
||||||
The share status, which is ``creating``,
|
The share status, which is ``creating``,
|
||||||
@ -3542,6 +3529,13 @@ status_8:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
status_share_server_body:
|
||||||
|
description: |
|
||||||
|
The share server status, which is ``active``,
|
||||||
|
``error``, ``creating``, or ``deleting``.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
storage_protocol:
|
storage_protocol:
|
||||||
description: |
|
description: |
|
||||||
The storage protocol for the back end. For
|
The storage protocol for the back end. For
|
||||||
@ -3692,7 +3686,7 @@ updated_at_5:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
updated_at_6:
|
updated_at_share_server_body:
|
||||||
description: |
|
description: |
|
||||||
The date and time stamp when the share server was updated.
|
The date and time stamp when the share server was updated.
|
||||||
|
|
||||||
|
@ -72,13 +72,13 @@ Response parameters
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- id: id_14
|
- id: share_server_id
|
||||||
- project_id: project_id_7
|
- project_id: project_id_share_server_body
|
||||||
- status: status_15
|
- status: status_share_server_body
|
||||||
- share_network_id: share_network_id
|
- share_network_id: share_network_id
|
||||||
- share_network_name: share_network_name
|
- share_network_name: share_network_name
|
||||||
- host: host_8
|
- host: host_share_server_body
|
||||||
- updated_at: updated_at_6
|
- updated_at: updated_at_share_server_body
|
||||||
|
|
||||||
Response example
|
Response example
|
||||||
----------------
|
----------------
|
||||||
@ -87,12 +87,12 @@ Response example
|
|||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Show share server details
|
Show share server
|
||||||
=========================
|
=================
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/share-servers/{share_server_id}/detail
|
.. rest_method:: GET /v2/{tenant_id}/share-servers/{share_server_id}
|
||||||
|
|
||||||
Shows details for a share server.
|
Show a share server's details.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
--------------
|
--------------
|
||||||
@ -121,15 +121,58 @@ Response parameters
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- id: id_14
|
- id: share_server_id
|
||||||
- project_id: project_id_7
|
- project_id: project_id_share_server_body
|
||||||
- status: status_15
|
- status: status_share_server_body
|
||||||
- backend_details: backend_details
|
- backend_details: backend_details
|
||||||
- share_network_id: share_network_id_6
|
- share_network_id: share_network_id_share_server_body
|
||||||
- share_network_name: share_network_name
|
- share_network_name: share_network_name
|
||||||
- host: host_8
|
- host: host_share_server_body
|
||||||
- created_at: created_at_11
|
- created_at: created_at_share_server_body
|
||||||
- updated_at: updated_at_6
|
- updated_at: updated_at_share_server_body
|
||||||
|
|
||||||
|
Response example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/share-server-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
Show share server back end details
|
||||||
|
==================================
|
||||||
|
|
||||||
|
.. rest_method:: GET /v2/{tenant_id}/share-servers/{share_server_id}/details
|
||||||
|
|
||||||
|
Shows back end details of a share server.
|
||||||
|
|
||||||
|
Response codes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
.. rest_status_code:: success status.yaml
|
||||||
|
|
||||||
|
- 200
|
||||||
|
|
||||||
|
.. rest_status_code:: error status.yaml
|
||||||
|
|
||||||
|
- 400
|
||||||
|
- 401
|
||||||
|
- 403
|
||||||
|
- 404
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- tenant_id: tenant_id_path
|
||||||
|
- share_server_id: share_server_id
|
||||||
|
|
||||||
|
Response parameters
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Response parameters can differ based on the back end used.
|
||||||
|
Each back end can store any key-value information that it requires.
|
||||||
|
For example, the generic back end driver might store the router ID.
|
||||||
|
|
||||||
Response example
|
Response example
|
||||||
----------------
|
----------------
|
||||||
|
Loading…
Reference in New Issue
Block a user