3783 lines
91 KiB
YAML
3783 lines
91 KiB
YAML
# variables in header
|
|
#{}
|
|
|
|
# variables in path
|
|
api_version:
|
|
in: path
|
|
required: true
|
|
type: string
|
|
description: >
|
|
The API version as returned in the links from the ``GET /`` call.
|
|
export_location_id_path:
|
|
description: |
|
|
The UUID of the export location.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
group_snapshot_id_path:
|
|
description: |
|
|
The group snapshot ID.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
message_id:
|
|
description: |
|
|
The UUID of the message.
|
|
in: path
|
|
required: false
|
|
type: string
|
|
quota_class_name:
|
|
description:
|
|
The name of the quota class for which to set quotas.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
security_service_id_path:
|
|
description: |
|
|
The UUID of the security service.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
share_group_id_path:
|
|
description: |
|
|
The UUID of the share group.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
share_group_type_id_path:
|
|
description: |
|
|
The UUID of the share group type.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
share_id:
|
|
description: |
|
|
The UUID of the share.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
share_instance_id:
|
|
description: |
|
|
The UUID of the share instance.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
share_network_id_path:
|
|
description: |
|
|
The UUID of the share network.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
share_replica_id_path:
|
|
description: |
|
|
The UUID of the share replica.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
share_type_for_quota:
|
|
description: |
|
|
The name or UUID of the share type. If you specify this
|
|
parameter in the URI, you show, update, or delete quotas
|
|
for this share type.
|
|
in: path
|
|
required: false
|
|
type: string
|
|
min_version: 2.39
|
|
share_type_id:
|
|
description: |
|
|
The UUID of the share type.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
snapshot_id_path:
|
|
description: |
|
|
The UUID of the snapshot.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
snapshot_instance_id_path:
|
|
description: |
|
|
The UUID of the share snapshot instance.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tenant_id:
|
|
description: |
|
|
The UUID for the tenant for which you want to
|
|
show, update, or delete quotas. This ID is different from the
|
|
first tenant ID that you specify in the URI: That ID is for the
|
|
administrative tenant.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tenant_id_path:
|
|
description: |
|
|
The tenant ID in a multi-tenancy cloud.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
|
|
# variables in query
|
|
action_id:
|
|
in: query
|
|
required: false
|
|
type: string
|
|
description: >
|
|
The ID of the action during which the message was created.
|
|
all_tenants:
|
|
description: |
|
|
(Admin only). Defines whether to list the requested resources for
|
|
all projects. Set to ``1`` to list resources for all projects.
|
|
Set to ``0`` to list resources only for the current tenant. Examples
|
|
of resources include shares, snapshots, share networks, security services
|
|
and share groups.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
backend_capabilities_query:
|
|
description: |
|
|
The capabilities for the storage back end.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
backend_host_query:
|
|
description: |
|
|
The host name for the back end.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
backend_pool_query:
|
|
description: |
|
|
The pool name for the back end.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
backend_query:
|
|
description: |
|
|
The name of the back end.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
description_inexact_query:
|
|
description: |
|
|
The description pattern that can be used to filter shares,
|
|
share snapshots, share networks or share groups.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
min_version: 2.36
|
|
description_query:
|
|
description: |
|
|
The share group description that can be used to filter
|
|
share groups.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
detail_id:
|
|
in: query
|
|
required: false
|
|
type: string
|
|
description: >
|
|
The ID of the message detail.
|
|
export_location_id_query:
|
|
description: |
|
|
The export location UUID that can be used to filter shares or
|
|
share instances.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
min_version: 2.35
|
|
export_location_path_query:
|
|
description: |
|
|
The export location path that can be used to filter shares or
|
|
share instances.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
min_version: 2.35
|
|
extra_specs_query:
|
|
description: |
|
|
The extra specifications as a set of one or more
|
|
key-value pairs. In each pair, the key is the name of the extra
|
|
specification and the value is the share type that was used to
|
|
filter search share type list.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
min_version: 2.43
|
|
group_snapshot_description_query:
|
|
description: |
|
|
The share group snapshot description that can be used to filter
|
|
share group snapshots.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
group_snapshot_name_query:
|
|
description: |
|
|
The share group snapshot name that can be used to filter
|
|
share group snapshots.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
group_snapshot_status_query:
|
|
description: |
|
|
Filters by a share group snapshot status. A valid value is
|
|
``creating``, ``error``, ``available``, ``deleting``,
|
|
``error_deleting``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
host_7:
|
|
description: |
|
|
The share host name.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
limit:
|
|
description: |
|
|
The maximum number of shares to return.
|
|
in: query
|
|
required: false
|
|
type: integer
|
|
limit_query:
|
|
description: |
|
|
The maximum number of share groups members to return.
|
|
in: query
|
|
required: false
|
|
type: integer
|
|
media_types:
|
|
description: |
|
|
Media types supported by the API.
|
|
in: query
|
|
required: false
|
|
type: object
|
|
message_level:
|
|
in: query
|
|
required: false
|
|
type: string
|
|
description: >
|
|
The message level.
|
|
name_inexact_query:
|
|
description: |
|
|
The name pattern that can be used to filter shares,
|
|
share snapshots, share networks or share groups.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
min_version: 2.36
|
|
name_query:
|
|
description: |
|
|
The share group name that can be used to filter share groups.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
offset:
|
|
description: |
|
|
The offset to define start point of share or share group
|
|
listing.
|
|
in: query
|
|
required: false
|
|
type: integer
|
|
project_id_6:
|
|
description: |
|
|
The UUID of the project in which the share was
|
|
created. Useful with ``all_tenants`` parameter.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
project_id_messages:
|
|
description: |
|
|
The UUID of the project for which the message was created.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
request_id:
|
|
description: |
|
|
The UUID of the request during which the message was created.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
resource_id:
|
|
description: |
|
|
The UUID of the resource for which the message was created.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
resource_type:
|
|
description: |
|
|
The type of the resource for which the message was created.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
service_binary_query:
|
|
description: |
|
|
The service binary name. Default is the base name
|
|
of the executable.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
service_host_query:
|
|
description: |
|
|
The service host name.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
service_state_query:
|
|
description: |
|
|
The current state of the service. A valid value
|
|
is ``up`` or ``down``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
service_status_query:
|
|
description: |
|
|
The service status, which is ``enabled`` or
|
|
``disabled``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
service_zone_query:
|
|
description: |
|
|
The availability zone.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
share_group_id_query:
|
|
description: |
|
|
The UUID of a share group to filter resource.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
min_version: 2.31
|
|
share_group_status_query:
|
|
description: |
|
|
Filters by a share group status. A valid value is
|
|
``creating``, ``error``, ``available``, ``deleting``,
|
|
``error_deleting``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
share_group_type_id_query:
|
|
description: |
|
|
The share group type ID to filter share groups.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
share_network_id_5:
|
|
description: |
|
|
The UUID of the share network.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
share_network_id_query:
|
|
description: |
|
|
The UUID of the share network.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
share_server_id_query:
|
|
description: |
|
|
The UUID of the share server.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
share_type_id_2:
|
|
description: |
|
|
(Since API v2.6) The UUID of the share type.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
share_type_query:
|
|
description: |
|
|
The share type name or UUID. Allows filtering back end pools based
|
|
on the extra-specs in the share type.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
share_types_query:
|
|
description: |
|
|
A list of one or more share type IDs. Allows filtering share groups.
|
|
in: query
|
|
required: false
|
|
type: array
|
|
snapshot_id_query:
|
|
description: |
|
|
The UUID of the share's base snapshot to filter the request based on.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
sort_dir:
|
|
description: |
|
|
The direction to sort a list of shares. A valid
|
|
value is ``asc``, or ``desc``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
sort_key:
|
|
description: |
|
|
The key to sort a list of shares. A valid value
|
|
is ``id``, ``status``, ``size``, ``host``, ``share_proto``,
|
|
``export_location``, ``availability_zone``, ``user_id``,
|
|
``project_id``, ``created_at``, ``updated_at``, ``display_name``,
|
|
``name``, ``share_type_id``, ``share_type``, ``share_network_id``,
|
|
``share_network``, ``snapshot_id``, or ``snapshot``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
sort_key_messages:
|
|
description: |
|
|
The key to sort a list of messages. A valid value
|
|
is ``id``, ``project_id``, ``request_id``, ``resource_type``,
|
|
``action_id``, ``detail_id``, ``resource_id``, ``message_level``,
|
|
``expires_at``, ``created_at``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
source_share_group_snapshot_id_query:
|
|
description: |
|
|
The source share group snapshot ID to list the
|
|
share group.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
min_version: 2.31
|
|
state_2:
|
|
description: |
|
|
The current state of the service. A valid value
|
|
is ``up`` or ``down``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
status_17:
|
|
description: |
|
|
The service status, which is ``enabled`` or
|
|
``disabled``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
status_6:
|
|
description: |
|
|
Filters by a share status. A valid value is
|
|
``creating``, ``error``, ``available``, ``deleting``,
|
|
``error_deleting``, ``manage_starting``, ``manage_error``,
|
|
``unmanage_starting``, ``unmanage_error``, ``unmanaged``,
|
|
``extending``, ``extending_error``, ``shrinking``,
|
|
``shrinking_error``, or ``shrinking_possible_data_loss_error``.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
user_id_query:
|
|
description: |
|
|
The UUID of the user. If you specify this query parameter,
|
|
you update the quotas for this user in the tenant.
|
|
If you omit this parameter, you update the quotas for the project.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
with_count:
|
|
description: |
|
|
Whether to show ``count`` in API response or not, default is ``False``.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
min_version: 2.42
|
|
zone_1:
|
|
description: |
|
|
The availability zone.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
|
|
# variables in body
|
|
access:
|
|
description: |
|
|
The ``access`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
access_id:
|
|
description: |
|
|
The UUID of the access rule to which access is
|
|
granted.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
access_key:
|
|
description: |
|
|
The access credential of the entity granted share access.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
min_version: 2.21
|
|
access_level:
|
|
description: |
|
|
The access level to the share. To grant or deny
|
|
access to a share, you specify one of the following share access
|
|
levels: - ``rw``. Read and write (RW) access. - ``ro``. Read-
|
|
only (RO) access.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
access_list:
|
|
description: |
|
|
The object of the access rule. To list access
|
|
rules, set this value to ``null``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
access_rule_created_at:
|
|
description: |
|
|
The date and time stamp when the access rule 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
|
|
access_rule_id:
|
|
description: |
|
|
The access rule ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
access_rule_updated_at:
|
|
description: |
|
|
The date and time stamp when the access rule was updated.
|
|
|
|
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``.
|
|
|
|
If the access rule was never updated, this value is ``null``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
access_rules_status:
|
|
description: |
|
|
The share instance access rules status. A valid value is ``active``,
|
|
``error``, or ``syncing``. In versions prior to 2.28, ``syncing`` was
|
|
represented with status ``out_of_sync``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
min_version: 2.10
|
|
access_share_id:
|
|
description: |
|
|
The UUID of the share to which you are granted
|
|
or denied access.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
access_status:
|
|
description: |
|
|
The share access status, which is ``new``,
|
|
``error``, ``active``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
access_to:
|
|
description: |
|
|
The value that defines the access. The back end
|
|
grants or denies the access to it. A valid value is one of these
|
|
values: - ``ip``. Authenticates an instance through its IP
|
|
address. A valid format is ``XX.XX.XX.XX`` or
|
|
``XX.XX.XX.XX/XX``. For example ``0.0.0.0/0``. - ``cert``.
|
|
Authenticates an instance through a TLS certificate. Specify the
|
|
TLS identity as the IDENTKEY. A valid value is any string up to
|
|
64 characters long in the common name (CN) of the certificate.
|
|
The meaning of a string depends on its interpretation. -
|
|
``user``. Authenticates by a user or group name. A valid value is
|
|
an alphanumeric string that can contain some special characters
|
|
and is from 4 to 32 characters long.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
access_type:
|
|
description: |
|
|
The access rule type. A valid value for the
|
|
share access rule type is one of the following values: - ``ip``.
|
|
Authenticates an instance through its IP address. A valid format
|
|
is ``XX.XX.XX.XX`` or ``XX.XX.XX.XX/XX``. For example
|
|
``0.0.0.0/0``. - ``cert``. Authenticates an instance through a
|
|
TLS certificate. Specify the TLS identity as the IDENTKEY. A
|
|
valid value is any string up to 64 characters long in the common
|
|
name (CN) of the certificate. The meaning of a string depends on
|
|
its interpretation. - ``user``. Authenticates by a user or
|
|
group name. A valid value is an alphanumeric string that can
|
|
contain some special characters and is from 4 to 32 characters
|
|
long.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
action_id_body:
|
|
in: body
|
|
required: true
|
|
type: string
|
|
description: >
|
|
The ID of the action during which the message was created.
|
|
alias:
|
|
description: |
|
|
The alias for the extension. For example,
|
|
"FOXNSOX," "os- availability-zone," "os-extended-quotas," "os-
|
|
share-unmanage," or "os-used-limits."
|
|
in: body
|
|
required: true
|
|
type: string
|
|
allow_access:
|
|
description: |
|
|
The object of grant access.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
availability_zone:
|
|
description: |
|
|
(Since API v2.1) The availability zone.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
availability_zone_1:
|
|
description: |
|
|
The availability zone.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
availability_zone_created_at:
|
|
description: |
|
|
The date and time stamp when the availability zone 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
|
|
availability_zone_id:
|
|
description: |
|
|
The availability zone ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
availability_zone_id_2:
|
|
description: |
|
|
The availability zone ID for create share group.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
min_version: 2.34
|
|
availability_zone_name:
|
|
description: |
|
|
The name of the availability zone.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
availability_zone_updated_at:
|
|
description: |
|
|
The date and time stamp when the availability zone was updated.
|
|
|
|
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
|
|
availability_zones:
|
|
description: |
|
|
Top level response body element.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
backend:
|
|
description: |
|
|
The name of the back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
backend_details:
|
|
description: |
|
|
The back-end details for a server. Each back end
|
|
can store any key- value information that it requires. For
|
|
example, the generic back- end driver might store the router ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
backend_details_1:
|
|
description: |
|
|
The back-end details for a server. Each back end
|
|
can store any key- value information that it requires. For
|
|
example, the generic back- end driver might store the router ID.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
backend_host:
|
|
description: |
|
|
The host name for the back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
backend_name:
|
|
description: |
|
|
The name of the back end in this format:
|
|
``host@backend#POOL``. - ``host``. The host name for the back
|
|
end. - ``backend``. The name of the back end. - ``POOL``. The
|
|
pool name for the back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
binary:
|
|
description: |
|
|
The name of the service binary that you want to
|
|
disable. Typically, this name is the base name of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
binary_1:
|
|
description: |
|
|
The name of the service binary that you want to
|
|
enable. Typically, this name is the base name of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
binary_2:
|
|
description: |
|
|
The service binary name. Default is the base name
|
|
of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
binary_4:
|
|
description: |
|
|
The name of the disabled service binary.
|
|
Typically, this name is the base name of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
binary_5:
|
|
description: |
|
|
The name of the enabled service binary.
|
|
Typically, this name is the base name of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
capabilities:
|
|
description: |
|
|
The back end capabilities which include ``qos``, ``total_capacity_gb``,
|
|
etc.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
capability_driver_handles_share_servers:
|
|
description: |
|
|
Share server is usually a storage virtual machine or a lightweight
|
|
container that is used to export shared file systems. Storage backends
|
|
may be able to work with configured share servers or allow the
|
|
share driver to create and manage the lifecycle of share servers. This
|
|
capability specifies whether the pool's associated share driver is
|
|
responsible to create and manage the lifecycle of share servers. If
|
|
``false``, the administrator of the shared file systems service has
|
|
configured the share server as necessary for the given back end.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
capability_driver_version:
|
|
description: |
|
|
The driver version of the back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
capability_free_capacity_gb:
|
|
description: |
|
|
The amount of free capacity for the back end, in
|
|
GBs. A valid value is a string, such as ``unknown``, or an
|
|
integer.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
capability_qos:
|
|
description: |
|
|
The quality of service (QoS) support.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
capability_replication_domain:
|
|
description: |
|
|
The back end replication domain.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
capability_reserved_percentage:
|
|
description: |
|
|
The percentage of the total capacity that is
|
|
reserved for the internal use by the back end.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
capability_server_pools_mapping:
|
|
description: |
|
|
The mapping between servers and pools.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
capability_share_backend_name:
|
|
description: |
|
|
The name of the share back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
capability_snapshot_support:
|
|
description: |
|
|
The specification that filters back ends by
|
|
whether they do or do not support share snapshots.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
capability_storage_protocol:
|
|
description: |
|
|
The storage protocol for the back end. For
|
|
example, ``NFS_CIFS``, ``glusterfs``, ``HDFS``, etc.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
capability_total_capacity_gb:
|
|
description: |
|
|
The total capacity for the back end, in GBs. A
|
|
valid value is a string, such as ``unknown``, or an integer.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
capability_vendor_name:
|
|
description: |
|
|
The name of the vendor for the back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
cidr:
|
|
description: |
|
|
The CIDR.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
cidr_1:
|
|
description: |
|
|
The IP block from which to allocate the network,
|
|
in CIDR notation. For example, ``172.16.0.0/24`` or
|
|
``2001:DB8::/64``. This parameter is automatically set to a value
|
|
determined by the network provider.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
consistent_snapshot_support:
|
|
description: |
|
|
The consistency snapshot support.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
min_version: 2.34
|
|
count:
|
|
description: |
|
|
The total count of requested resource before pagination is applied.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
min_version: 2.42
|
|
create_share_from_snapshot_support:
|
|
description: |
|
|
Boolean extra spec used for filtering of back ends by
|
|
their capability to create shares from snapshots.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
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:
|
|
description: |
|
|
The date and time stamp when the share 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_5:
|
|
description: |
|
|
The date and time stamp when the share instance export location 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, ``2016-12-31T13:14:15-05:00``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
created_at_8:
|
|
description: |
|
|
The date and time stamp when the member was
|
|
created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
created_at_9:
|
|
description: |
|
|
The date and time stamp when the share instance 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:
|
|
description: |
|
|
The ``deny_access`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
description_10:
|
|
description: |
|
|
The snapshot description.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
description_11:
|
|
description: |
|
|
The snapshot description.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
description_3:
|
|
description: |
|
|
The security service description.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
description_4:
|
|
description: |
|
|
The share network description.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
description_5:
|
|
description: |
|
|
The share description.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
description_8:
|
|
description: |
|
|
The extension description.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
description_9:
|
|
description: |
|
|
The security service description.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
detail_id_body:
|
|
in: body
|
|
required: true
|
|
type: string
|
|
description: >
|
|
The ID of the message detail.
|
|
disabled:
|
|
description: |
|
|
Indicates whether the service is disabled.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
display_description:
|
|
description: |
|
|
The share description. The Shared File Systems
|
|
API supports the use of both ``description`` and
|
|
``display_description`` parameters, which are inherited attributes
|
|
from the Block Storage API.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
display_description_2:
|
|
description: |
|
|
The snapshot description. If you specify this
|
|
attribute, the snapshot ``description`` is updated.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
display_description_3:
|
|
description: |
|
|
The share description. If you specify this
|
|
parameter, the share description is updated.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
display_name:
|
|
description: |
|
|
The share name. The Shared File Systems API
|
|
supports the use of both ``name`` and ``display_name`` attributes,
|
|
which are inherited attributes from the Block Storage API.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
display_name_2:
|
|
description: |
|
|
The snapshot name. The shared file systems API
|
|
supports the use of both ``name`` and ``display_name`` attributes,
|
|
which are inherited attributes from the Block Storage API.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
display_name_3:
|
|
description: |
|
|
The snapshot name. If you specify this attribute,
|
|
the snapshot ``name`` is updated.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
display_name_4:
|
|
description: |
|
|
The share name. If you specify this parameter,
|
|
the share name is updated.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
driver_handles_share_servers:
|
|
description: |
|
|
An extra specification that defines the driver
|
|
mode for share server, or storage, life cycle management. The
|
|
Shared File Systems service creates a share server for the export
|
|
of shares. This value is ``true`` when the share driver manages,
|
|
or handles, the share server life cycle. This value is ``false``
|
|
when an administrator rather than a share driver manages the
|
|
storage life cycle.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
driver_handles_share_servers_1:
|
|
description: |
|
|
An extra specification that defines the driver
|
|
mode for share server, or storage, life cycle management. The
|
|
Shared File Systems service creates a share server for the export
|
|
of shares. Set to ``true`` when the share driver manages, or
|
|
handles, the share server life cycle. Set to ``false`` when an
|
|
administrator rather than a share driver manages the storage life
|
|
cycle.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
driver_options:
|
|
description: |
|
|
A set of one or more key and value pairs, as a
|
|
dictionary of strings, that describe driver options.
|
|
in: body
|
|
required: false
|
|
type: object
|
|
driver_options_1:
|
|
description: |
|
|
A set of one or more key and value pairs, as a
|
|
dictionary of strings, that describe driver options. Details for
|
|
driver options should be taken from `appropriate share driver
|
|
documentation <https://docs.openstack.org/manila/latest
|
|
/configuration/shared-file-systems/drivers.html>`_.
|
|
in: body
|
|
required: false
|
|
type: object
|
|
driver_version:
|
|
description: |
|
|
The driver version.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
export_location:
|
|
description: |
|
|
The export location. For newer API versions it is available in
|
|
separate APIs. See sections `Share export locations
|
|
<#share-share-export-locations>`_ and `Share instance export
|
|
locations <#share-share-instance-export- locations>`_.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
max_version: 2.8
|
|
export_location_created_at:
|
|
description: |
|
|
The date and time stamp when the share export location 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, ``2016-12-31T13:14:15-05:00``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
export_location_id:
|
|
description: |
|
|
The share export location UUID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
export_location_is_admin_only:
|
|
description: |
|
|
Defines purpose of an export location. If set to
|
|
``true``, then it is expected to be used for service needs and by
|
|
administrators only. If it is set to ``false``, then this export
|
|
location can be used by end users.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
export_location_path:
|
|
description: |
|
|
The export location path that should be used for mount operation.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
export_location_preferred:
|
|
description: |
|
|
Drivers may use this field to identify which export locations
|
|
are most efficient and should be used preferentially by clients.
|
|
By default it is set to ``false`` value.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
min_version: 2.14
|
|
export_location_share_instance_id:
|
|
description: |
|
|
The UUID of the share instance that this
|
|
export location belongs to.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
export_location_updated_at:
|
|
description: |
|
|
The date and time stamp when the share export location was
|
|
updated.
|
|
|
|
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, ``2016-12-31T13:14:15-05:00``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
export_locations:
|
|
description: |
|
|
A list of export locations. For example, when a share server
|
|
has more than one network interface, it can have multiple export
|
|
locations. For newer API versions it is available in separate APIs.
|
|
See sections `Share export locations <#share-share-export-locations>`_
|
|
and `Share instance export locations <#share-share-instance-
|
|
export- locations>`_.
|
|
in: body
|
|
required: false
|
|
type: array
|
|
max_version: 2.8
|
|
export_path:
|
|
description: |
|
|
The share export path in the format appropriate
|
|
for the protocol: - NFS protocol. ``10.0.0.1:/foo_path``. For
|
|
example, ``10.254.0.5:/shares/share-42033c24-0261-424f-abda-
|
|
4fef2f6dbfd5``. - CIFS protocol.
|
|
``\\10.0.0.1\foo_name_of_cifs_share``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
extend:
|
|
description: |
|
|
The ``extend`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
extension_alias:
|
|
description: |
|
|
The alias for the extension. For example,
|
|
"FOXNSOX", "os-availability-zone", "os-extended-quotas", "os-
|
|
share-unmanage", or "os-used-limits".
|
|
in: body
|
|
required: true
|
|
type: string
|
|
extension_description:
|
|
description: |
|
|
The extension description.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
extension_links:
|
|
description: |
|
|
The extension links.
|
|
in: body
|
|
required: true
|
|
type: array
|
|
extension_name:
|
|
description: |
|
|
The name of the extension. For example, "Fox In Socks."
|
|
in: body
|
|
required: true
|
|
type: string
|
|
extension_updated:
|
|
description: |
|
|
The date and time stamp when the extension was last updated.
|
|
|
|
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
|
|
extra-spec-key:
|
|
description: |
|
|
The extra specification key
|
|
in: body
|
|
required: true
|
|
type: string
|
|
extra_specs:
|
|
description: |
|
|
The extra specifications for the share type.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
force:
|
|
description: |
|
|
Indicates whether to permit or deny the force-
|
|
update of a quota that is already used and the requested value
|
|
exceeds the configured quota. Set to ``True`` to permit the
|
|
force-update of the quota. Set to ``False`` to deny the force-
|
|
update of the quota.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
force_delete_2:
|
|
description: |
|
|
To force-delete a share instance, set this value
|
|
to ``null``. The force-delete action, unlike the delete action,
|
|
ignores the share instance status.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
force_host_copy:
|
|
description: |
|
|
Enables or disables generic host-based forced
|
|
migrations, which bypasses driver optimizations. Default value is
|
|
``false``.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
force_snapshot_request:
|
|
description: |
|
|
Indicates whether snapshot creation must be attempted
|
|
when a share's status is not ``available``. Set to ``true`` to force
|
|
snapshot creation when the share is busy performing other operations.
|
|
Default is ``false``.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
free_capacity_gb:
|
|
description: |
|
|
The amount of free capacity for the back end, in
|
|
GBs. A valid value is a string, such as ``unknown``, or an
|
|
integer.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
group_snapshot_created_at:
|
|
description: |
|
|
The date and time stamp when the share group snapshot 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
|
|
group_snapshot_description:
|
|
description: |
|
|
The share group snapshot description.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
group_snapshot_description_option:
|
|
description: |
|
|
The share group snapshot description.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
group_snapshot_id:
|
|
description: |
|
|
The share group snapshot ID.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
group_snapshot_links:
|
|
description: |
|
|
The share group snapshot links.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
group_snapshot_members:
|
|
description: |
|
|
The share group snapshot members.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
group_snapshot_name:
|
|
description: |
|
|
The share group snapshot name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
group_snapshot_name_option:
|
|
description: |
|
|
The share group snapshot name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
group_snapshot_status_required:
|
|
description: |
|
|
Filters by a share group snapshot status. A valid value is
|
|
``creating``, ``error``, ``available``, ``deleting``,
|
|
``error_deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
group_spec_key:
|
|
description: |
|
|
The extra specification key for the share group type.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
group_specs:
|
|
description: |
|
|
The extra specifications for the share group type.
|
|
in: body
|
|
required: false
|
|
type: object
|
|
group_specs_required:
|
|
description: |
|
|
The extra specifications for the share group type.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
has_replicas:
|
|
description: |
|
|
(Since API v2.11) Indicates whether a share has
|
|
replicas or not.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
host_1:
|
|
description: |
|
|
The share host name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
host_10:
|
|
description: |
|
|
The host pool of the destination back end, in
|
|
this format: ``host@backend#POOL``. - ``host``. The host name for
|
|
the destination back end. - ``backend``. The name of the
|
|
destination back end. - ``POOL``. The pool name for the
|
|
destination back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
host_13:
|
|
description: |
|
|
The host name of the disabled service.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
host_14:
|
|
description: |
|
|
The host name of the enabled service.
|
|
enable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
host_2:
|
|
description: |
|
|
The host name of the service that you want to
|
|
disable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
host_3:
|
|
description: |
|
|
The host name of the service that you want to
|
|
enable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
host_5:
|
|
description: |
|
|
The service host name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
host_6:
|
|
description: |
|
|
The share instance host name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
host_8:
|
|
description: |
|
|
The share server host name or IP address.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
host_9:
|
|
description: |
|
|
The share host name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
id_12:
|
|
description: |
|
|
The service ID.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
id_13:
|
|
description: |
|
|
The share instance ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
id_14:
|
|
description: |
|
|
The share server ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
id_16:
|
|
description: |
|
|
The UUID of the snapshot.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
id_4:
|
|
description: |
|
|
The UUID of the share.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
id_5:
|
|
description: |
|
|
The share instance export location UUID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
id_6:
|
|
description: |
|
|
The UUID of the export location that belongs to
|
|
share instance.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
id_8:
|
|
description: |
|
|
The UUID of the access rule.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
ip_version:
|
|
description: |
|
|
The IP version of the network. A valid value is
|
|
``4`` or ``6``.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
ip_version_1:
|
|
description: |
|
|
The IP version of the network. A valid value is
|
|
``4`` or ``6``. This parameter is automatically set to a value
|
|
determined by the network provider.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
is_admin_only:
|
|
description: |
|
|
Defines purpose of an export location. If set to
|
|
``true``, then it is expected to be used for service needs and by
|
|
admin only. If it is set to ``false``, then this export location
|
|
should be used by end users.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
is_public:
|
|
description: |
|
|
(Since API v2.8) The level of visibility for the
|
|
share. Set to ``true`` to make share public. Set to ``false`` to
|
|
make it private. Default value is ``false``.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
link_1:
|
|
description: |
|
|
The share links
|
|
in: body
|
|
required: true
|
|
type: array
|
|
links:
|
|
description: |
|
|
The share links
|
|
in: body
|
|
required: true
|
|
type: array
|
|
links_1:
|
|
description: |
|
|
The share links.
|
|
in: body
|
|
required: true
|
|
type: array
|
|
links_2:
|
|
description: |
|
|
The extension links.
|
|
in: body
|
|
required: true
|
|
type: array
|
|
maxTotalShareGigabytes:
|
|
description: |
|
|
The total maximum number of share gigabytes that
|
|
are allowed in a project. You cannot request a share that exceeds
|
|
the allowed gigabytes quota.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
maxTotalShareGigabytesOptional:
|
|
description: |
|
|
The total maximum number of share gigabytes that
|
|
are allowed in a project. You cannot request a share that exceeds
|
|
the allowed gigabytes quota.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
maxTotalShareGroups:
|
|
description: |
|
|
The maximum number of share groups.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
min_version: 2.40
|
|
maxTotalShareGroupSnapshots:
|
|
description: |
|
|
The maximum number of share group snapshots.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
min_version: 2.40
|
|
maxTotalShareNetworks:
|
|
description: |
|
|
The total maximum number of share-networks that
|
|
are allowed in a project.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
maxTotalShareNetworksOptional:
|
|
description: |
|
|
The total maximum number of share-networks that
|
|
are allowed in a project.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
maxTotalShares:
|
|
description: |
|
|
The total maximum number of shares that are
|
|
allowed in a project.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
maxTotalShareSnapshots:
|
|
description: |
|
|
The total maximum number of share snapshots that
|
|
are allowed in a project.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
maxTotalShareSnapshotsOptional:
|
|
description: |
|
|
The total maximum number of share snapshots that
|
|
are allowed in a project.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
maxTotalSharesOptional:
|
|
description: |
|
|
The total maximum number of shares that are
|
|
allowed in a project.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
maxTotalSnapshotGigabytes:
|
|
description: |
|
|
The total maximum number of snapshot gigabytes
|
|
that are allowed in a project.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
maxTotalSnapshotGigabytesOptional:
|
|
description: |
|
|
The total maximum number of snapshot gigabytes
|
|
that are allowed in a project.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
message_level_body:
|
|
in: body
|
|
required: true
|
|
type: string
|
|
description: >
|
|
The message level.
|
|
message_links:
|
|
description: |
|
|
The message links.
|
|
in: body
|
|
required: true
|
|
type: array
|
|
message_members_links:
|
|
description: |
|
|
The message member links.
|
|
in: body
|
|
required: true
|
|
type: array
|
|
metadata:
|
|
description: |
|
|
One or more metadata key and value pairs as a
|
|
dictionary of strings.
|
|
in: body
|
|
required: false
|
|
type: object
|
|
metadata_2:
|
|
description: |
|
|
One or more metadata key-value pairs, as a
|
|
dictionary of strings. For example, ``"project": "my_test", "aim":
|
|
"testing"``. The share server does not respect case-sensitive key
|
|
names. For example, ``"key": "v1"`` and ``"KEY": "V1"`` are
|
|
equivalent. If you specify both key-value pairs, the server sets
|
|
and returns only the ``"KEY": "V1"`` key-value pair.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
metadata_3:
|
|
description: |
|
|
One or more metadata key and value pairs as a
|
|
dictionary of strings.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
metadata_key_request:
|
|
description: |
|
|
The key of a metadata item. For example, if share metadata is
|
|
as follows: ``"project": "my_test", "aim": "testing"``, the keys are
|
|
"project" and "aim".
|
|
in: body
|
|
required: false
|
|
type: object
|
|
migrate-start:
|
|
description: |
|
|
The ``migrate-start`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
migrate_share:
|
|
description: |
|
|
The ``migrate_share`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
migration_complete:
|
|
description: |
|
|
The ``migration_complate`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
mount_snapshot_support:
|
|
description: |
|
|
Boolean extra spec used for filtering of back ends
|
|
by their capability to mount share snapshots.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
min_version: 2.32
|
|
name:
|
|
description: |
|
|
The share network name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
name_10:
|
|
description: |
|
|
The name of the extension. For example, "Fox In
|
|
Socks."
|
|
in: body
|
|
required: true
|
|
type: string
|
|
name_11:
|
|
description: |
|
|
The name of the back end in this format:
|
|
``host@backend#POOL``. - ``host``. The host name for the back
|
|
end. - ``backend``. The name of the back end. - ``POOL``. The
|
|
pool name for the back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
name_14:
|
|
description: |
|
|
The snapshot name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
name_15:
|
|
description: |
|
|
The snapshot name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
name_16:
|
|
description: |
|
|
The security service name. If you specify this
|
|
value, the name is updated.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
name_3:
|
|
description: |
|
|
The security service name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
name_4:
|
|
description: |
|
|
The share network name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
name_5:
|
|
description: |
|
|
The share name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
network_type:
|
|
description: |
|
|
The network type. A valid value is ``VLAN``,
|
|
``VXLAN``, ``GRE``, or ``flat``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
network_type_1:
|
|
description: |
|
|
The network type. A valid value is ``VLAN``,
|
|
``VXLAN``, ``GRE``, or ``flat``. This parameter is automatically
|
|
set to a value determined by the network provider.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
neutron_net_id:
|
|
description: |
|
|
The neutron network ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
neutron_net_id_request:
|
|
description: |
|
|
The UUID of a neutron network when setting up or updating a share
|
|
network with neutron. Specify both a neutron network and a neutron
|
|
subnet that belongs to that neutron network.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
neutron_subnet_id:
|
|
description: |
|
|
The neutron subnet ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
neutron_subnet_id_request:
|
|
description: |
|
|
The UUID of the neutron subnet when setting up or updating a share
|
|
network with neutron. Specify both a neutron network and a neutron
|
|
subnet that belongs to that neutron network.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
next-available:
|
|
description: |
|
|
The date and time stamp when next issues are available.
|
|
|
|
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: false
|
|
type: string
|
|
notify:
|
|
description: |
|
|
Enables or disables notification of data copying completed
|
|
in: body
|
|
required: true
|
|
type: string
|
|
os-force_delete:
|
|
description: |
|
|
The ``force_delete`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
os-migrate_share:
|
|
description: |
|
|
The ``migrate_share`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
os-reset_status:
|
|
description: |
|
|
The ``reset_status`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
os-share-type-access:is_public:
|
|
description: |
|
|
Indicates whether a share type is publicly
|
|
accessible. Default is ``true``, or publicly accessible.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
max_version: 2.6
|
|
path:
|
|
description: |
|
|
The export location path that should be used for mout operation.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
pool:
|
|
description: |
|
|
The pool name for the back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
pools:
|
|
description: |
|
|
The pools for the back end. This value is either
|
|
``null`` or a string value that indicates the capabilities for
|
|
each pool. For example, ``pool_name``, ``total_capacity_gb``,
|
|
``qos``, and so on.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
preferred:
|
|
description: |
|
|
Drivers may use this field to identify which export locations
|
|
are most efficient and should be used preferentially by clients.
|
|
By default it is set to ``false`` value.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
min_version: 2.14
|
|
progress:
|
|
description: |
|
|
The progress of the snapshot creation.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
project:
|
|
description: |
|
|
The UUID of the project to which access to the
|
|
share type is granted.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
project_1:
|
|
description: |
|
|
The UUID of the project for which access to the
|
|
share type is denied.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
project_id:
|
|
description: |
|
|
The UUID of the project where the share network
|
|
was created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
project_id_4:
|
|
description: |
|
|
The UUID of the project in which the share was
|
|
created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
project_id_7:
|
|
description: |
|
|
The project ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
project_id_8:
|
|
description: |
|
|
The UUID of the project where the share was
|
|
created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
project_id_9:
|
|
description: |
|
|
The UUID of the project for which access to the
|
|
share type is granted.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
project_id_messages_body:
|
|
description: |
|
|
The UUID of the project for which the message was created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
protocol:
|
|
description: |
|
|
The Shared File Systems protocol of the share to
|
|
manage. A valid value is ``NFS``, ``CIFS``, ``GlusterFS``,
|
|
``CEPHFS``, ``HDFS`` or ``MAPRFS``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
qos:
|
|
description: |
|
|
The quality of service (QoS) support.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
quota_class_id:
|
|
description: |
|
|
A ``quota_class_set`` id.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
quota_class_set:
|
|
description: |
|
|
A ``quota_class_set`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
quota_gigabytes:
|
|
description: |
|
|
The number of gigabytes allowed for each tenant.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
quota_gigabytes_detail:
|
|
description: |
|
|
The limit, in_use, reserved number of gigabytes allowed
|
|
for each tenant.
|
|
in: body
|
|
min_version: 2.25
|
|
required: true
|
|
type: object
|
|
quota_gigabytes_request:
|
|
description: |
|
|
The number of gigabytes for the tenant.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
quota_set:
|
|
description: |
|
|
The ``quota_set`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
quota_share_group_snapshots:
|
|
description: |
|
|
The number of share group snapshots allowed for each tenant or user.
|
|
in: body
|
|
min_version: 2.40
|
|
required: true
|
|
type: integer
|
|
quota_share_group_snapshots_detail:
|
|
description: |
|
|
The limit, in_use, reserved number of share group snapshots
|
|
for each tenant or user.
|
|
in: body
|
|
min_version: 2.40
|
|
required: true
|
|
type: object
|
|
quota_share_group_snapshots_request:
|
|
description: |
|
|
The number of share group snapshots allowed for each tenant or user.
|
|
in: body
|
|
min_version: 2.40
|
|
required: false
|
|
type: integer
|
|
quota_share_groups:
|
|
description: |
|
|
The number of share groups allowed for each tenant or user.
|
|
in: body
|
|
min_version: 2.40
|
|
required: true
|
|
type: integer
|
|
quota_share_groups_detail:
|
|
description: |
|
|
The limit, in_use, reserved number of share groups
|
|
for each tenant or user.
|
|
in: body
|
|
min_version: 2.40
|
|
required: true
|
|
type: object
|
|
quota_share_groups_request:
|
|
description: |
|
|
The number of share groups allowed for each tenant or user.
|
|
in: body
|
|
min_version: 2.40
|
|
required: false
|
|
type: integer
|
|
quota_share_networks:
|
|
description: |
|
|
The number of share networks allowed for user and project,
|
|
but not share type.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
quota_share_networks_default:
|
|
description: |
|
|
The number of share networks allowed for each tenant.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
quota_share_networks_detail:
|
|
description: |
|
|
The limit, in_use, reserved number of share networks
|
|
allowed for user and project, but not share type.
|
|
in: body
|
|
min_version: 2.25
|
|
required: false
|
|
type: object
|
|
quota_share_networks_request:
|
|
description: |
|
|
The number of share networks for the tenant.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
quota_shares:
|
|
description: |
|
|
The number of shares allowed for each tenant.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
quota_shares_detail:
|
|
description: |
|
|
The limit, in_use, reserved number of shares allowed
|
|
for each tenant.
|
|
in: body
|
|
min_version: 2.25
|
|
required: true
|
|
type: object
|
|
quota_shares_request:
|
|
description: |
|
|
The number of shares for the tenant.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
quota_snapshot_gigabytes:
|
|
description: |
|
|
The number of gigabytes for the snapshots allowed
|
|
for each tenant.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
quota_snapshot_gigabytes_detail:
|
|
description: |
|
|
The limit, in_use, reserved number of gigabytes for the
|
|
snapshots allowed for each tenant.
|
|
in: body
|
|
min_version: 2.25
|
|
required: true
|
|
type: object
|
|
quota_snapshot_gigabytes_request:
|
|
description: |
|
|
The number of gigabytes for the snapshots for the
|
|
tenant.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
quota_snapshots:
|
|
description: |
|
|
The number of snapshots allowed for each tenant.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
quota_snapshots_detail:
|
|
description: |
|
|
The limit, in_use, reserved number of snapshots allowed
|
|
for each tenant.
|
|
in: body
|
|
min_version: 2.25
|
|
required: true
|
|
type: object
|
|
quota_snapshots_request:
|
|
description: |
|
|
The number of snapshots for the tenant.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
quota_tenant_id:
|
|
description: |
|
|
The UUID of the tenant for which you manage
|
|
quotas.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
regex:
|
|
description: |
|
|
An API regular expression. For example,
|
|
``^/shares`` for the ``/shares`` API URI or ``.*`` for any URI.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
remaining:
|
|
description: |
|
|
The remaining number of allowed requests.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
replica_state:
|
|
description: |
|
|
(Since API v2.11) The share replica state. Has
|
|
set value only when replication is used. List of possible values:
|
|
``active``, ``in_sync``, ``out_of_sync``, and ``error``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
replication_type:
|
|
description: |
|
|
The share replication type.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
min_version: 2.11
|
|
request_id_body:
|
|
description: |
|
|
The UUID of the request during which the message was created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
required_extra_specs:
|
|
description: |
|
|
The required extra specifications for the share
|
|
type.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
reserved_percentage:
|
|
description: |
|
|
The percentage of the total capacity that is
|
|
reserved for the internal use by the back end.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
reset_status:
|
|
description: |
|
|
The ``reset_status`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
resource_id_body:
|
|
description: |
|
|
The UUID of the resource for which the message was created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
resource_type_body:
|
|
description: |
|
|
The type of the resource for which the message was created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
revert_to_snapshot_support:
|
|
description: |
|
|
Boolean extra spec used for filtering of back ends by their
|
|
capability to revert shares to snapshots.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
min_version: 2.27
|
|
security_service_created_at:
|
|
description: |
|
|
The date and time stamp when the security service 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
|
|
security_service_description:
|
|
description: |
|
|
Description of the security service in plain text.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_description_request:
|
|
description: |
|
|
The security service description. If you specify
|
|
this value, the description is updated.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
security_service_dns_ip:
|
|
description: |
|
|
The DNS IP address that is used inside the tenant
|
|
network.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_dns_ip_request:
|
|
description: |
|
|
The DNS IP address that is used inside the tenant
|
|
network.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
security_service_domain:
|
|
description: |
|
|
The security service domain.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_domain_request:
|
|
description: |
|
|
The security service domain.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
security_service_id:
|
|
description: |
|
|
The security service ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_name:
|
|
description: |
|
|
The security service name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_ou:
|
|
description: |
|
|
The security service ou.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
min_version: 2.44
|
|
security_service_ou_request:
|
|
description: |
|
|
The security service ou. An organizational unit
|
|
can be added to specify where the share ends up.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
min_version: 2.44
|
|
security_service_password:
|
|
description: |
|
|
The user password, if you specify a ``user``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_password_request:
|
|
description: |
|
|
The user password, if you specify a ``user``.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
security_service_project_id:
|
|
description: |
|
|
The UUID of the project where the security
|
|
service was created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_server:
|
|
description: |
|
|
The security service host name or IP address.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_server_request:
|
|
description: |
|
|
The security service host name or IP address.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
security_service_status:
|
|
description: |
|
|
The security service status.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_type:
|
|
description: |
|
|
The security service type. A valid value is
|
|
``ldap``, ``kerberos``, or ``active_directory``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_type_request:
|
|
description: |
|
|
The security service type. A valid value is
|
|
``ldap``, ``kerberos``, or ``active_directory``.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
security_service_updated_at:
|
|
description: |
|
|
The date and time stamp when the security service was updated.
|
|
|
|
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
|
|
security_service_user:
|
|
description: |
|
|
The security service user or group name that is
|
|
used by the tenant.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
security_service_user_request:
|
|
description: |
|
|
The security service user or group name that is
|
|
used by the tenant.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
security_servie_server_request:
|
|
description: |
|
|
The security service host name or IP address.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
segmentation_id:
|
|
description: |
|
|
The segmentation ID.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
segmentation_id_1:
|
|
description: |
|
|
The segmentation ID. This parameter is
|
|
automatically set to a value determined by the network provider.
|
|
For VLAN, this value is an integer from 1 to 4094. For VXLAN,
|
|
this value is an integer from 1 to 16777215. For GRE, this value
|
|
is an integer from 1 to 4294967295.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
server_pools_mapping:
|
|
description: |
|
|
The mapping between servers and pools.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
service_binary_response:
|
|
description: |
|
|
The service binary name. Default is the base name
|
|
of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_disable_binary_request:
|
|
description: |
|
|
The name of the service binary that you want to
|
|
disable. Typically, this name is the base name of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_disable_binary_response:
|
|
description: |
|
|
The name of the disabled service binary.
|
|
Typically, this name is the base name of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_disable_host_request:
|
|
description: |
|
|
The host name of the service that you want to
|
|
disable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_disable_host_response:
|
|
description: |
|
|
The host name of the disabled service.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_disabled_response:
|
|
description: |
|
|
Indicates whether the service is disabled.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
service_enable_binary_request:
|
|
description: |
|
|
The name of the service binary that you want to
|
|
enable. Typically, this name is the base name of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_enable_binary_response:
|
|
description: |
|
|
The name of the enabled service binary.
|
|
Typically, this name is the base name of the executable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_enable_host_request:
|
|
description: |
|
|
The host name of the service that you want to
|
|
enable.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_enable_host_response:
|
|
description: |
|
|
The host name of the enabled service.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_host:
|
|
description: |
|
|
The manage-share service host in this format:
|
|
``host@backend#POOL``. - ``host``. The host name for the back
|
|
end. - ``backend``. The name of the back end. - ``POOL``. The
|
|
pool name for the back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_host_response:
|
|
description: |
|
|
The service host name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_id_response:
|
|
description: |
|
|
The service ID.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
service_state_response:
|
|
description: |
|
|
The current state of the service. A valid value
|
|
is ``up`` or ``down``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_status_response:
|
|
description: |
|
|
The service status, which is ``enabled`` or
|
|
``disabled``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
service_updated_at:
|
|
description: |
|
|
The date and time stamp when the service was updated.
|
|
|
|
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
|
|
service_zone_response:
|
|
description: |
|
|
The service availability zone.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
services:
|
|
description: |
|
|
Top element in the response body.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share:
|
|
description: |
|
|
A ``share`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
share_backend_name:
|
|
description: |
|
|
The name of the share back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_force_delete:
|
|
description: |
|
|
To force-delete a share or share group, set this value to
|
|
``null``. The force-delete action, unlike the delete action,
|
|
ignores the share or share group status.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_group_created_at:
|
|
description: |
|
|
The date and time stamp when the share group 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, ``2016-12-31T13:14:15-05:00``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_group_description:
|
|
description: |
|
|
The share group description.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_group_description_response:
|
|
description: |
|
|
The share group description.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_group_host:
|
|
description: |
|
|
The share group host name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_group_id:
|
|
description: |
|
|
The UUID of the share group.
|
|
in: body
|
|
required: True
|
|
type: string
|
|
min_version: 2.31
|
|
share_group_id_request:
|
|
description: |
|
|
The UUID of the share group.
|
|
in: body
|
|
required: False
|
|
type: string
|
|
min_version: 2.31
|
|
share_group_links:
|
|
description: |
|
|
The share group links.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_group_name:
|
|
description: |
|
|
The share group name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_group_name_response:
|
|
description: |
|
|
The share group name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_group_status:
|
|
description: |
|
|
The share group status, which is ``available``,
|
|
``error``, ``creating``, or ``deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_group_type_id:
|
|
description: |
|
|
The share group type ID to create a share group.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_group_type_id_required:
|
|
description: |
|
|
The share group type ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_group_type_is_public:
|
|
description: |
|
|
The level of visibility for the share group type. Set to
|
|
``true`` to make share group type public. Set to ``false`` to
|
|
make it private. Default value is ``false``.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
share_group_type_is_public_request:
|
|
description: |
|
|
The level of visibility for the share group type. Set to
|
|
``true`` to make share group type public. Set to ``false`` to
|
|
make it private. Default value is ``false``.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
share_group_type_name:
|
|
description: |
|
|
The share group type name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_id_2:
|
|
description: |
|
|
The UUID of the share from which the share
|
|
instance was created.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_instance_id_1:
|
|
description: |
|
|
The UUID of the share instance.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_network_created_at:
|
|
description: |
|
|
The date and time stamp when the share network 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
|
|
share_network_description:
|
|
description: |
|
|
The share network description.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_network_description_request:
|
|
description: |
|
|
The share network description.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_network_gateway:
|
|
description: |
|
|
The gateway of a share network.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
min_version: 2.18
|
|
share_network_id:
|
|
description: |
|
|
The share network ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_network_id_1:
|
|
description: |
|
|
The ID of a share network. Note that when using
|
|
a share type with the ``driver_handles_share_servers`` extra spec
|
|
as ``False``, you should not provide a ``share_network_id``.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_network_id_2:
|
|
description: |
|
|
The UUID of a share network where the share
|
|
server exists or will be created. If ``share_network_id`` is
|
|
``None`` and you provide a ``snapshot_id``, the
|
|
``share_network_id`` value from the snapshot is used.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_network_id_3:
|
|
description: |
|
|
The ID of a share network.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_network_id_4:
|
|
description: |
|
|
The share network ID.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_network_id_6:
|
|
description: |
|
|
The UUID of a share network that is associated
|
|
with the share server.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_network_mtu:
|
|
description:
|
|
The MTU value of a share network.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
min_version: 2.20
|
|
share_network_name:
|
|
description: |
|
|
The name of a share network.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_network_name_request:
|
|
description: |
|
|
The name of a share network.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_network_security_service_id:
|
|
description: |
|
|
The UUID of the security service to remove from
|
|
the share network. For details, see the security service section.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_network_updated_at:
|
|
description: |
|
|
The date and time stamp when the share network was updated.
|
|
|
|
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
|
|
share_new_size:
|
|
description: |
|
|
New size of the share, in GBs.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
share_proto:
|
|
description: |
|
|
The Shared File Systems protocol. A valid value
|
|
is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``, ``CephFS``,
|
|
``MAPRFS``, ``CephFS`` supported is starting with API v2.13.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_protocol:
|
|
description: |
|
|
The file system protocol of the member, which is
|
|
``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``, ``CEPHFS`` or
|
|
``MAPRFS``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_replica_az:
|
|
description: |
|
|
The availability zone.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_replica_cast_rules_to_readonly:
|
|
description: |
|
|
Since the share instance has its ``cast_rules_to_readonly`` attribute
|
|
set to True, existing rules will be cast to read/only.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_replica_created_at:
|
|
description: |
|
|
The date and time stamp when the share replica 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
|
|
share_replica_force_delete:
|
|
description: |
|
|
To force-delete a share replica, set this value to
|
|
``null``. The force-delete action, unlike the delete action,
|
|
ignores the share replica status.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_replica_host:
|
|
description: |
|
|
The host name of the share replica.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_replica_id:
|
|
description: |
|
|
The UUID of the share replica.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_replica_replica_state:
|
|
description: |
|
|
The replica state of a share replica. List of possible values:
|
|
``active``, ``in_sync``, ``out_of_sync``, and ``error``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_replica_reset_replica_state:
|
|
description: |
|
|
The ``reset_replica_state`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
share_replica_share_id:
|
|
description: |
|
|
The UUID of the share from which to create a
|
|
share replica.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_replica_share_network_id:
|
|
description: |
|
|
The UUID of the share network.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_replica_status:
|
|
description: |
|
|
The status of a share replica. List of possible values:
|
|
``available``, ``error``, ``creating``, ``deleting``,
|
|
or ``error_deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_replica_updated_at:
|
|
description: |
|
|
The date and time stamp when the share replica was updated.
|
|
|
|
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
|
|
share_server_id:
|
|
description: |
|
|
The UUID of the share server.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_size_1:
|
|
description: |
|
|
The size of a source share, in GBs.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
share_type:
|
|
description: |
|
|
The share type name. If you omit this parameter,
|
|
the default share type is used. To view the default share type set
|
|
by the administrator, issue a list default share types request.
|
|
You cannot specify both the ``share_type`` and ``volume_type``
|
|
parameters.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_type_1:
|
|
description: |
|
|
(Since API v2.6) The UUID of the share type. In
|
|
minor versions, this parameter is a share type name, as a string.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_type_2:
|
|
description: |
|
|
The share type name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
share_type_access:is_public:
|
|
description: |
|
|
Indicates whether a share type is publicly
|
|
accessible. Default is ``true``, or publicly accessible.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
min_version: 2.7
|
|
share_type_description:
|
|
description: |
|
|
The description of the share type.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
min_version: 2.41
|
|
share_type_description_request:
|
|
description: |
|
|
The description of the share type.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
min_version: 2.41
|
|
share_type_id_body:
|
|
description: |
|
|
The UUID of the share type.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_type_name:
|
|
description: |
|
|
(Since API v2.6) The share type name. Minor
|
|
versions support only the ``share_type`` parameter where the share
|
|
type name is expected.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
share_types:
|
|
description: |
|
|
A list of one or more share type IDs.
|
|
in: body
|
|
required: false
|
|
type: array
|
|
share_types_1:
|
|
description: |
|
|
A list of share type IDs.
|
|
in: body
|
|
required: true
|
|
type: array
|
|
share_unmanage:
|
|
description: |
|
|
To unmanage a share, set this value to ``null``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
shrink:
|
|
description: |
|
|
The ``shrink`` object.
|
|
in: body
|
|
required: true
|
|
type: object
|
|
size:
|
|
description: |
|
|
The share size, in GBs. The requested share size
|
|
cannot be greater than the allowed GB quota. To view the allowed
|
|
quota, issue a get limits request.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
size_1:
|
|
description: |
|
|
The member size, in GBs.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
size_2:
|
|
description: |
|
|
The share size, in GBs.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
snapshot_created_at:
|
|
description: |
|
|
The date and time stamp when the snapshot or snapshot instance 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
|
|
snapshot_description:
|
|
description: |
|
|
The snapshot description.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_description_request:
|
|
description: |
|
|
The snapshot description.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
snapshot_display_description:
|
|
description: |
|
|
The snapshot description. The shared file
|
|
systems API supports the use of both ``name`` and ``display_name``
|
|
attributes, which are inherited attributes from the block storage
|
|
API.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
snapshot_display_name:
|
|
description: |
|
|
The snapshot name. The Shared File Systems API
|
|
supports the use of both ``name`` and ``display_name`` attributes,
|
|
which are inherited attributes from the Block Storage API.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
snapshot_force_delete:
|
|
description: |
|
|
To force-delete a snapshot, include this param and set its value to
|
|
``null``. The force-delete action, unlike the delete action,
|
|
ignores the snapshot status.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_id:
|
|
description: |
|
|
The UUID of the snapshot.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_id_request:
|
|
description: |
|
|
The UUID of the share's base snapshot.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
snapshot_id_share_response:
|
|
description: |
|
|
The UUID of the snapshot that was used to create
|
|
the share.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_instance_id:
|
|
description: |
|
|
The UUID of the share snapshot instance.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
snapshot_instance_id_response:
|
|
description: |
|
|
The UUID of the share snapshot instance.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_instance_status:
|
|
description: |
|
|
The snapshot instance status. A valid value is
|
|
``available``, ``error``, ``creating``, ``deleting``, and
|
|
``error_deleting``, ``restoring``, ``unmanage_starting``,
|
|
``unmanage_error``, ``manage_starting``, ``manage_error``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_instance_updated_at:
|
|
description: |
|
|
The date and time stamp when the snapshot instance was
|
|
updated.
|
|
|
|
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, ``2016-12-31T13:14:15-05:00``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_manage_share_id:
|
|
description: |
|
|
The UUID of the share that has snapshot which
|
|
should be managed.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_manage_status:
|
|
description: |
|
|
The snapshot status, which could be
|
|
``manage_starting``, ``manage_error``, ``unmanage_starting``, or
|
|
``unmanage_error``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_name:
|
|
description: |
|
|
The snapshot name.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_name_request:
|
|
description: |
|
|
The snapshot name.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
snapshot_provider_location:
|
|
description: |
|
|
Provider location of the snapshot on the backend.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_provider_location_request:
|
|
description: |
|
|
Provider location of the snapshot on the backend.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_share_id:
|
|
description: |
|
|
The UUID of the source share that was used to
|
|
create the snapshot.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_share_id_request:
|
|
description: |
|
|
The UUID of the share from which to create a
|
|
snapshot.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_share_protocol:
|
|
description: |
|
|
The file system protocol of a share snapshot. A
|
|
valid value is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``,
|
|
``CephFS`` or ``MAPRFS``. ``CephFS`` is supported starting
|
|
with API v2.13.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_share_protocol_request:
|
|
description: |
|
|
The file system protocol of a share snapshot. A
|
|
valid value is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``,
|
|
``CephFS`` or ``MAPRFS``, ``CephFS`` is supported starting
|
|
with API v2.13.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_share_size:
|
|
description: |
|
|
The share snapshot size, in GBs.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
snapshot_size:
|
|
description: |
|
|
The snapshot size, in GBs.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
snapshot_status:
|
|
description: |
|
|
The snapshot status, which can be ``available``,
|
|
``error``, ``creating``, ``deleting``, ``manage_starting``,
|
|
``manage_error``, ``unmanage_starting``, ``unmanage_error`` or
|
|
``error_deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
snapshot_status_request:
|
|
description: |
|
|
The snapshot status, which can be ``available``,
|
|
``error``, ``creating``, ``deleting``, ``manage_starting``,
|
|
``manage_error``, ``unmanage_starting``, ``unmanage_error`` or
|
|
``error_deleting``.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
snapshot_support:
|
|
description: |
|
|
(Since API v2.2) An extra specification that
|
|
filters back ends by whether they do or do not support share
|
|
snapshots.
|
|
in: body
|
|
required: true
|
|
type: boolean
|
|
snapshot_support_1:
|
|
description: |
|
|
An extra specification that filters back ends by
|
|
whether they do or do not support share snapshots.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
snapshot_support_3:
|
|
description: |
|
|
An extra specification that filters back ends by
|
|
whether they do or do not support share snapshots. Set to
|
|
``true`` to show back ends that support share snapshots. Set to
|
|
``false`` to show back ends that do not support share snapshots.
|
|
Default is ``true``.
|
|
in: body
|
|
required: false
|
|
type: boolean
|
|
snapshot_unmanage:
|
|
description: |
|
|
To unmanage a share snapshot, include this parameter and set its value to
|
|
``null``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
source_share_group_snapshot_id:
|
|
description: |
|
|
The source share group snapshot ID to create the
|
|
share group.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
source_share_group_snapshot_id_response:
|
|
description: |
|
|
The source share group snapshot ID to create the
|
|
share group.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
state:
|
|
description: |
|
|
Prior to versions 2.28, the state of all access rules of a given share
|
|
is the same at all times. This could be ``new``, ``active`` or
|
|
``error``. Since 2.28, the state of each access rule of a share is
|
|
independent of the others and can be ``queued_to_apply``,
|
|
``applying``, ``active``, ``error``, ``queued_to_deny`` or ``denying``.
|
|
A new rule starts out in ``queued_to_apply`` state and is successfully
|
|
applied if it transitions to ``active`` state.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
state_1:
|
|
description: |
|
|
The current state of the service. A valid value
|
|
is ``up`` or ``down``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status:
|
|
description: |
|
|
The consistency group snapshot status, which is
|
|
``available``, ``creating``, ``error``, ``deleting``, or
|
|
``error_deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status_1:
|
|
description: |
|
|
The consistency group status. A valid value is
|
|
``creating``, ``available``, ``error``, ``deleting``, or
|
|
``error_deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status_10:
|
|
description: |
|
|
The consistency group status. A valid value is
|
|
``creating``, ``error``, ``available``, ``deleting``, or
|
|
``error_deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status_15:
|
|
description: |
|
|
The share server status, which is ``active``,
|
|
``error``, ``creating``, or ``deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status_16:
|
|
description: |
|
|
The share status, which is ``creating``,
|
|
``error``, ``available``, ``deleting``, ``error_deleting``,
|
|
``manage_starting``, ``manage_error``, ``unmanage_starting``,
|
|
``unmanage_error``, ``unmanaged``, ``extend``,
|
|
``extending_error``, ``shrinking``, ``shrinking_error``, or
|
|
``shrinking_possible_data_loss_error``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status_3:
|
|
description: |
|
|
The share status. A valid value is: -
|
|
``creating``. The share is being created. - ``deleting``. The
|
|
share is being deleted. - ``error``. An error occurred during
|
|
share creation. - ``error_deleting``. An error occurred during
|
|
share deletion. - ``available``. The share is ready to use. -
|
|
``manage_starting``. Share manage started. - ``manage_error``.
|
|
Share manage failed. - ``unmanage_starting``. Share unmanage
|
|
started. - ``unmanage_error``. Share cannot be unmanaged. -
|
|
``unmanaged``. Share was unmanaged. - ``extending``. The extend,
|
|
or increase, share size request was issued successfully. -
|
|
``extending_error``. Extend share failed. - ``shrinking``. Share
|
|
is being shrunk. - ``shrinking_error``. Failed to update quota on
|
|
share shrinking. - ``shrinking_possible_data_loss_error``. Shrink
|
|
share failed due to possible data loss.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status_4:
|
|
description: |
|
|
The service status, which is ``enabled`` or
|
|
``disabled``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status_5:
|
|
description: |
|
|
The share instance status. A valid value is
|
|
``available``, ``error``, ``creating``, ``deleting``, and
|
|
``error_deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status_7:
|
|
description: |
|
|
The share server status, which is ``active``,
|
|
``error``, ``creating``, or ``deleting``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
status_8:
|
|
description: |
|
|
The share status, which is ``available``,
|
|
``manage_starting``, or ``manage_error``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
storage_protocol:
|
|
description: |
|
|
The storage protocol for the back end. For
|
|
example, ``NFS_CIFS``, ``glusterfs``, ``HDFS``, and so on.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
task_state:
|
|
description: |
|
|
(Since API v2.5) For the share migration, the
|
|
migration task state. A valid value is ``null``,
|
|
``migration_starting``, ``migration_error``,
|
|
``migration_success``, ``migration_completing``, or ``migrating``.
|
|
The ``task_state`` is ``null`` unless the share is migrated from
|
|
one back-end to another. For details, see ``os-migrate_share``
|
|
extension request.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
timestamp:
|
|
description: |
|
|
The date and time stamp when the API request was issued.
|
|
|
|
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
|
|
total_capacity_gb:
|
|
description: |
|
|
The total capacity for the back end, in GBs. A
|
|
valid value is a string, such as ``unknown``, or an integer.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
totalShareGigabytesUsed:
|
|
description: |
|
|
The total number of gigabytes used in a project
|
|
by shares.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
totalShareNetworksUsed:
|
|
description: |
|
|
The total number of created share-networks in a
|
|
project.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
totalShareSnapshotsUsed:
|
|
description: |
|
|
The total number of created share snapshots in a
|
|
project.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
totalSharesUsed:
|
|
description: |
|
|
The total number of created shares in a project.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
totalSnapshotGigabytesUsed:
|
|
description: |
|
|
The total number of gigabytes used in a project
|
|
by snapshots.
|
|
in: body
|
|
required: true
|
|
type: integer
|
|
unit:
|
|
description: |
|
|
The time interval during which a number of API
|
|
requests are allowed. A valid value is ``SECOND``, ``MINUTE``,
|
|
``HOUR``, or ``DAY``. Used in conjunction with the ``value``
|
|
parameter, expressed as ``value`` per ``unit``. For example, 120
|
|
requests are allowed per minute.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
unmanage:
|
|
description: |
|
|
To unmanage a share snapshot, set this value to
|
|
``null``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
updated:
|
|
description: |
|
|
The date and time stamp when the extension was last updated.
|
|
|
|
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
|
|
updated_at_2:
|
|
description: |
|
|
The date and time stamp when the share instance export location was
|
|
updated.
|
|
|
|
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, ``2016-12-31T13:14:15-05:00``.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
updated_at_5:
|
|
description: |
|
|
The date and time stamp when the service was updated.
|
|
|
|
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
|
|
updated_at_6:
|
|
description: |
|
|
The date and time stamp when the share server was updated.
|
|
|
|
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
|
|
uri:
|
|
description: |
|
|
A human-readable URI of a rate limit.
|
|
format: uri
|
|
in: body
|
|
required: false
|
|
type: string
|
|
user_id:
|
|
description: |
|
|
ID of the user that is part of a given tenant.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
value:
|
|
description: |
|
|
The number of API requests that are allowed
|
|
during a time interval. Used in conjunction with the ``unit``
|
|
parameter, expressed as ``value`` per ``unit``. For example, 120
|
|
requests are allowed per minute.
|
|
in: body
|
|
required: false
|
|
type: integer
|
|
vendor_name:
|
|
description: |
|
|
The name of the vendor for the back end.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
verb:
|
|
description: |
|
|
The HTTP method for the API request. For example,
|
|
``GET``, ``POST``, ``DELETE``, and so on.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
version:
|
|
description: |
|
|
The version.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
version_id:
|
|
type: string
|
|
in: body
|
|
required: true
|
|
description: >
|
|
A common name for the version in question. Informative only, it
|
|
has no real semantic meaning.
|
|
version_max:
|
|
type: string
|
|
in: body
|
|
required: true
|
|
description: >
|
|
If this version of the API supports microversions, the maximum
|
|
microversion that is supported. This will be the empty string if
|
|
microversions are not supported.
|
|
version_min:
|
|
type: string
|
|
in: body
|
|
required: true
|
|
description: >
|
|
If this version of the API supports microversions, the minimum
|
|
microversion that is supported. This will be the empty string if
|
|
microversions are not supported.
|
|
version_status:
|
|
type: string
|
|
in: body
|
|
required: true
|
|
description: |
|
|
The status of this API version. This can be one of:
|
|
|
|
- ``CURRENT``: this is the preferred version of the API to use
|
|
- ``SUPPORTED``: this is an older, but still supported version of the API
|
|
- ``DEPRECATED``: a deprecated version of the API that is slated for removal
|
|
versions:
|
|
type: array
|
|
in: body
|
|
required: true
|
|
description: >
|
|
A list of version objects that describe the API versions available.
|
|
volume_type:
|
|
description: |
|
|
The volume type. The use of the ``volume_type``
|
|
object is deprecated but supported. It is recommended that you use
|
|
the ``share_type`` object when you create a share type. When you
|
|
issue a create a share type request, you can submit a request body
|
|
with either a ``share_type`` or ``volume_type`` object. No matter
|
|
which object type you include in the request, the API creates both
|
|
a ``volume_type`` object and a ``share_type`` object. Both objects
|
|
have the same ID. When you issue a list share types request, the
|
|
response shows both ``share_types`` and ``volume_types`` objects.
|
|
in: body
|
|
required: false
|
|
type: string
|
|
zone:
|
|
description: |
|
|
The availability zone.
|
|
in: body
|
|
required: true
|
|
type: string
|