openapi: 3.1.0
info:
description: |-
This is a reference for version 2 of the OpenStack Shared File Systems API
which is provided by the Manila project. Manila provides a RESTful HTTP service
through which it offers on-demand, scalable, self-service access to
shared file system storage resources.
title: OpenStack Shared-File-System API
version: '2.91'
paths:
/:
get:
deprecated: true
description: |-
This fetches all the information about all known major API versions in
the deployment. Links to more specific information will be provided
for each API version, as well as information about supported min and
max microversions.
operationId: :get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RootListResponse'
description: Ok
summary: List All Major Versions
tags:
- version
x-openstack:
max-ver: '1.0'
min-ver: '1.0'
/availability-zones:
get:
operationId: availability-zones:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Availability_ZonesListResponse'
description: Ok
tags:
- availability-zones
x-openstack:
min-ver: '2.7'
/extensions:
get:
operationId: extensions:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionsListResponse'
description: Ok
tags:
- extensions
post:
operationId: extensions:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionsCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionsCreateResponse'
description: Ok
tags:
- extensions
/extensions/{id}:
delete:
operationId: extensions/id:delete
responses:
'204':
description: Ok
tags:
- extensions
get:
operationId: extensions/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionShowResponse'
description: Ok
tags:
- extensions
parameters:
- $ref: '#/components/parameters/extensions_id'
/limits:
get:
description: |-
Return all global and rate limit information.
operationId: limits:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LimitsListResponse'
description: Ok
tags:
- limits
/messages:
get:
description: |-
Returns a list of messages, transformed through view builder.
operationId: messages:get
parameters:
- $ref: '#/components/parameters/messages_action_id'
- $ref: '#/components/parameters/messages_created_before'
- $ref: '#/components/parameters/messages_created_since'
- $ref: '#/components/parameters/messages_detail_id'
- $ref: '#/components/parameters/messages_limit'
- $ref: '#/components/parameters/messages_message_level'
- $ref: '#/components/parameters/messages_offset'
- $ref: '#/components/parameters/messages_request_id'
- $ref: '#/components/parameters/messages_resource_id'
- $ref: '#/components/parameters/messages_resource_type'
- $ref: '#/components/parameters/messages_sort_dir'
- $ref: '#/components/parameters/messages_sort_key'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MessagesListResponse'
description: Ok
tags:
- messages
x-openstack:
min-ver: '2.37'
/messages/{id}:
delete:
description: |-
Delete a message.
operationId: messages/id:delete
responses:
'204':
description: Ok
tags:
- messages
x-openstack:
min-ver: '2.37'
get:
description: |-
Return the given message.
operationId: messages/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MessageShowResponse'
description: Ok
tags:
- messages
x-openstack:
min-ver: '2.37'
parameters:
- $ref: '#/components/parameters/messages_id'
/os-availability-zone:
get:
deprecated: true
operationId: os-availability-zone:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Availability_ZoneListResponse'
description: Ok
tags:
- os-availability-zone
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
/os-quota-class-sets/{id}:
get:
deprecated: true
operationId: os-quota-class-sets/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_Class_SetShowResponse'
description: Ok
tags:
- os-quota-class-sets
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
parameters:
- $ref: '#/components/parameters/os_quota_class_sets_id'
put:
deprecated: true
operationId: os-quota-class-sets/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_Class_SetUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse'
description: Ok
tags:
- os-quota-class-sets
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
/os-quota-sets/{id}:
delete:
deprecated: true
operationId: os-quota-sets/id:delete
responses:
'204':
description: Ok
tags:
- os-quota-sets
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
get:
deprecated: true
operationId: os-quota-sets/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_SetShowResponse'
description: Ok
tags:
- os-quota-sets
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
parameters:
- $ref: '#/components/parameters/os_quota_sets_id'
put:
deprecated: true
operationId: os-quota-sets/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_SetUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_SetUpdateResponse'
description: Ok
tags:
- os-quota-sets
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
/os-quota-sets/{id}/defaults:
get:
deprecated: true
operationId: os-quota-sets/id/defaults:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_SetsDefaultsResponse'
description: Ok
tags:
- os-quota-sets
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
parameters:
- $ref: '#/components/parameters/os_quota_sets_defaults_id'
/os-services:
get:
deprecated: true
operationId: os-services:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_ServicesListResponse'
description: Ok
tags:
- os-services
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
/os-services/{id}:
parameters:
- $ref: '#/components/parameters/os_services_id'
put:
deprecated: true
operationId: os-services/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_ServiceUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_ServiceUpdateResponse'
description: Ok
tags:
- os-services
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
/os-share-manage:
post:
deprecated: true
description: |-
Legacy method for 'manage share' operation.
Should be removed when minimum API version becomes equal to or
greater than v2.7
operationId: os-share-manage:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Share_ManageCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Share_ManageCreateResponse'
description: Ok
tags:
- os-share-manage
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
/os-share-unmanage/{id}/unmanage:
parameters:
- $ref: '#/components/parameters/os_share_unmanage_unmanage_id'
post:
deprecated: true
operationId: os-share-unmanage/id/unmanage:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Share_UnmanageUnmanageUnmanageRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Share_UnmanageUnmanageResponse'
description: Ok
tags:
- os-share-unmanage
x-openstack:
max-ver: '2.6'
min-ver: '1.0'
/quota-class-sets/{id}:
get:
operationId: quota-class-sets/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Quota_Class_SetShowResponse'
description: Ok
tags:
- quota-class-sets
x-openstack:
min-ver: '2.7'
parameters:
- $ref: '#/components/parameters/quota_class_sets_id'
put:
operationId: quota-class-sets/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Quota_Class_SetUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Quota_Class_SetUpdateResponse'
description: Ok
tags:
- quota-class-sets
x-openstack:
min-ver: '2.7'
/quota-sets/{id}:
delete:
operationId: quota-sets/id:delete
responses:
'204':
description: Ok
tags:
- quota-sets
x-openstack:
min-ver: '2.7'
get:
operationId: quota-sets/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Quota_SetShowResponse'
description: Ok
tags:
- quota-sets
x-openstack:
min-ver: '2.7'
parameters:
- $ref: '#/components/parameters/quota_sets_id'
put:
operationId: quota-sets/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Quota_SetUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Quota_SetUpdateResponse'
description: Ok
tags:
- quota-sets
x-openstack:
min-ver: '2.7'
/quota-sets/{id}/defaults:
get:
operationId: quota-sets/id/defaults:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Quota_SetsDefaultsResponse'
description: Ok
tags:
- quota-sets
x-openstack:
min-ver: '2.7'
parameters:
- $ref: '#/components/parameters/quota_sets_defaults_id'
/quota-sets/{id}/detail:
get:
operationId: quota-sets/id/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Quota_SetsDetailResponse'
description: Ok
tags:
- quota-sets
x-openstack:
min-ver: '2.25'
parameters:
- $ref: '#/components/parameters/quota_sets_detail_id'
/resource-locks:
get:
description: |-
Returns a list of locks, transformed through view builder.
operationId: resource-locks:get
parameters:
- $ref: '#/components/parameters/resource_locks_all_projects'
- $ref: '#/components/parameters/resource_locks_created_before'
- $ref: '#/components/parameters/resource_locks_created_since'
- $ref: '#/components/parameters/resource_locks_limit'
- $ref: '#/components/parameters/resource_locks_lock_context'
- $ref: '#/components/parameters/resource_locks_lock_reason'
- $ref: '#/components/parameters/resource_locks_offset'
- $ref: '#/components/parameters/resource_locks_project_id'
- $ref: '#/components/parameters/resource_locks_resource_action'
- $ref: '#/components/parameters/resource_locks_resource_id'
- $ref: '#/components/parameters/resource_locks_resource_type'
- $ref: '#/components/parameters/resource_locks_sort_dir'
- $ref: '#/components/parameters/resource_locks_sort_key'
- $ref: '#/components/parameters/resource_locks_user_id'
- $ref: '#/components/parameters/resource_locks_with_count'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Resource_LocksListResponse'
description: Ok
tags:
- resource-locks
x-openstack:
min-ver: '2.81'
post:
description: |-
Create a resource lock.
operationId: resource-locks:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Resource_LocksCreate_281'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Resource_LocksCreateResponse'
description: Ok
tags:
- resource-locks
x-openstack:
min-ver: '2.81'
/resource-locks/{id}:
delete:
description: |-
Delete an existing resource lock.
operationId: resource-locks/id:delete
responses:
'204':
description: Ok
tags:
- resource-locks
x-openstack:
min-ver: '2.81'
get:
description: |-
Return an existing resource lock by ID.
operationId: resource-locks/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Resource_LockShowResponse'
description: Ok
tags:
- resource-locks
x-openstack:
min-ver: '2.81'
parameters:
- $ref: '#/components/parameters/resource_locks_id'
put:
description: |-
Update an existing resource lock.
operationId: resource-locks/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Resource_LockUpdate_281'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Resource_LockUpdateResponse'
description: Ok
tags:
- resource-locks
x-openstack:
min-ver: '2.81'
/scheduler-stats/pools:
get:
deprecated: true
description: |-
Returns a list of storage pools known to the scheduler.
operationId: scheduler-stats/pools:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Scheduler_StatsPoolsPools_ListResponse'
description: Ok
tags:
- scheduler-stats
x-openstack:
max-ver: '2.22'
min-ver: '1.0'
/scheduler-stats/pools/detail:
get:
deprecated: true
description: |-
Returns a detailed list of storage pools known to the scheduler.
operationId: scheduler-stats/pools/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Scheduler_StatsPoolsDetailPools_DetailResponse'
description: Ok
tags:
- scheduler-stats
x-openstack:
max-ver: '2.22'
min-ver: '1.0'
/security-services:
get:
description: |-
Returns a summary list of security services.
operationId: security-services:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Security_ServicesListResponse'
description: Ok
tags:
- security-services
post:
description: |-
Creates a new security service.
operationId: security-services:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Security_ServicesCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Security_ServicesCreateResponse'
description: Ok
tags:
- security-services
/security-services/detail:
get:
description: |-
Returns a detailed list of security services.
operationId: security-services/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Security_ServicesDetailResponse'
description: Ok
tags:
- security-services
/security-services/{id}:
delete:
description: |-
Delete a security service.
operationId: security-services/id:delete
responses:
'204':
description: Ok
tags:
- security-services
get:
description: |-
Return data about the given security service.
operationId: security-services/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Security_ServiceShowResponse'
description: Ok
tags:
- security-services
parameters:
- $ref: '#/components/parameters/security_services_id'
put:
description: |-
Update a security service.
operationId: security-services/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Security_ServiceUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Security_ServiceUpdateResponse'
description: Ok
tags:
- security-services
/services:
get:
deprecated: true
operationId: services:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServicesListResponse'
description: Ok
tags:
- services
x-openstack:
max-ver: '2.85'
min-ver: '2.7'
/services/ensure-shares:
post:
description: |-
Starts ensure shares for a given manila-share binary.
operationId: services/ensure-shares:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServicesEnsure_SharesEnsure_SharesRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServicesEnsure_SharesResponse'
description: Ok
tags:
- services
x-openstack:
min-ver: '2.86'
/services/{id}:
parameters:
- $ref: '#/components/parameters/services_id'
put:
deprecated: true
operationId: services/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUpdateResponse'
description: Ok
tags:
- services
x-openstack:
max-ver: '2.82'
min-ver: '2.7'
/share-access-rules:
get:
deprecated: true
operationId: share-access-rules:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Access_RulesListResponse'
description: Ok
tags:
- share-access-rules
x-openstack:
max-ver: '2.81'
min-ver: '2.45'
/share-access-rules/{access_id}/metadata:
parameters:
- $ref: '#/components/parameters/share_access_rules_metadata_access_id'
put:
operationId: share-access-rules/access_id/metadata:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Access_RulesMetadataUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Access_RulesMetadataUpdateResponse'
description: Ok
tags:
- share-access-rules
x-openstack:
min-ver: '2.45'
/share-access-rules/{access_id}/metadata/{key}:
delete:
description: |-
Deletes an existing access metadata.
operationId: share-access-rules/access_id/metadata/key:delete
responses:
'200':
description: Ok
tags:
- share-access-rules
x-openstack:
min-ver: '2.45'
parameters:
- $ref: '#/components/parameters/share_access_rules_metadata_access_id'
- $ref: '#/components/parameters/share_access_rules_metadata_key'
/share-access-rules/{id}:
get:
description: |-
Return data about the given share access rule.
operationId: share-access-rules/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Access_RuleShowResponse'
description: Ok
tags:
- share-access-rules
x-openstack:
min-ver: '2.45'
parameters:
- $ref: '#/components/parameters/share_access_rules_id'
put:
description: |-
Update access_level about the given share access rule.
operationId: share-access-rules/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Access_RuleUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Access_RuleUpdateResponse'
description: Ok
tags:
- share-access-rules
x-openstack:
min-ver: '2.88'
/share-backups:
get:
description: |-
Return a summary list of backups.
operationId: share-backups:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_BackupsListResponse'
description: Ok
tags:
- share-backups
x-openstack:
min-ver: '2.80'
post:
description: |-
Add a backup to an existing share.
operationId: share-backups:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_BackupsCreateRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_BackupsCreateResponse'
description: Ok
tags:
- share-backups
x-openstack:
min-ver: '2.80'
/share-backups/detail:
get:
description: |-
Returns a detailed list of backups.
operationId: share-backups/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_BackupsDetailResponse'
description: Ok
tags:
- share-backups
x-openstack:
min-ver: '2.80'
/share-backups/{id}:
delete:
description: |-
Delete a backup.
operationId: share-backups/id:delete
responses:
'204':
description: Ok
tags:
- share-backups
x-openstack:
min-ver: '2.80'
get:
description: |-
Return data about the given backup.
operationId: share-backups/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_BackupShowResponse'
description: Ok
tags:
- share-backups
x-openstack:
min-ver: '2.80'
parameters:
- $ref: '#/components/parameters/share_backups_id'
put:
description: |-
Update a backup.
operationId: share-backups/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_BackupUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_BackupUpdateResponse'
description: Ok
tags:
- share-backups
x-openstack:
min-ver: '2.80'
/share-backups/{id}/action:
parameters:
- $ref: '#/components/parameters/share_backups_action_id'
post:
operationId: share-backups/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_BackupsActionReset_StatusRequest'
- $ref: '#/components/schemas/Share_BackupsActionRestoreRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_BackupsActionReset_StatusResponse'
description: Ok
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_BackupsActionRestoreResponse'
description: Ok
tags:
- share-backups
/share-group-snapshots:
get:
deprecated: true
description: |-
Returns a summary list of share group snapshots.
operationId: share-group-snapshots:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_SnapshotsListResponse'
description: Ok
tags:
- share-group-snapshots
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
post:
deprecated: true
operationId: share-group-snapshots:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_SnapshotsCreateRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_SnapshotsCreateResponse'
description: Ok
tags:
- share-group-snapshots
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-group-snapshots/detail:
get:
deprecated: true
description: |-
Returns a detailed list of share group snapshots.
operationId: share-group-snapshots/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_SnapshotsDetailResponse'
description: Ok
tags:
- share-group-snapshots
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-group-snapshots/{id}:
delete:
deprecated: true
operationId: share-group-snapshots/id:delete
responses:
'204':
description: Ok
tags:
- share-group-snapshots
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
get:
deprecated: true
operationId: share-group-snapshots/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_SnapshotShowResponse'
description: Ok
tags:
- share-group-snapshots
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
parameters:
- $ref: '#/components/parameters/share_group_snapshots_id'
put:
deprecated: true
operationId: share-group-snapshots/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_SnapshotUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_SnapshotUpdateResponse'
description: Ok
tags:
- share-group-snapshots
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-group-snapshots/{id}/action:
parameters:
- $ref: '#/components/parameters/share_group_snapshots_action_id'
post:
operationId: share-group-snapshots/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_Group_SnapshotsActionForce_DeleteRequest'
- $ref: '#/components/schemas/Share_Group_SnapshotsActionReset_StatusRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_Group_SnapshotsActionForce_DeleteResponse'
- $ref: '#/components/schemas/Share_Group_SnapshotsActionReset_StatusResponse'
description: Ok
tags:
- share-group-snapshots
/share-group-snapshots/{id}/members:
get:
deprecated: true
operationId: share-group-snapshots/id/members:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_SnapshotsMembersResponse'
description: Ok
tags:
- share-group-snapshots
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
parameters:
- $ref: '#/components/parameters/share_group_snapshots_members_id'
/share-group-types:
get:
deprecated: true
operationId: share-group-types:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesListResponse'
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
post:
deprecated: true
operationId: share-group-types:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesCreateResponse'
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-group-types/default:
get:
deprecated: true
operationId: share-group-types/default:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesDefaultResponse'
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-group-types/{id}:
delete:
deprecated: true
operationId: share-group-types/id:delete
responses:
'204':
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
get:
deprecated: true
operationId: share-group-types/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypeShowResponse'
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
parameters:
- $ref: '#/components/parameters/share_group_types_id'
/share-group-types/{id}/access:
get:
deprecated: true
operationId: share-group-types/id/access:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesAccessShare_Group_Type_AccessResponse'
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
parameters:
- $ref: '#/components/parameters/share_group_types_access_id'
/share-group-types/{id}/action:
parameters:
- $ref: '#/components/parameters/share_group_types_action_id'
post:
operationId: share-group-types/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_Group_TypesActionAddprojectaccessRequest'
- $ref: '#/components/schemas/Share_Group_TypesActionCreateRequest'
- $ref: '#/components/schemas/Share_Group_TypesActionDeleteRequest'
- $ref: '#/components/schemas/Share_Group_TypesActionRemoveprojectaccessRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_Group_TypesActionAddprojectaccessResponse'
- $ref: '#/components/schemas/Share_Group_TypesActionCreateResponse'
- $ref: '#/components/schemas/Share_Group_TypesActionDeleteResponse'
- $ref: '#/components/schemas/Share_Group_TypesActionRemoveprojectaccessResponse'
description: Ok
tags:
- share-group-types
/share-group-types/{id}/group-specs:
get:
deprecated: true
operationId: share-group-types/id/group-specs:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesGroup_SpecsListResponse'
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
parameters:
- $ref: '#/components/parameters/share_group_types_group_specs_id'
post:
deprecated: true
operationId: share-group-types/id/group-specs:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesGroup_SpecsCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesGroup_SpecsCreateResponse'
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-group-types/{id}/group-specs/{key}:
delete:
deprecated: true
operationId: share-group-types/id/group-specs/key:delete
responses:
'204':
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
get:
deprecated: true
operationId: share-group-types/id/group-specs/key:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesGroup_SpecShowResponse'
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
parameters:
- $ref: '#/components/parameters/share_group_types_group_specs_id'
- $ref: '#/components/parameters/share_group_types_group_specs_key'
put:
deprecated: true
operationId: share-group-types/id/group-specs/key:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesGroup_SpecUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_Group_TypesGroup_SpecUpdateResponse'
description: Ok
tags:
- share-group-types
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-groups:
get:
deprecated: true
operationId: share-groups:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_GroupsListResponse'
description: Ok
tags:
- share-groups
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
post:
deprecated: true
operationId: share-groups:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_GroupsCreateRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_GroupsCreateResponse'
description: Ok
tags:
- share-groups
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-groups/detail:
get:
deprecated: true
operationId: share-groups/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_GroupsDetailResponse'
description: Ok
tags:
- share-groups
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-groups/{id}:
delete:
deprecated: true
operationId: share-groups/id:delete
responses:
'204':
description: Ok
tags:
- share-groups
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
get:
deprecated: true
operationId: share-groups/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_GroupShowResponse'
description: Ok
tags:
- share-groups
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
parameters:
- $ref: '#/components/parameters/share_groups_id'
put:
deprecated: true
operationId: share-groups/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_GroupUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_GroupUpdateResponse'
description: Ok
tags:
- share-groups
x-openstack:
max-ver: '2.54'
min-ver: '2.31'
/share-groups/{id}/action:
parameters:
- $ref: '#/components/parameters/share_groups_action_id'
post:
operationId: share-groups/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_GroupsActionForce_DeleteRequest'
- $ref: '#/components/schemas/Share_GroupsActionReset_StatusRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_GroupsActionForce_DeleteResponse'
- $ref: '#/components/schemas/Share_GroupsActionReset_StatusResponse'
description: Ok
tags:
- share-groups
/share-networks:
get:
description: |-
Returns a summary list of share networks.
operationId: share-networks:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksListResponse'
description: Ok
tags:
- share-networks
post:
description: |-
Creates a new share network.
operationId: share-networks:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksCreateResponse'
description: Ok
tags:
- share-networks
/share-networks/detail:
get:
description: |-
Returns a detailed list of share networks.
operationId: share-networks/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksDetailResponse'
description: Ok
tags:
- share-networks
/share-networks/{id}:
delete:
description: |-
Delete specified share network.
operationId: share-networks/id:delete
responses:
'204':
description: Ok
tags:
- share-networks
get:
description: |-
Return data about the requested network info.
operationId: share-networks/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworkShowResponse'
description: Ok
tags:
- share-networks
parameters:
- $ref: '#/components/parameters/share_networks_id'
put:
description: |-
Update specified share network.
operationId: share-networks/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworkUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworkUpdateResponse'
description: Ok
tags:
- share-networks
/share-networks/{id}/action:
parameters:
- $ref: '#/components/parameters/share_networks_action_id'
post:
operationId: share-networks/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_NetworksActionAdd_Security_ServiceRequest'
- $ref: '#/components/schemas/Share_NetworksActionAdd_Security_Service_CheckRequest'
- $ref: '#/components/schemas/Share_NetworksActionRemove_Security_ServiceRequest'
- $ref: '#/components/schemas/Share_NetworksActionReset_StatusRequest'
- $ref: '#/components/schemas/Share_NetworksActionShare_Network_Subnet_Create_CheckRequest'
- $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_ServiceRequest'
- $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_Service_CheckRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_NetworksActionAdd_Security_ServiceResponse'
- $ref: '#/components/schemas/Share_NetworksActionRemove_Security_ServiceResponse'
- $ref: '#/components/schemas/Share_NetworksActionReset_StatusResponse'
description: Ok
'202':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_NetworksActionAdd_Security_Service_CheckResponse'
- $ref: '#/components/schemas/Share_NetworksActionShare_Network_Subnet_Create_CheckResponse'
- $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_ServiceResponse'
- $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_Service_CheckResponse'
description: Ok
tags:
- share-networks
/share-networks/{share_network_id}/subnets:
get:
description: |-
Returns a list of share network subnets.
operationId: share-networks/share_network_id/subnets:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsListResponse'
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.51'
parameters:
- $ref: '#/components/parameters/share_networks_subnets_share_network_id'
post:
description: |-
Add a new share network subnet into the share network.
operationId: share-networks/share_network_id/subnets:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsCreateResponse'
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.51'
/share-networks/{share_network_id}/subnets/{resource_id}/metadata:
get:
description: |-
Returns the list of metadata for a given share network subnet.
operationId:
share-networks/share_network_id/subnets/resource_id/metadata:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsMetadataList_MetadataResponse'
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.78'
parameters:
- $ref: '#/components/parameters/share_networks_subnets_metadata_resource_id'
- $ref: '#/components/parameters/share_networks_subnets_metadata_share_network_id'
post:
description: |-
Create metadata for a given share network subnet.
operationId:
share-networks/share_network_id/subnets/resource_id/metadata:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsMetadataCreate_MetadataRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsMetadataCreate_MetadataResponse'
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.78'
put:
description: |-
Update entire metadata for a given share network subnet.
operationId:
share-networks/share_network_id/subnets/resource_id/metadata:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_All_MetadataRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_All_MetadataResponse'
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.78'
/share-networks/{share_network_id}/subnets/{resource_id}/metadata/{key}:
delete:
description: |-
Delete metadata for a given share network subnet.
operationId:
share-networks/share_network_id/subnets/resource_id/metadata/key:delete
responses:
'204':
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.78'
get:
description: |-
Show metadata for a given share network subnet.
operationId:
share-networks/share_network_id/subnets/resource_id/metadata/key:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsMetadataShow_MetadataResponse'
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.78'
parameters:
- $ref: '#/components/parameters/share_networks_subnets_metadata_key'
- $ref: '#/components/parameters/share_networks_subnets_metadata_resource_id'
- $ref: '#/components/parameters/share_networks_subnets_metadata_share_network_id'
post:
description: |-
Update metadata item for a given share network subnet.
operationId:
share-networks/share_network_id/subnets/resource_id/metadata/key:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_Metadata_ItemRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_Metadata_ItemResponse'
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.78'
/share-networks/{share_network_id}/subnets/{share_network_subnet_id}:
delete:
description: |-
Delete specified share network subnet.
operationId:
share-networks/share_network_id/subnets/share_network_subnet_id:delete
responses:
'204':
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.51'
get:
description: |-
Show share network subnet.
operationId:
share-networks/share_network_id/subnets/share_network_subnet_id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_NetworksSubnetShowResponse'
description: Ok
tags:
- share-networks
x-openstack:
min-ver: '2.51'
parameters:
- $ref: '#/components/parameters/share_networks_subnets_share_network_id'
- $ref: '#/components/parameters/share_networks_subnets_share_network_subnet_id'
/share-replicas:
get:
deprecated: true
description: |-
Return a summary list of replicas.
operationId: share-replicas:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ReplicasListResponse'
description: Ok
tags:
- share-replicas
x-openstack:
max-ver: '2.55'
min-ver: '2.11'
post:
deprecated: true
operationId: share-replicas:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ReplicasCreateRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ReplicasCreateResponse'
description: Ok
tags:
- share-replicas
x-openstack:
max-ver: '2.66'
min-ver: '2.11'
/share-replicas/detail:
get:
deprecated: true
description: |-
Returns a detailed list of replicas.
operationId: share-replicas/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ReplicasDetailResponse'
description: Ok
tags:
- share-replicas
x-openstack:
max-ver: '2.55'
min-ver: '2.11'
/share-replicas/{id}:
delete:
deprecated: true
operationId: share-replicas/id:delete
responses:
'204':
description: Ok
tags:
- share-replicas
x-openstack:
max-ver: '2.55'
min-ver: '2.11'
get:
deprecated: true
description: |-
Return data about the given replica.
operationId: share-replicas/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ReplicaShowResponse'
description: Ok
tags:
- share-replicas
x-openstack:
max-ver: '2.55'
min-ver: '2.11'
parameters:
- $ref: '#/components/parameters/share_replicas_id'
/share-replicas/{id}/action:
parameters:
- $ref: '#/components/parameters/share_replicas_action_id'
post:
operationId: share-replicas/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_ReplicasActionForce_DeleteRequest'
- $ref: '#/components/schemas/Share_ReplicasActionPromoteRequest'
- $ref: '#/components/schemas/Share_ReplicasActionReset_Replica_StateRequest'
- $ref: '#/components/schemas/Share_ReplicasActionReset_StatusRequest'
- $ref: '#/components/schemas/Share_ReplicasActionResyncRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_ReplicasActionForce_DeleteResponse'
- $ref: '#/components/schemas/Share_ReplicasActionReset_Replica_StateResponse'
- $ref: '#/components/schemas/Share_ReplicasActionReset_StatusResponse'
description: Ok
'202':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_ReplicasActionPromoteResponse'
- $ref: '#/components/schemas/Share_ReplicasActionResyncResponse'
description: Ok
tags:
- share-replicas
/share-replicas/{share_replica_id}/export-locations:
get:
deprecated: true
operationId: share-replicas/share_replica_id/export-locations:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ReplicasExport_LocationsListResponse'
description: Ok
tags:
- share-replicas
x-openstack:
max-ver: '2.55'
min-ver: '2.47'
parameters:
- $ref: '#/components/parameters/share_replicas_export_locations_share_replica_id'
/share-replicas/{share_replica_id}/export-locations/{export_location_uuid}:
get:
deprecated: true
operationId:
share-replicas/share_replica_id/export-locations/export_location_uuid:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ReplicasExport_LocationShowResponse'
description: Ok
tags:
- share-replicas
x-openstack:
max-ver: '2.55'
min-ver: '2.47'
parameters:
- $ref: '#/components/parameters/share_replicas_export_locations_export_location_uuid'
- $ref: '#/components/parameters/share_replicas_export_locations_share_replica_id'
/share-servers:
get:
description: |-
Returns a list of share servers.
operationId: share-servers:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ServersListResponse'
description: Ok
tags:
- share-servers
/share-servers/manage:
post:
operationId: share-servers/manage:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ServersManageManageRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ServersManageResponse'
description: Ok
tags:
- share-servers
x-openstack:
min-ver: '2.49'
/share-servers/{id}:
delete:
description: |-
Delete specified share server.
operationId: share-servers/id:delete
responses:
'204':
description: Ok
tags:
- share-servers
get:
description: |-
Return data about the requested share server.
operationId: share-servers/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ServerShowResponse'
description: Ok
tags:
- share-servers
parameters:
- $ref: '#/components/parameters/share_servers_id'
/share-servers/{id}/action:
parameters:
- $ref: '#/components/parameters/share_servers_action_id'
post:
operationId: share-servers/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_ServersActionMigration_CancelRequest'
- $ref: '#/components/schemas/Share_ServersActionMigration_CheckRequest'
- $ref: '#/components/schemas/Share_ServersActionMigration_CompleteRequest'
- $ref: '#/components/schemas/Share_ServersActionMigration_Get_ProgressRequest'
- $ref: '#/components/schemas/Share_ServersActionMigration_StartRequest'
- $ref: '#/components/schemas/Share_ServersActionReset_StatusRequest'
- $ref: '#/components/schemas/Share_ServersActionReset_Task_StateRequest'
- $ref: '#/components/schemas/Share_ServersActionUnmanageRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_ServersActionMigration_CheckResponse'
- $ref: '#/components/schemas/Share_ServersActionMigration_CompleteResponse'
- $ref: '#/components/schemas/Share_ServersActionMigration_Get_ProgressResponse'
- $ref: '#/components/schemas/Share_ServersActionReset_StatusResponse'
- $ref: '#/components/schemas/Share_ServersActionReset_Task_StateResponse'
- $ref: '#/components/schemas/Share_ServersActionUnmanageResponse'
description: Ok
'202':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_ServersActionMigration_CancelResponse'
- $ref: '#/components/schemas/Share_ServersActionMigration_StartResponse'
description: Ok
tags:
- share-servers
/share-servers/{id}/details:
get:
description: |-
Return details for requested share server.
operationId: share-servers/id/details:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_ServersDetailsResponse'
description: Ok
tags:
- share-servers
parameters:
- $ref: '#/components/parameters/share_servers_details_id'
/share-transfers:
get:
description: |-
Returns a summary list of transfers.
operationId: share-transfers:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_TransfersListResponse'
description: Ok
tags:
- share-transfers
x-openstack:
min-ver: '2.77'
post:
description: |-
Create a new share transfer.
operationId: share-transfers:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_TransfersCreateRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_TransfersCreateResponse'
description: Ok
tags:
- share-transfers
x-openstack:
min-ver: '2.77'
/share-transfers/detail:
get:
description: |-
Returns a detailed list of transfers.
operationId: share-transfers/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_TransfersDetailResponse'
description: Ok
tags:
- share-transfers
x-openstack:
min-ver: '2.77'
/share-transfers/{id}:
delete:
description: |-
Delete a transfer.
operationId: share-transfers/id:delete
responses:
'204':
description: Ok
tags:
- share-transfers
x-openstack:
min-ver: '2.77'
get:
description: |-
Return data about active transfers.
operationId: share-transfers/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_TransferShowResponse'
description: Ok
tags:
- share-transfers
x-openstack:
min-ver: '2.77'
parameters:
- $ref: '#/components/parameters/share_transfers_id'
/share-transfers/{id}/accept:
parameters:
- $ref: '#/components/parameters/share_transfers_accept_id'
post:
description: |-
Accept a new share transfer.
operationId: share-transfers/id/accept:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Share_TransfersAcceptAcceptRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_TransfersAcceptResponse'
description: Ok
tags:
- share-transfers
x-openstack:
min-ver: '2.77'
/share_instances:
get:
deprecated: true
operationId: share_instances:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_InstancesListResponse'
description: Ok
tags:
- share_instances
x-openstack:
max-ver: '2.68'
min-ver: '2.3'
/share_instances/{id}:
get:
operationId: share_instances/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_InstanceShowResponse'
description: Ok
tags:
- share_instances
x-openstack:
min-ver: '2.3'
parameters:
- $ref: '#/components/parameters/share_instances_id'
/share_instances/{id}/action:
parameters:
- $ref: '#/components/parameters/share_instances_action_id'
post:
operationId: share_instances/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_InstancesActionForce_DeleteRequest'
- $ref: '#/components/schemas/Share_InstancesActionOs-Force_DeleteRequest'
- $ref: '#/components/schemas/Share_InstancesActionOs-Reset_StatusRequest'
- $ref: '#/components/schemas/Share_InstancesActionReset_StatusRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Share_InstancesActionForce_DeleteResponse'
- $ref: '#/components/schemas/Share_InstancesActionOs-Force_DeleteResponse'
- $ref: '#/components/schemas/Share_InstancesActionOs-Reset_StatusResponse'
- $ref: '#/components/schemas/Share_InstancesActionReset_StatusResponse'
description: Ok
tags:
- share_instances
/share_instances/{share_instance_id}/export_locations:
get:
description: |-
Return a list of export locations for the share instance.
operationId: share_instances/share_instance_id/export_locations:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_InstancesExport_LocationsListResponse'
description: Ok
tags:
- share_instances
x-openstack:
min-ver: '2.9'
parameters:
- $ref: '#/components/parameters/share_instances_export_locations_share_instance_id'
/share_instances/{share_instance_id}/export_locations/{export_location_uuid}:
get:
description: |-
Return data about the requested export location.
operationId:
share_instances/share_instance_id/export_locations/export_location_uuid:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse'
description: Ok
tags:
- share_instances
x-openstack:
min-ver: '2.9'
parameters:
- $ref: '#/components/parameters/share_instances_export_locations_export_location_uuid'
- $ref: '#/components/parameters/share_instances_export_locations_share_instance_id'
/shares:
get:
description: |-
Returns a summary list of shares.
operationId: shares:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesListResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.0'
post:
deprecated: true
operationId: shares:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharesCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesCreateResponse'
description: Ok
tags:
- shares
x-openstack:
max-ver: '2.89'
min-ver: '2.0'
/shares/detail:
get:
description: |-
Returns a detailed list of shares.
operationId: shares/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesDetailResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.0'
/shares/manage:
post:
operationId: shares/manage:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharesManageManageRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesManageResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.7'
/shares/{id}:
delete:
description: |-
Delete a share.
operationId: shares/id:delete
responses:
'204':
description: Ok
tags:
- shares
get:
description: |-
Return data about the given share.
operationId: shares/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ShareShowResponse'
description: Ok
tags:
- shares
parameters:
- $ref: '#/components/parameters/shares_id'
put:
description: |-
Update a share.
operationId: shares/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShareUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ShareUpdateResponse'
description: Ok
tags:
- shares
/shares/{id}/action:
parameters:
- $ref: '#/components/parameters/shares_action_id'
post:
operationId: shares/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SharesActionAccess_ListRequest'
- $ref: '#/components/schemas/SharesActionAllow_AccessRequest'
- $ref: '#/components/schemas/SharesActionDeny_AccessRequest'
- $ref: '#/components/schemas/SharesActionExtendRequest'
- $ref: '#/components/schemas/SharesActionExtend_Legacy_20'
- $ref: '#/components/schemas/SharesActionMigration_Cancel_222'
- $ref: '#/components/schemas/SharesActionMigration_Complete_222'
- $ref: '#/components/schemas/SharesActionMigration_Get_Progress_222'
- $ref: '#/components/schemas/SharesActionMigration_Start_229'
- $ref: '#/components/schemas/SharesActionOs-Access_ListRequest'
- $ref: '#/components/schemas/SharesActionOs-Allow_AccessRequest'
- $ref: '#/components/schemas/SharesActionOs-Deny_AccessRequest'
- $ref: '#/components/schemas/SharesActionReset_Task_State_222'
- $ref: '#/components/schemas/SharesActionRevertRequest'
- $ref: '#/components/schemas/SharesActionShare_Force_Delete_27'
- $ref: '#/components/schemas/SharesActionShare_Force_Delete_Legacy_20'
- $ref: '#/components/schemas/SharesActionShare_Reset_Status_27'
- $ref: '#/components/schemas/SharesActionShare_Reset_Status_Legacy_20'
- $ref: '#/components/schemas/SharesActionShare_Restore_269'
- $ref: '#/components/schemas/SharesActionShare_Soft_Delete_269'
- $ref: '#/components/schemas/SharesActionShrink_27'
- $ref: '#/components/schemas/SharesActionShrink_Legacy_20'
- $ref: '#/components/schemas/SharesActionUnmanage_27'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SharesActionAccess_ListResponse'
- $ref: '#/components/schemas/SharesActionAllow_AccessResponse'
- $ref: '#/components/schemas/SharesActionDeny_AccessResponse'
- $ref: '#/components/schemas/SharesActionExtendResponse'
- $ref: '#/components/schemas/SharesActionForce_DeleteResponse'
- $ref: '#/components/schemas/SharesActionMigration_CancelResponse'
- $ref: '#/components/schemas/SharesActionMigration_CompleteResponse'
- $ref: '#/components/schemas/SharesActionMigration_Get_ProgressResponse'
- $ref: '#/components/schemas/SharesActionMigration_StartResponse'
- $ref: '#/components/schemas/SharesActionOs-Access_ListResponse'
- $ref: '#/components/schemas/SharesActionOs-Allow_AccessResponse'
- $ref: '#/components/schemas/SharesActionOs-Deny_AccessResponse'
- $ref: '#/components/schemas/SharesActionOs-ExtendResponse'
- $ref: '#/components/schemas/SharesActionOs-Force_DeleteResponse'
- $ref: '#/components/schemas/SharesActionOs-Reset_StatusResponse'
- $ref: '#/components/schemas/SharesActionOs-ShrinkResponse'
- $ref: '#/components/schemas/SharesActionReset_StatusResponse'
- $ref: '#/components/schemas/SharesActionReset_Task_StateResponse'
- $ref: '#/components/schemas/SharesActionRestoreResponse'
- $ref: '#/components/schemas/SharesActionRevertResponse'
- $ref: '#/components/schemas/SharesActionShrinkResponse'
- $ref: '#/components/schemas/SharesActionSoft_DeleteResponse'
- $ref: '#/components/schemas/SharesActionUnmanageResponse'
description: Ok
tags:
- shares
/shares/{resource_id}/metadata:
get:
description: |-
Returns the list of metadata for a given share.
operationId: shares/resource_id/metadata:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesMetadataList_MetadataResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.0'
parameters:
- $ref: '#/components/parameters/shares_metadata_resource_id'
post:
operationId: shares/resource_id/metadata:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharesMetadataCreate_MetadataRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesMetadataCreate_MetadataResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.0'
put:
operationId: shares/resource_id/metadata:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharesMetadataUpdate_All_MetadataRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesMetadataUpdate_All_MetadataResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.0'
/shares/{resource_id}/metadata/{key}:
delete:
operationId: shares/resource_id/metadata/key:delete
responses:
'204':
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.0'
get:
operationId: shares/resource_id/metadata/key:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesMetadataShow_MetadataResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.0'
parameters:
- $ref: '#/components/parameters/shares_metadata_key'
- $ref: '#/components/parameters/shares_metadata_resource_id'
post:
operationId: shares/resource_id/metadata/key:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharesMetadataUpdate_Metadata_ItemRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesMetadataUpdate_Metadata_ItemResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.0'
/shares/{share_id}/export_locations:
get:
deprecated: true
description: |-
Return a list of export locations for share.
operationId: shares/share_id/export_locations:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationsListResponse'
description: Ok
tags:
- shares
x-openstack:
max-ver: '2.46'
min-ver: '2.9'
parameters:
- $ref: '#/components/parameters/shares_export_locations_share_id'
/shares/{share_id}/export_locations/{export_location_uuid}:
get:
deprecated: true
description: |-
Return data about the requested export location.
operationId: shares/share_id/export_locations/export_location_uuid:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationShowResponse'
description: Ok
tags:
- shares
x-openstack:
max-ver: '2.46'
min-ver: '2.9'
parameters:
- $ref: '#/components/parameters/shares_export_locations_export_location_uuid'
- $ref: '#/components/parameters/shares_export_locations_share_id'
/shares/{share_id}/export_locations/{resource_id}/metadata:
get:
description: |-
Returns the list of metadata for a given share export location.
operationId: shares/share_id/export_locations/resource_id/metadata:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationsMetadataList_MetadataResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.87'
parameters:
- $ref: '#/components/parameters/shares_export_locations_metadata_resource_id'
- $ref: '#/components/parameters/shares_export_locations_metadata_share_id'
post:
description: |-
Create metadata for a given share export location.
operationId: shares/share_id/export_locations/resource_id/metadata:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationsMetadataCreate_Metadata_287'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationsMetadataCreate_MetadataResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.87'
put:
description: |-
Update entire metadata for a given share export location.
operationId: shares/share_id/export_locations/resource_id/metadata:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_All_Metadata_287'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_All_MetadataResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.87'
/shares/{share_id}/export_locations/{resource_id}/metadata/{key}:
delete:
description: |-
Delete metadata for a given share export location.
operationId:
shares/share_id/export_locations/resource_id/metadata/key:delete
responses:
'204':
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.87'
get:
description: |-
Show metadata for a given share export location.
operationId: shares/share_id/export_locations/resource_id/metadata/key:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationsMetadataShow_MetadataResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.87'
parameters:
- $ref: '#/components/parameters/shares_export_locations_metadata_key'
- $ref: '#/components/parameters/shares_export_locations_metadata_resource_id'
- $ref: '#/components/parameters/shares_export_locations_metadata_share_id'
post:
description: |-
Update metadata item for a given share export location.
operationId:
shares/share_id/export_locations/resource_id/metadata/key:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_Metadata_Item_287'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.87'
/shares/{share_id}/instances:
get:
operationId: shares/share_id/instances:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SharesInstancesGet_Share_InstancesResponse'
description: Ok
tags:
- shares
x-openstack:
min-ver: '2.3'
parameters:
- $ref: '#/components/parameters/shares_instances_share_id'
/snapshot-instances:
get:
description: |-
Return a summary list of snapshot instances.
operationId: snapshot-instances:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snapshot_InstancesListResponse'
description: Ok
tags:
- snapshot-instances
x-openstack:
min-ver: '2.19'
/snapshot-instances/detail:
get:
description: |-
Returns a detailed list of snapshot instances.
operationId: snapshot-instances/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snapshot_InstancesDetailResponse'
description: Ok
tags:
- snapshot-instances
x-openstack:
min-ver: '2.19'
/snapshot-instances/{id}:
get:
operationId: snapshot-instances/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snapshot_InstanceShowResponse'
description: Ok
tags:
- snapshot-instances
x-openstack:
min-ver: '2.19'
parameters:
- $ref: '#/components/parameters/snapshot_instances_id'
/snapshot-instances/{id}/action:
parameters:
- $ref: '#/components/parameters/snapshot_instances_action_id'
post:
operationId: snapshot-instances/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Snapshot_InstancesActionReset_StatusRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Snapshot_InstancesActionReset_StatusResponse'
description: Ok
tags:
- snapshot-instances
/snapshot-instances/{snapshot_instance_id}/export-locations:
get:
operationId: snapshot-instances/snapshot_instance_id/export-locations:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snapshot_InstancesExport_LocationsListResponse'
description: Ok
tags:
- snapshot-instances
x-openstack:
min-ver: '2.32'
parameters:
- $ref: '#/components/parameters/snapshot_instances_export_locations_snapshot_instance_id'
/snapshot-instances/{snapshot_instance_id}/export-locations/{export_location_id}:
get:
operationId:
snapshot-instances/snapshot_instance_id/export-locations/export_location_id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Snapshot_InstancesExport_LocationShowResponse'
description: Ok
tags:
- snapshot-instances
x-openstack:
min-ver: '2.32'
parameters:
- $ref: '#/components/parameters/snapshot_instances_export_locations_export_location_id'
- $ref: '#/components/parameters/snapshot_instances_export_locations_snapshot_instance_id'
/snapshots:
get:
description: |-
Returns a summary list of shares.
operationId: snapshots:get
parameters:
- $ref: '#/components/parameters/snapshots_all_tenants'
- $ref: '#/components/parameters/snapshots_description'
- $ref: '#/components/parameters/snapshots_description_'
- $ref: '#/components/parameters/snapshots_limit'
- $ref: '#/components/parameters/snapshots_metadata'
- $ref: '#/components/parameters/snapshots_name'
- $ref: '#/components/parameters/snapshots_name_'
- $ref: '#/components/parameters/snapshots_offset'
- $ref: '#/components/parameters/snapshots_project_id'
- $ref: '#/components/parameters/snapshots_share_id'
- $ref: '#/components/parameters/snapshots_size'
- $ref: '#/components/parameters/snapshots_sort_dir'
- $ref: '#/components/parameters/snapshots_sort_key'
- $ref: '#/components/parameters/snapshots_status'
- $ref: '#/components/parameters/snapshots_with_count'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsListResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.0'
post:
description: |-
Creates a new snapshot.
operationId: snapshots:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsCreateRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsCreateResponse'
description: Ok
tags:
- snapshots
/snapshots/detail:
get:
description: |-
Returns a detailed list of shares.
operationId: snapshots/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsDetailResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.0'
/snapshots/manage:
post:
operationId: snapshots/manage:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsManageManageRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsManageResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.12'
/snapshots/{id}:
delete:
description: |-
Delete a snapshot.
operationId: snapshots/id:delete
responses:
'204':
description: Ok
tags:
- snapshots
get:
description: |-
Return data about the given snapshot.
operationId: snapshots/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotShowResponse'
description: Ok
tags:
- snapshots
parameters:
- $ref: '#/components/parameters/snapshots_id'
put:
description: |-
Update a snapshot.
operationId: snapshots/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotUpdateResponse'
description: Ok
tags:
- snapshots
/snapshots/{id}/action:
parameters:
- $ref: '#/components/parameters/snapshots_action_id'
post:
operationId: snapshots/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SnapshotsActionAllow_AccessRequest'
- $ref: '#/components/schemas/SnapshotsActionDeny_AccessRequest'
- $ref: '#/components/schemas/SnapshotsActionForce_DeleteRequest'
- $ref: '#/components/schemas/SnapshotsActionOs-Force_DeleteRequest'
- $ref: '#/components/schemas/SnapshotsActionOs-Reset_StatusRequest'
- $ref: '#/components/schemas/SnapshotsActionReset_StatusRequest'
- $ref: '#/components/schemas/SnapshotsActionUnmanageRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SnapshotsActionDeny_AccessResponse'
- $ref: '#/components/schemas/SnapshotsActionForce_DeleteResponse'
- $ref: '#/components/schemas/SnapshotsActionOs-Force_DeleteResponse'
- $ref: '#/components/schemas/SnapshotsActionOs-Reset_StatusResponse'
- $ref: '#/components/schemas/SnapshotsActionReset_StatusResponse'
- $ref: '#/components/schemas/SnapshotsActionUnmanageResponse'
description: Ok
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsActionAllow_AccessResponse'
description: Ok
tags:
- snapshots
/snapshots/{resource_id}/metadata:
get:
description: |-
Returns the list of metadata for a given share snapshot.
operationId: snapshots/resource_id/metadata:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsMetadataList_MetadataResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.73'
parameters:
- $ref: '#/components/parameters/snapshots_metadata_resource_id'
post:
operationId: snapshots/resource_id/metadata:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsMetadataCreate_MetadataRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsMetadataCreate_MetadataResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.73'
put:
operationId: snapshots/resource_id/metadata:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsMetadataUpdate_All_MetadataRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsMetadataUpdate_All_MetadataResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.73'
/snapshots/{resource_id}/metadata/{key}:
delete:
operationId: snapshots/resource_id/metadata/key:delete
responses:
'204':
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.73'
get:
operationId: snapshots/resource_id/metadata/key:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsMetadataShow_MetadataResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.73'
parameters:
- $ref: '#/components/parameters/snapshots_metadata_key'
- $ref: '#/components/parameters/snapshots_metadata_resource_id'
post:
operationId: snapshots/resource_id/metadata/key:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsMetadataUpdate_Metadata_ItemRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsMetadataUpdate_Metadata_ItemResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.73'
/snapshots/{snapshot_id}/access-list:
get:
operationId: snapshots/snapshot_id/access-list:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsAccess_ListResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.32'
parameters:
- $ref: '#/components/parameters/snapshots_access_list_snapshot_id'
/snapshots/{snapshot_id}/export-locations:
get:
operationId: snapshots/snapshot_id/export-locations:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsExport_LocationsListResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.32'
parameters:
- $ref: '#/components/parameters/snapshots_export_locations_snapshot_id'
/snapshots/{snapshot_id}/export-locations/{export_location_id}:
get:
operationId: snapshots/snapshot_id/export-locations/export_location_id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsExport_LocationShowResponse'
description: Ok
tags:
- snapshots
x-openstack:
min-ver: '2.32'
parameters:
- $ref: '#/components/parameters/snapshots_export_locations_export_location_id'
- $ref: '#/components/parameters/snapshots_export_locations_snapshot_id'
/types:
get:
description: |-
Returns the list of share types.
operationId: types:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesListResponse'
description: Ok
tags:
- types
post:
deprecated: true
operationId: types:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TypesCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesCreateResponse'
description: Ok
tags:
- types
x-openstack:
max-ver: '2.23'
min-ver: '1.0'
/types/default:
get:
description: |-
Return default volume type.
operationId: types/default:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesDefaultResponse'
description: Ok
tags:
- types
/types/{id}:
delete:
description: |-
Deletes an existing share type.
operationId: types/id:delete
responses:
'204':
description: Ok
tags:
- types
get:
description: |-
Return a single share type item.
operationId: types/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypeShowResponse'
description: Ok
tags:
- types
parameters:
- $ref: '#/components/parameters/types_id'
put:
description: |-
Update name description is_public for a given share type.
operationId: types/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TypeUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypeUpdateResponse'
description: Ok
tags:
- types
x-openstack:
min-ver: '2.50'
/types/{id}/action:
parameters:
- $ref: '#/components/parameters/types_action_id'
post:
operationId: types/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/TypesActionAddprojectaccessRequest'
- $ref: '#/components/schemas/TypesActionCreateRequest'
- $ref: '#/components/schemas/TypesActionDeleteRequest'
- $ref: '#/components/schemas/TypesActionRemoveprojectaccessRequest'
- $ref: '#/components/schemas/TypesActionUpdateRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/TypesActionAddprojectaccessResponse'
- $ref: '#/components/schemas/TypesActionCreateResponse'
- $ref: '#/components/schemas/TypesActionDeleteResponse'
- $ref: '#/components/schemas/TypesActionRemoveprojectaccessResponse'
- $ref: '#/components/schemas/TypesActionUpdateResponse'
description: Ok
tags:
- types
/types/{id}/os-share-type-access:
get:
operationId: types/id/os-share-type-access:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesOs_Share_Type_AccessOs-Share-Type-AccessResponse'
description: Ok
tags:
- types
parameters:
- $ref: '#/components/parameters/types_os_share_type_access_id'
/types/{id}/share_type_access:
get:
operationId: types/id/share_type_access:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesShare_Type_AccessResponse'
description: Ok
tags:
- types
parameters:
- $ref: '#/components/parameters/types_share_type_access_id'
/types/{type_id}/extra_specs:
get:
description: |-
Returns the list of extra specs for a given share type.
operationId: types/type_id/extra_specs:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesExtra_SpecsListResponse'
description: Ok
tags:
- types
parameters:
- $ref: '#/components/parameters/types_extra_specs_type_id'
post:
operationId: types/type_id/extra_specs:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TypesExtra_SpecsCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesExtra_SpecsCreateResponse'
description: Ok
tags:
- types
/types/{type_id}/extra_specs/{id}:
delete:
deprecated: true
description: |-
Deletes an existing extra spec.
operationId: types/type_id/extra_specs/id:delete
responses:
'204':
description: Ok
tags:
- types
x-openstack:
max-ver: '2.23'
min-ver: '1.0'
get:
description: |-
Return a single extra spec item.
operationId: types/type_id/extra_specs/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesExtra_SpecShowResponse'
description: Ok
tags:
- types
parameters:
- $ref: '#/components/parameters/types_extra_specs_id'
- $ref: '#/components/parameters/types_extra_specs_type_id'
put:
operationId: types/type_id/extra_specs/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TypesExtra_SpecUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesExtra_SpecUpdateResponse'
description: Ok
tags:
- types
components:
parameters:
availability_zones_edit_id:
description: id parameter for /availability-zones/{id}/edit API
in: path
name: id
required: true
schema:
type: string
availability_zones_id:
description: id parameter for /availability-zones/{id} API
in: path
name: id
required: true
schema:
type: string
extensions_edit_id:
description: id parameter for /extensions/{id}/edit API
in: path
name: id
required: true
schema:
type: string
extensions_id:
description: id parameter for /extensions/{id} API
in: path
name: id
required: true
schema:
type: string
limits_edit_id:
description: id parameter for /limits/{id}/edit API
in: path
name: id
required: true
schema:
type: string
limits_id:
description: id parameter for /limits/{id} API
in: path
name: id
required: true
schema:
type: string
messages_action_id:
in: query
name: action_id
schema:
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
messages_created_before:
in: query
name: created_before
schema:
format: date-time
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.52'
messages_created_since:
in: query
name: created_since
schema:
format: date-time
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.52'
messages_detail_id:
in: query
name: detail_id
schema:
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
messages_edit_id:
description: id parameter for /messages/{id}/edit API
in: path
name: id
required: true
schema:
type: string
messages_id:
description: id parameter for /messages/{id} API
in: path
name: id
required: true
schema:
type: string
messages_limit:
in: query
name: limit
schema:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
messages_message_level:
in: query
name: message_level
schema:
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
messages_offset:
in: query
name: offset
schema:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
messages_request_id:
in: query
name: request_id
schema:
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
messages_resource_id:
in: query
name: resource_id
schema:
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
messages_resource_type:
in: query
name: resource_type
schema:
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
messages_sort_dir:
in: query
name: sort_dir
schema:
default: desc
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
messages_sort_key:
in: query
name: sort_key
schema:
default: created_at
type: string
x-openstack:
max-ver: '2.51'
min-ver: '2.37'
os_availability_zone_edit_id:
description: id parameter for /os-availability-zone/{id}/edit API
in: path
name: id
required: true
schema:
type: string
os_availability_zone_id:
description: id parameter for /os-availability-zone/{id} API
in: path
name: id
required: true
schema:
type: string
os_quota_class_sets_edit_id:
description: id parameter for /os-quota-class-sets/{id}/edit API
in: path
name: id
required: true
schema:
type: string
os_quota_class_sets_id:
description: id parameter for /os-quota-class-sets/{id} API
in: path
name: id
required: true
schema:
type: string
os_quota_sets_defaults_id:
description: id parameter for /os-quota-sets/{id}/defaults API
in: path
name: id
required: true
schema:
type: string
os_quota_sets_edit_id:
description: id parameter for /os-quota-sets/{id}/edit API
in: path
name: id
required: true
schema:
type: string
os_quota_sets_id:
description: id parameter for /os-quota-sets/{id} API
in: path
name: id
required: true
schema:
type: string
os_services_edit_id:
description: id parameter for /os-services/{id}/edit API
in: path
name: id
required: true
schema:
type: string
os_services_id:
description: id parameter for /os-services/{id} API
in: path
name: id
required: true
schema:
type: string
os_share_manage_edit_id:
description: id parameter for /os-share-manage/{id}/edit API
in: path
name: id
required: true
schema:
type: string
os_share_manage_id:
description: id parameter for /os-share-manage/{id} API
in: path
name: id
required: true
schema:
type: string
os_share_unmanage_edit_id:
description: id parameter for /os-share-unmanage/{id}/edit API
in: path
name: id
required: true
schema:
type: string
os_share_unmanage_id:
description: id parameter for /os-share-unmanage/{id} API
in: path
name: id
required: true
schema:
type: string
os_share_unmanage_unmanage_id:
description: id parameter for /os-share-unmanage/{id}/unmanage API
in: path
name: id
required: true
schema:
type: string
quota_class_sets_edit_id:
description: id parameter for /quota-class-sets/{id}/edit API
in: path
name: id
required: true
schema:
type: string
quota_class_sets_id:
description: id parameter for /quota-class-sets/{id} API
in: path
name: id
required: true
schema:
type: string
quota_sets_defaults_id:
description: id parameter for /quota-sets/{id}/defaults API
in: path
name: id
required: true
schema:
type: string
quota_sets_detail_id:
description: id parameter for /quota-sets/{id}/detail API
in: path
name: id
required: true
schema:
type: string
quota_sets_edit_id:
description: id parameter for /quota-sets/{id}/edit API
in: path
name: id
required: true
schema:
type: string
quota_sets_id:
description: id parameter for /quota-sets/{id} API
in: path
name: id
required: true
schema:
type: string
resource_locks_all_projects:
in: query
name: all_projects
schema:
description: "Set this parameter to True to get resource locks across all
project\nnamespaces.\n"
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
x-openstack:
min-ver: '2.81'
resource_locks_created_before:
in: query
name: created_before
schema:
description: "Search for the list of resources that were created prior to
the specified\ndate. The date is in 'yyyy-mm-dd' format.\n"
format: date-time
type: string
x-openstack:
min-ver: '2.81'
resource_locks_created_since:
in: query
name: created_since
schema:
description: "Search for the list of resources that were created after the
specified\ndate. The date is in 'yyyy-mm-dd' format.\n"
format: date-time
type: string
x-openstack:
min-ver: '2.81'
resource_locks_edit_id:
description: id parameter for /resource-locks/{id}/edit API
in: path
name: id
required: true
schema:
type: string
resource_locks_id:
description: id parameter for /resource-locks/{id} API
in: path
name: id
required: true
schema:
type: string
resource_locks_limit:
in: query
name: limit
schema:
description: "The maximum number of resource records to return.\n"
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
min-ver: '2.81'
resource_locks_lock_context:
in: query
name: lock_context
schema:
description: "The lock creator's context to filter locks by.\n"
maxLength: 10
type:
- 'null'
- string
x-openstack:
min-ver: '2.81'
resource_locks_lock_reason:
in: query
name: lock_reason
schema:
description: "The lock reason that can be used to filter resource locks.\n"
maxLength: 1023
type:
- 'null'
- string
x-openstack:
min-ver: '2.81'
resource_locks_offset:
in: query
name: offset
schema:
description: "The offset to define start point of resource listing.\n"
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
min-ver: '2.81'
resource_locks_project_id:
in: query
name: project_id
schema:
description: "The ID of a project to filter resource locks by.\n"
format: uuid
type:
- 'null'
- string
x-openstack:
min-ver: '2.81'
resource_link: identity/v3/project.id
resource_locks_resource_action:
in: query
name: resource_action
schema:
description: "The ``action`` prevented by the filtered resource locks.\n"
enum:
-
- delete
- show
type:
- 'null'
- string
x-openstack:
min-ver: '2.81'
resource_locks_resource_id:
in: query
name: resource_id
schema:
description: "The ID of the resource that the locks pertain to to filter resource\n\
locks by.\n"
format: uuid
type:
- 'null'
- string
x-openstack:
min-ver: '2.81'
resource_locks_resource_type:
in: query
name: resource_type
schema:
description: "The type of the resource that the locks pertain to to filter
resource\nlocks by.\n"
enum:
-
- access_rule
- share
type:
- 'null'
- string
x-openstack:
min-ver: '2.81'
resource_locks_sort_dir:
in: query
name: sort_dir
schema:
default: desc
description: "The direction to sort a list of resources. A valid\nvalue is
``asc``, or ``desc``.\n"
type: string
x-openstack:
min-ver: '2.81'
resource_locks_sort_key:
in: query
name: sort_key
schema:
default: created_at
description: "The key to sort a list of resource locks. A valid value\nis
``id``, ``resource_id``, ``resource_type``, ``resource_action``,\n``user_id``,
``project_id``, ``created_at``, ``updated_act``,\n``lock_context``.\n"
type: string
x-openstack:
min-ver: '2.81'
resource_locks_user_id:
in: query
name: user_id
schema:
description: "The ID of a user to filter resource locks by.\n"
format: uuid
type:
- 'null'
- string
x-openstack:
min-ver: '2.81'
resource_link: identity/v3/user.id
resource_locks_with_count:
in: query
name: with_count
schema:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
x-openstack:
min-ver: '2.81'
security_services_edit_id:
description: id parameter for /security-services/{id}/edit API
in: path
name: id
required: true
schema:
type: string
security_services_id:
description: id parameter for /security-services/{id} API
in: path
name: id
required: true
schema:
type: string
services_edit_id:
description: id parameter for /services/{id}/edit API
in: path
name: id
required: true
schema:
type: string
services_id:
description: id parameter for /services/{id} API
in: path
name: id
required: true
schema:
type: string
share_access_rules_edit_id:
description: id parameter for /share-access-rules/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_access_rules_id:
description: id parameter for /share-access-rules/{id} API
in: path
name: id
required: true
schema:
type: string
share_access_rules_metadata_access_id:
description: access_id parameter for
/share-access-rules/{access_id}/metadata/{key} API
in: path
name: access_id
required: true
schema:
type: string
share_access_rules_metadata_key:
description: key parameter for
/share-access-rules/{access_id}/metadata/{key} API
in: path
name: key
required: true
schema:
type: string
share_backups_action_id:
description: id parameter for /share-backups/{id}/action API
in: path
name: id
required: true
schema:
type: string
share_backups_edit_id:
description: id parameter for /share-backups/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_backups_id:
description: id parameter for /share-backups/{id} API
in: path
name: id
required: true
schema:
type: string
share_group_snapshots_action_id:
description: id parameter for /share-group-snapshots/{id}/action API
in: path
name: id
required: true
schema:
type: string
share_group_snapshots_edit_id:
description: id parameter for /share-group-snapshots/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_group_snapshots_id:
description: id parameter for /share-group-snapshots/{id} API
in: path
name: id
required: true
schema:
type: string
share_group_snapshots_members_id:
description: id parameter for /share-group-snapshots/{id}/members API
in: path
name: id
required: true
schema:
type: string
share_group_types_access_id:
description: id parameter for /share-group-types/{id}/access API
in: path
name: id
required: true
schema:
type: string
share_group_types_action_id:
description: id parameter for /share-group-types/{id}/action API
in: path
name: id
required: true
schema:
type: string
share_group_types_edit_id:
description: id parameter for /share-group-types/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_group_types_group_specs_id:
description: id parameter for /share-group-types/{id}/group-specs/{key}
API
in: path
name: id
required: true
schema:
type: string
share_group_types_group_specs_key:
description: key parameter for /share-group-types/{id}/group-specs/{key}
API
in: path
name: key
required: true
schema:
type: string
share_group_types_id:
description: id parameter for /share-group-types/{id} API
in: path
name: id
required: true
schema:
type: string
share_groups_action_id:
description: id parameter for /share-groups/{id}/action API
in: path
name: id
required: true
schema:
type: string
share_groups_edit_id:
description: id parameter for /share-groups/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_groups_id:
description: id parameter for /share-groups/{id} API
in: path
name: id
required: true
schema:
type: string
share_instances_action_id:
description: id parameter for /share_instances/{id}/action API
in: path
name: id
required: true
schema:
type: string
share_instances_edit_id:
description: id parameter for /share_instances/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_instances_export_locations_export_location_uuid:
description: export_location_uuid parameter for
/share_instances/{share_instance_id}/export_locations/{export_location_uuid}
API
in: path
name: export_location_uuid
required: true
schema:
type: string
share_instances_export_locations_share_instance_id:
description: share_instance_id parameter for
/share_instances/{share_instance_id}/export_locations/{export_location_uuid}
API
in: path
name: share_instance_id
required: true
schema:
type: string
share_instances_id:
description: id parameter for /share_instances/{id} API
in: path
name: id
required: true
schema:
type: string
share_networks_action_id:
description: id parameter for /share-networks/{id}/action API
in: path
name: id
required: true
schema:
type: string
share_networks_edit_id:
description: id parameter for /share-networks/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_networks_id:
description: id parameter for /share-networks/{id} API
in: path
name: id
required: true
schema:
type: string
share_networks_subnets_metadata_key:
description: key parameter for
/share-networks/{share_network_id}/subnets/{resource_id}/metadata/{key}
API
in: path
name: key
required: true
schema:
type: string
share_networks_subnets_metadata_resource_id:
description: resource_id parameter for
/share-networks/{share_network_id}/subnets/{resource_id}/metadata/{key}
API
in: path
name: resource_id
required: true
schema:
type: string
share_networks_subnets_metadata_share_network_id:
description: share_network_id parameter for
/share-networks/{share_network_id}/subnets/{resource_id}/metadata/{key}
API
in: path
name: share_network_id
required: true
schema:
type: string
share_networks_subnets_share_network_id:
description: share_network_id parameter for
/share-networks/{share_network_id}/subnets API
in: path
name: share_network_id
required: true
schema:
type: string
share_networks_subnets_share_network_subnet_id:
description: share_network_subnet_id parameter for
/share-networks/{share_network_id}/subnets/{share_network_subnet_id} API
in: path
name: share_network_subnet_id
required: true
schema:
type: string
share_replicas_action_id:
description: id parameter for /share-replicas/{id}/action API
in: path
name: id
required: true
schema:
type: string
share_replicas_edit_id:
description: id parameter for /share-replicas/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_replicas_export_locations_export_location_uuid:
description: export_location_uuid parameter for
/share-replicas/{share_replica_id}/export-locations/{export_location_uuid}
API
in: path
name: export_location_uuid
required: true
schema:
type: string
share_replicas_export_locations_share_replica_id:
description: share_replica_id parameter for
/share-replicas/{share_replica_id}/export-locations/{export_location_uuid}
API
in: path
name: share_replica_id
required: true
schema:
type: string
share_replicas_id:
description: id parameter for /share-replicas/{id} API
in: path
name: id
required: true
schema:
type: string
share_servers_action_id:
description: id parameter for /share-servers/{id}/action API
in: path
name: id
required: true
schema:
type: string
share_servers_details_id:
description: id parameter for /share-servers/{id}/details API
in: path
name: id
required: true
schema:
type: string
share_servers_edit_id:
description: id parameter for /share-servers/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_servers_id:
description: id parameter for /share-servers/{id} API
in: path
name: id
required: true
schema:
type: string
share_transfers_accept_id:
description: id parameter for /share-transfers/{id}/accept API
in: path
name: id
required: true
schema:
type: string
share_transfers_edit_id:
description: id parameter for /share-transfers/{id}/edit API
in: path
name: id
required: true
schema:
type: string
share_transfers_id:
description: id parameter for /share-transfers/{id} API
in: path
name: id
required: true
schema:
type: string
shares_action_id:
description: id parameter for /shares/{id}/action API
in: path
name: id
required: true
schema:
type: string
shares_edit_id:
description: id parameter for /shares/{id}/edit API
in: path
name: id
required: true
schema:
type: string
shares_export_locations_export_location_uuid:
description: export_location_uuid parameter for
/shares/{share_id}/export_locations/{export_location_uuid} API
in: path
name: export_location_uuid
required: true
schema:
type: string
shares_export_locations_metadata_key:
description: key parameter for
/shares/{share_id}/export_locations/{resource_id}/metadata/{key} API
in: path
name: key
required: true
schema:
type: string
shares_export_locations_metadata_resource_id:
description: resource_id parameter for
/shares/{share_id}/export_locations/{resource_id}/metadata/{key} API
in: path
name: resource_id
required: true
schema:
type: string
shares_export_locations_metadata_share_id:
description: share_id parameter for
/shares/{share_id}/export_locations/{resource_id}/metadata/{key} API
in: path
name: share_id
required: true
schema:
type: string
shares_export_locations_share_id:
description: share_id parameter for
/shares/{share_id}/export_locations/{export_location_uuid} API
in: path
name: share_id
required: true
schema:
type: string
shares_id:
description: id parameter for /shares/{id} API
in: path
name: id
required: true
schema:
type: string
shares_instances_share_id:
description: share_id parameter for /shares/{share_id}/instances API
in: path
name: share_id
required: true
schema:
type: string
shares_metadata_key:
description: key parameter for /shares/{resource_id}/metadata/{key} API
in: path
name: key
required: true
schema:
type: string
shares_metadata_resource_id:
description: resource_id parameter for
/shares/{resource_id}/metadata/{key} API
in: path
name: resource_id
required: true
schema:
type: string
snapshot_instances_action_id:
description: id parameter for /snapshot-instances/{id}/action API
in: path
name: id
required: true
schema:
type: string
snapshot_instances_edit_id:
description: id parameter for /snapshot-instances/{id}/edit API
in: path
name: id
required: true
schema:
type: string
snapshot_instances_export_locations_export_location_id:
description: export_location_id parameter for
/snapshot-instances/{snapshot_instance_id}/export-locations/{export_location_id}
API
in: path
name: export_location_id
required: true
schema:
type: string
snapshot_instances_export_locations_snapshot_instance_id:
description: snapshot_instance_id parameter for
/snapshot-instances/{snapshot_instance_id}/export-locations/{export_location_id}
API
in: path
name: snapshot_instance_id
required: true
schema:
type: string
snapshot_instances_id:
description: id parameter for /snapshot-instances/{id} API
in: path
name: id
required: true
schema:
type: string
snapshots_access_list_snapshot_id:
description: snapshot_id parameter for
/snapshots/{snapshot_id}/access-list API
in: path
name: snapshot_id
required: true
schema:
type: string
snapshots_action_id:
description: id parameter for /snapshots/{id}/action API
in: path
name: id
required: true
schema:
type: string
snapshots_all_tenants:
in: query
name: all_tenants
schema:
description: Set 1 to list resources for all projects;set 0 to list
resources only for the current project
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_description:
in: query
name: description
schema:
maxLength: 255
minLength: 1
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_description_:
in: query
name: description~
schema:
maxLength: 255
minLength: 1
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_edit_id:
description: id parameter for /snapshots/{id}/edit API
in: path
name: id
required: true
schema:
type: string
snapshots_export_locations_export_location_id:
description: export_location_id parameter for
/snapshots/{snapshot_id}/export-locations/{export_location_id} API
in: path
name: export_location_id
required: true
schema:
type: string
snapshots_export_locations_snapshot_id:
description: snapshot_id parameter for
/snapshots/{snapshot_id}/export-locations/{export_location_id} API
in: path
name: snapshot_id
required: true
schema:
type: string
snapshots_id:
description: id parameter for /snapshots/{id} API
in: path
name: id
required: true
schema:
type: string
snapshots_limit:
in: query
name: limit
schema:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_metadata:
in: query
name: metadata
schema:
maxLength: 4096
minLength: 1
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_metadata_key:
description: key parameter for /snapshots/{resource_id}/metadata/{key} API
in: path
name: key
required: true
schema:
type: string
snapshots_metadata_resource_id:
description: resource_id parameter for
/snapshots/{resource_id}/metadata/{key} API
in: path
name: resource_id
required: true
schema:
type: string
snapshots_name:
in: query
name: name
schema:
maxLength: 255
minLength: 1
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_name_:
in: query
name: name~
schema:
maxLength: 255
minLength: 1
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_offset:
in: query
name: offset
schema:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_project_id:
in: query
name: project_id
schema:
maxLength: 255
minLength: 1
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
resource_link: identity/v3/project.id
snapshots_share_id:
in: query
name: share_id
schema:
maxLength: 255
minLength: 1
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_size:
in: query
name: size
schema:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_sort_dir:
in: query
name: sort_dir
schema:
default: desc
description: Sort direction
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_sort_key:
in: query
name: sort_key
schema:
maxLength: 255
minLength: 1
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_status:
in: query
name: status
schema:
maxLength: 255
minLength: 1
type: string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
snapshots_with_count:
in: query
name: with_count
schema:
default: false
description: Show count in share snapshot list API response
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
x-openstack:
max-ver: '2.35'
max_ver: '2.78'
types_action_id:
description: id parameter for /types/{id}/action API
in: path
name: id
required: true
schema:
type: string
types_edit_id:
description: id parameter for /types/{id}/edit API
in: path
name: id
required: true
schema:
type: string
types_extra_specs_edit_id:
description: id parameter for /types/{type_id}/extra_specs/{id}/edit API
in: path
name: id
required: true
schema:
type: string
types_extra_specs_edit_type_id:
description: type_id parameter for /types/{type_id}/extra_specs/{id}/edit
API
in: path
name: type_id
required: true
schema:
type: string
types_extra_specs_id:
description: id parameter for /types/{type_id}/extra_specs/{id} API
in: path
name: id
required: true
schema:
type: string
types_extra_specs_new_type_id:
description: type_id parameter for /types/{type_id}/extra_specs/new API
in: path
name: type_id
required: true
schema:
type: string
types_extra_specs_type_id:
description: type_id parameter for /types/{type_id}/extra_specs/{id} API
in: path
name: type_id
required: true
schema:
type: string
types_id:
description: id parameter for /types/{id} API
in: path
name: id
required: true
schema:
type: string
types_os_share_type_access_id:
description: id parameter for /types/{id}/os-share-type-access API
in: path
name: id
required: true
schema:
type: string
types_share_type_access_id:
description: id parameter for /types/{id}/share_type_access API
in: path
name: id
required: true
schema:
type: string
schemas:
Availability_ZonesListResponse:
additionalProperties: false
properties:
availability_zones:
items:
additionalProperties: false
properties:
created_at:
format: date-time
type: string
id:
format: uuid
type: string
name:
maxLength: 255
minLength: 1
type: string
updated_at:
format: date-time
type:
- 'null'
- string
required: []
type: object
type: array
required:
- availability_zones
type: object
ExtensionShowResponse:
description: Response of the extensions/id:get operation
type: object
ExtensionsCreateRequest:
description: Request of the extensions:post operation
type: object
x-openstack:
action-name: create
ExtensionsCreateResponse:
description: Response of the extensions:post operation
type: object
ExtensionsListResponse:
description: Response of the extensions:get operation
type: object
LimitsListResponse:
description: Response of the limits:get operation
type: object
MessageShowResponse:
additionalProperties: false
properties:
message:
additionalProperties: false
properties:
action_id:
type: string
created_at:
format: date-time
type: string
detail_id:
type: string
expires_at:
format: date-time
type: string
id:
format: uuid
type: string
links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
enum:
- bookmark
- self
type: string
required:
- href
- rel
type: object
type: array
message_level:
enum:
- ERROR
type: string
project_id:
type: string
request_id:
type: string
resource_id:
format: uuid
type: string
resource_type:
type: string
user_message:
type: string
required:
- action_id
- created_at
- detail_id
- expires_at
- id
- links
- message_level
- project_id
- request_id
- resource_id
- resource_type
- user_message
type: object
required:
- message
type: object
MessagesListResponse:
additionalProperties: false
properties:
messages:
items:
additionalProperties: false
properties:
action_id:
type: string
created_at:
format: date-time
type: string
detail_id:
type: string
expires_at:
format: date-time
type: string
id:
format: uuid
type: string
links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
enum:
- bookmark
- self
type: string
required:
- href
- rel
type: object
type: array
message_level:
enum:
- ERROR
type: string
project_id:
type: string
request_id:
type: string
resource_id:
format: uuid
type: string
resource_type:
type: string
user_message:
type: string
required:
- action_id
- created_at
- detail_id
- expires_at
- id
- links
- message_level
- project_id
- request_id
- resource_id
- resource_type
- user_message
type: object
type: array
messages_links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: next
required:
- href
- rel
type: object
maxItems: 1
minItems: 1
type: array
required:
- messages
type: object
Os_Availability_ZoneListResponse:
additionalProperties: false
properties:
availability_zones:
items:
additionalProperties: false
properties:
created_at:
format: date-time
type: string
id:
format: uuid
type: string
name:
maxLength: 255
minLength: 1
type: string
updated_at:
format: date-time
type:
- 'null'
- string
required: []
type: object
type: array
required:
- availability_zones
type: object
Os_Quota_Class_SetShowResponse:
description: Response of the os-quota-class-sets/id:get operation
type: object
Os_Quota_Class_SetUpdateRequest:
description: Request of the os-quota-class-sets/id:put operation
type: object
x-openstack:
action-name: update
Os_Quota_Class_SetUpdateResponse:
description: Response of the os-quota-class-sets/id:put operation
type: object
Os_Quota_SetShowResponse:
description: Response of the os-quota-sets/id:get operation
type: object
Os_Quota_SetUpdateRequest:
description: Request of the os-quota-sets/id:put operation
type: object
x-openstack:
action-name: update
Os_Quota_SetUpdateResponse:
description: Response of the os-quota-sets/id:put operation
type: object
Os_Quota_SetsDefaultsResponse:
description: Response of the os-quota-sets/id/defaults:get operation
type: object
Os_ServiceUpdateRequest:
description: Request of the os-services/id:put operation
type: object
x-openstack:
action-name: update
Os_ServiceUpdateResponse:
description: Response of the os-services/id:put operation
type: object
Os_ServicesListResponse:
description: Response of the os-services:get operation
type: object
Os_Share_ManageCreateRequest:
description: Request of the os-share-manage:post operation
type: object
x-openstack:
action-name: create
Os_Share_ManageCreateResponse:
description: Response of the os-share-manage:post operation
type: object
Os_Share_UnmanageUnmanageResponse:
description: Response of the os-share-unmanage/id/unmanage:post operation
type: object
Os_Share_UnmanageUnmanageUnmanageRequest:
description: Request of the os-share-unmanage/id/unmanage:post operation
type: object
x-openstack:
action-name: unmanage
Quota_Class_SetShowResponse:
description: Response of the quota-class-sets/id:get operation
type: object
Quota_Class_SetUpdateRequest:
description: Request of the quota-class-sets/id:put operation
type: object
x-openstack:
action-name: update
Quota_Class_SetUpdateResponse:
description: Response of the quota-class-sets/id:put operation
type: object
Quota_SetShowResponse:
description: Response of the quota-sets/id:get operation
type: object
Quota_SetUpdateRequest:
description: Request of the quota-sets/id:put operation
type: object
x-openstack:
action-name: update
Quota_SetUpdateResponse:
description: Response of the quota-sets/id:put operation
type: object
Quota_SetsDefaultsResponse:
description: Response of the quota-sets/id/defaults:get operation
type: object
Quota_SetsDetailResponse:
description: Response of the quota-sets/id/detail:get operation
type: object
Resource_LockShowResponse:
additionalProperties: false
properties:
resource_lock:
additionalProperties: false
description: "A resource lock object when making resource lock requests.
All other\nparameters are included in this object.\n"
properties:
created_at:
description: "The date and time stamp when the resource was created
within the service's\ndatabase.\n\nThe date and time stamp format
is `ISO 8601\n<https://en.wikipedia.org/wiki/ISO_8601>`_:\n\n::\n\n\
\ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included,
returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n"
format: date-time
type: string
id:
description: "The UUID identifying the specific resource lock.\n"
format: uuid
type: string
links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
enum:
- bookmark
- self
type: string
required:
- href
- rel
type: object
type: array
lock_context:
description: "The lock creator's context. Resource locks can be created
by users with\ndifferent roles. If a user with ``admin`` role creates
the lock, the value\nof this field is ``admin``. If a user with ``service``
role creates the\nlock, the value of this field is ``service``. For
all other contexts, the\nvalue of this field is ``user``. This field
also determines the user's\nrole that is required to unlock or manipulate
a lock by virtue of the\nservice's default RBAC.\n"
type: string
lock_reason:
description: "A blob of text representing the reason for the specific
resource lock.\n"
type:
- 'null'
- string
project_id:
description: "The ID of the project that the resource lock was created
for.\n"
format: uuid
type: string
resource_action:
description: "The action pertaining to a resource that the resource
lock prevents. For\nexample, if a resource lock prevents deletion
of a share, the value of\n``resource_action`` is ``delete``. Resource
locks are not supported for\nall API actions.\n"
enum:
- delete
- show
type: string
resource_id:
description: "The UUID of the resource that the lock pertains to. For
example, this\ncan be the ID of the share that is locked from deletion.\n"
format: uuid
type: string
resource_type:
description: "The type of resource that the ID in ``resource_id`` denotes.
For\nexample, ``share`` is the resource type that is specified when
the\nresource lock pertains to a share being locked from deletion.
Resource\nlocks are not supported for all resources. Currently support
only\nexists for ``share``.\n"
enum:
- access_rule
- share
type: string
updated_at:
description: "The date and time stamp when the resource was last updated
within the\nservice's database. If a resource was never updated after
it was\ncreated, the value of this parameter is set to ``null``.\n\
\nThe date and time stamp format is `ISO 8601\n<https://en.wikipedia.org/wiki/ISO_8601>`_:\n\
\n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included,
returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n"
format: date-time
type:
- 'null'
- string
user_id:
description: "The ID of the user the resource lock was created for.\n"
format: uuid
type: string
required:
- created_at
- id
- links
- lock_context
- lock_reason
- project_id
- resource_action
- resource_id
- resource_type
- updated_at
- user_id
type: object
required:
- resource_lock
type: object
Resource_LockUpdateResponse:
additionalProperties: false
properties:
resource_lock:
additionalProperties: false
description: "A resource lock object when making resource lock requests.
All other\nparameters are included in this object.\n"
properties:
created_at:
description: "The date and time stamp when the resource was created
within the service's\ndatabase.\n\nThe date and time stamp format
is `ISO 8601\n<https://en.wikipedia.org/wiki/ISO_8601>`_:\n\n::\n\n\
\ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included,
returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n"
format: date-time
type: string
id:
description: "The UUID identifying the specific resource lock.\n"
format: uuid
type: string
links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
enum:
- bookmark
- self
type: string
required:
- href
- rel
type: object
type: array
lock_context:
description: "The lock creator's context. Resource locks can be created
by users with\ndifferent roles. If a user with ``admin`` role creates
the lock, the value\nof this field is ``admin``. If a user with ``service``
role creates the\nlock, the value of this field is ``service``. For
all other contexts, the\nvalue of this field is ``user``. This field
also determines the user's\nrole that is required to unlock or manipulate
a lock by virtue of the\nservice's default RBAC.\n"
type: string
lock_reason:
description: "A blob of text representing the reason for the specific
resource lock.\n"
type:
- 'null'
- string
project_id:
description: "The ID of the project that the resource lock was created
for.\n"
format: uuid
type: string
resource_action:
description: "The action pertaining to a resource that the resource
lock prevents. For\nexample, if a resource lock prevents deletion
of a share, the value of\n``resource_action`` is ``delete``. Resource
locks are not supported for\nall API actions.\n"
enum:
- delete
- show
type: string
resource_id:
description: "The UUID of the resource that the lock pertains to. For
example, this\ncan be the ID of the share that is locked from deletion.\n"
format: uuid
type: string
resource_type:
description: "The type of resource that the ID in ``resource_id`` denotes.
For\nexample, ``share`` is the resource type that is specified when
the\nresource lock pertains to a share being locked from deletion.
Resource\nlocks are not supported for all resources. Currently support
only\nexists for ``share``.\n"
enum:
- access_rule
- share
type: string
updated_at:
description: "The date and time stamp when the resource was last updated
within the\nservice's database. If a resource was never updated after
it was\ncreated, the value of this parameter is set to ``null``.\n\
\nThe date and time stamp format is `ISO 8601\n<https://en.wikipedia.org/wiki/ISO_8601>`_:\n\
\n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included,
returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n"
format: date-time
type:
- 'null'
- string
user_id:
description: "The ID of the user the resource lock was created for.\n"
format: uuid
type: string
required:
- created_at
- id
- links
- lock_context
- lock_reason
- project_id
- resource_action
- resource_id
- resource_type
- updated_at
- user_id
type: object
required:
- resource_lock
type: object
Resource_LockUpdate_281:
additionalProperties: true
properties:
resource_lock:
additionalProperties: false
description: "A resource lock object when making resource lock requests.
All other\nparameters are included in this object.\n"
properties:
lock_reason:
description: "A blob of text representing the reason for the specific
resource lock.\n"
maxLength: 1023
type:
- 'null'
- string
resource_action:
description: "The action pertaining to a resource that the resource
lock prevents. For\nexample, if a resource lock prevents deletion
of a share, the value of\n``resource_action`` is ``delete``. Resource
locks are not supported for\nall API actions.\n"
enum:
-
- delete
- show
type:
- 'null'
- string
type: object
required:
- resource_lock
type: object
x-openstack:
min-ver: '2.81'
Resource_LocksCreateResponse:
additionalProperties: false
properties:
resource_lock:
additionalProperties: false
description: "A resource lock object when making resource lock requests.
All other\nparameters are included in this object.\n"
properties:
created_at:
description: "The date and time stamp when the resource was created
within the service's\ndatabase.\n\nThe date and time stamp format
is `ISO 8601\n<https://en.wikipedia.org/wiki/ISO_8601>`_:\n\n::\n\n\
\ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included,
returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n"
format: date-time
type: string
id:
description: "The UUID identifying the specific resource lock.\n"
format: uuid
type: string
links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
enum:
- bookmark
- self
type: string
required:
- href
- rel
type: object
type: array
lock_context:
description: "The lock creator's context. Resource locks can be created
by users with\ndifferent roles. If a user with ``admin`` role creates
the lock, the value\nof this field is ``admin``. If a user with ``service``
role creates the\nlock, the value of this field is ``service``. For
all other contexts, the\nvalue of this field is ``user``. This field
also determines the user's\nrole that is required to unlock or manipulate
a lock by virtue of the\nservice's default RBAC.\n"
type: string
lock_reason:
description: "A blob of text representing the reason for the specific
resource lock.\n"
type:
- 'null'
- string
project_id:
description: "The ID of the project that the resource lock was created
for.\n"
format: uuid
type: string
resource_action:
description: "The action pertaining to a resource that the resource
lock prevents. For\nexample, if a resource lock prevents deletion
of a share, the value of\n``resource_action`` is ``delete``. Resource
locks are not supported for\nall API actions.\n"
enum:
- delete
- show
type: string
resource_id:
description: "The UUID of the resource that the lock pertains to. For
example, this\ncan be the ID of the share that is locked from deletion.\n"
format: uuid
type: string
resource_type:
description: "The type of resource that the ID in ``resource_id`` denotes.
For\nexample, ``share`` is the resource type that is specified when
the\nresource lock pertains to a share being locked from deletion.
Resource\nlocks are not supported for all resources. Currently support
only\nexists for ``share``.\n"
enum:
- access_rule
- share
type: string
updated_at:
description: "The date and time stamp when the resource was last updated
within the\nservice's database. If a resource was never updated after
it was\ncreated, the value of this parameter is set to ``null``.\n\
\nThe date and time stamp format is `ISO 8601\n<https://en.wikipedia.org/wiki/ISO_8601>`_:\n\
\n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included,
returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n"
format: date-time
type:
- 'null'
- string
user_id:
description: "The ID of the user the resource lock was created for.\n"
format: uuid
type: string
required:
- created_at
- id
- links
- lock_context
- lock_reason
- project_id
- resource_action
- resource_id
- resource_type
- updated_at
- user_id
type: object
required:
- resource_lock
type: object
Resource_LocksCreate_281:
additionalProperties: true
properties:
resource_lock:
additionalProperties: false
description: "A resource lock object when making resource lock requests.
All other\nparameters are included in this object.\n"
properties:
lock_reason:
description: "A blob of text representing the reason for the specific
resource lock.\n"
maxLength: 1023
type:
- 'null'
- string
resource_action:
default: delete
description: "The action pertaining to a resource that the resource
lock prevents. For\nexample, if a resource lock prevents deletion
of a share, the value of\n``resource_action`` is ``delete``. Resource
locks are not supported for\nall API actions. Currently support only
exists for ``delete``, and for\nspecific resources. If not provided,
the value of this parameter\ndefaults to ``delete``.\n"
enum:
-
- delete
- show
type:
- 'null'
- string
resource_id:
description: "The UUID of the resource that the lock pertains to. For
example, this\ncan be the ID of the share that is locked from deletion.\n"
format: uuid
type: string
resource_type:
default: share
description: "The type of resource that the ID in ``resource_id`` denotes.
For\nexample, ``share`` is the resource type that is specified when
the\nresource lock pertains to a share being locked from deletion.
Resource\nlocks are not supported for all resources. Currently support
only\nexists for ``share``.\n"
enum:
-
- access_rule
- share
type:
- 'null'
- string
required:
- resource_id
type: object
required:
- resource_lock
type: object
x-openstack:
min-ver: '2.81'
Resource_LocksListResponse:
additionalProperties: false
properties:
count:
description: "The total count of requested resource before pagination is
applied. This\nparameter is only present in the API response if \"with_count=True\"\
\ is\nsupplied in the query.\n"
type: integer
resource_locks:
items:
additionalProperties: false
description: "A resource lock object when making resource lock requests.
All other\nparameters are included in this object.\n"
properties:
created_at:
description: "The date and time stamp when the resource was created
within the service's\ndatabase.\n\nThe date and time stamp format
is `ISO 8601\n<https://en.wikipedia.org/wiki/ISO_8601>`_:\n\n::\n\
\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included,
returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n"
format: date-time
type: string
id:
description: "The UUID identifying the specific resource lock.\n"
format: uuid
type: string
links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
enum:
- bookmark
- self
type: string
required:
- href
- rel
type: object
type: array
lock_context:
description: "The lock creator's context. Resource locks can be created
by users with\ndifferent roles. If a user with ``admin`` role creates
the lock, the value\nof this field is ``admin``. If a user with
``service`` role creates the\nlock, the value of this field is ``service``.
For all other contexts, the\nvalue of this field is ``user``. This
field also determines the user's\nrole that is required to unlock
or manipulate a lock by virtue of the\nservice's default RBAC.\n"
type: string
lock_reason:
description: "A blob of text representing the reason for the specific
resource lock.\n"
type:
- 'null'
- string
project_id:
description: "The ID of the project that the resource lock was created
for.\n"
format: uuid
type: string
resource_action:
description: "The action pertaining to a resource that the resource
lock prevents. For\nexample, if a resource lock prevents deletion
of a share, the value of\n``resource_action`` is ``delete``. Resource
locks are not supported for\nall API actions.\n"
enum:
- delete
- show
type: string
resource_id:
description: "The UUID of the resource that the lock pertains to.
For example, this\ncan be the ID of the share that is locked from
deletion.\n"
format: uuid
type: string
resource_type:
description: "The type of resource that the ID in ``resource_id``
denotes. For\nexample, ``share`` is the resource type that is specified
when the\nresource lock pertains to a share being locked from deletion.
Resource\nlocks are not supported for all resources. Currently support
only\nexists for ``share``.\n"
enum:
- access_rule
- share
type: string
updated_at:
description: "The date and time stamp when the resource was last updated
within the\nservice's database. If a resource was never updated
after it was\ncreated, the value of this parameter is set to ``null``.\n\
\nThe date and time stamp format is `ISO 8601\n<https://en.wikipedia.org/wiki/ISO_8601>`_:\n\
\n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if
included, returns the time zone as an\noffset from UTC.\n\nFor example,
``2016-12-31T13:14:15-05:00``.\n"
format: date-time
type:
- 'null'
- string
user_id:
description: "The ID of the user the resource lock was created for.\n"
format: uuid
type: string
required:
- created_at
- id
- links
- lock_context
- lock_reason
- project_id
- resource_action
- resource_id
- resource_type
- updated_at
- user_id
type: object
type: array
resource_locks_links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: next
required:
- href
- rel
type: object
maxItems: 1
minItems: 1
type: array
required:
- resource_locks
type: object
RootListResponse:
description: Response of the :get operation
type: object
Scheduler_StatsPoolsDetailPools_DetailResponse:
description: Response of the scheduler-stats/pools/detail:get operation
type: object
Scheduler_StatsPoolsPools_ListResponse:
description: Response of the scheduler-stats/pools:get operation
type: object
Security_ServiceShowResponse:
description: Response of the security-services/id:get operation
type: object
Security_ServiceUpdateRequest:
description: Request of the security-services/id:put operation
type: object
x-openstack:
action-name: update
Security_ServiceUpdateResponse:
description: Response of the security-services/id:put operation
type: object
Security_ServicesCreateRequest:
description: Request of the security-services:post operation
type: object
x-openstack:
action-name: create
Security_ServicesCreateResponse:
description: Response of the security-services:post operation
type: object
Security_ServicesDetailResponse:
description: Response of the security-services/detail:get operation
type: object
Security_ServicesListResponse:
description: Response of the security-services:get operation
type: object
ServiceUpdateRequest:
description: Request of the services/id:put operation
type: object
x-openstack:
action-name: update
ServiceUpdateResponse:
description: Response of the services/id:put operation
type: object
ServicesEnsure_SharesEnsure_SharesRequest:
description: Request of the services/ensure-shares:post operation
type: object
x-openstack:
action-name: ensure_shares
ServicesEnsure_SharesResponse:
description: Response of the services/ensure-shares:post operation
type: object
ServicesListResponse:
description: Response of the services:get operation
type: object
ShareShowResponse:
description: Response of the shares/id:get operation
type: object
ShareUpdateRequest:
description: Request of the shares/id:put operation
type: object
x-openstack:
action-name: update
ShareUpdateResponse:
description: Response of the shares/id:put operation
type: object
Share_Access_RuleShowResponse:
description: Response of the share-access-rules/id:get operation
type: object
Share_Access_RuleUpdateRequest:
description: Request of the share-access-rules/id:put operation
type: object
x-openstack:
action-name: update
Share_Access_RuleUpdateResponse:
description: Response of the share-access-rules/id:put operation
type: object
Share_Access_RulesListResponse:
description: Response of the share-access-rules:get operation
type: object
Share_Access_RulesMetadataUpdateRequest:
description: Request of the share-access-rules/access_id/metadata:put
operation
type: object
x-openstack:
action-name: update
Share_Access_RulesMetadataUpdateResponse:
description: Response of the share-access-rules/access_id/metadata:put
operation
type: object
Share_BackupShowResponse:
description: Response of the share-backups/id:get operation
type: object
Share_BackupUpdateRequest:
description: Request of the share-backups/id:put operation
type: object
x-openstack:
action-name: update
Share_BackupUpdateResponse:
description: Response of the share-backups/id:put operation
type: object
Share_BackupsActionReset_StatusRequest:
description: Empty body for reset_status action
properties:
reset_status:
type: 'null'
type: object
x-openstack:
action-name: reset_status
Share_BackupsActionReset_StatusResponse:
description: Response of the share-backups/id/action:post:reset_status
action
type: object
x-openstack:
action-name: reset_status
Share_BackupsActionRestoreRequest:
description: Empty body for restore action
properties:
restore:
type: 'null'
type: object
x-openstack:
action-name: restore
Share_BackupsActionRestoreResponse:
description: Response of the share-backups/id/action:post:restore action
type: object
x-openstack:
action-name: restore
Share_BackupsCreateRequest:
description: Request of the share-backups:post operation
type: object
x-openstack:
action-name: create
Share_BackupsCreateResponse:
description: Response of the share-backups:post operation
type: object
Share_BackupsDetailResponse:
description: Response of the share-backups/detail:get operation
type: object
Share_BackupsListResponse:
description: Response of the share-backups:get operation
type: object
Share_GroupShowResponse:
description: Response of the share-groups/id:get operation
type: object
Share_GroupUpdateRequest:
description: Request of the share-groups/id:put operation
type: object
x-openstack:
action-name: update
Share_GroupUpdateResponse:
description: Response of the share-groups/id:put operation
type: object
Share_Group_SnapshotShowResponse:
description: Response of the share-group-snapshots/id:get operation
type: object
Share_Group_SnapshotUpdateRequest:
description: Request of the share-group-snapshots/id:put operation
type: object
x-openstack:
action-name: update
Share_Group_SnapshotUpdateResponse:
description: Response of the share-group-snapshots/id:put operation
type: object
Share_Group_SnapshotsActionForce_DeleteRequest:
description: Empty body for force_delete action
properties:
force_delete:
type: 'null'
type: object
x-openstack:
action-name: force_delete
Share_Group_SnapshotsActionForce_DeleteResponse:
description: Response of the
share-group-snapshots/id/action:post:force_delete action
type: object
x-openstack:
action-name: force_delete
Share_Group_SnapshotsActionReset_StatusRequest:
description: Empty body for reset_status action
properties:
reset_status:
type: 'null'
type: object
x-openstack:
action-name: reset_status
Share_Group_SnapshotsActionReset_StatusResponse:
description: Response of the
share-group-snapshots/id/action:post:reset_status action
type: object
x-openstack:
action-name: reset_status
Share_Group_SnapshotsCreateRequest:
description: Request of the share-group-snapshots:post operation
type: object
x-openstack:
action-name: create
Share_Group_SnapshotsCreateResponse:
description: Response of the share-group-snapshots:post operation
type: object
Share_Group_SnapshotsDetailResponse:
description: Response of the share-group-snapshots/detail:get operation
type: object
Share_Group_SnapshotsListResponse:
description: Response of the share-group-snapshots:get operation
type: object
Share_Group_SnapshotsMembersResponse:
description: Response of the share-group-snapshots/id/members:get
operation
type: object
Share_Group_TypeShowResponse:
description: Response of the share-group-types/id:get operation
type: object
Share_Group_TypesAccessShare_Group_Type_AccessResponse:
description: Response of the share-group-types/id/access:get operation
type: object
Share_Group_TypesActionAddprojectaccessRequest:
description: Empty body for addProjectAccess action
properties:
addProjectAccess:
type: 'null'
type: object
x-openstack:
action-name: addProjectAccess
Share_Group_TypesActionAddprojectaccessResponse:
description: Response of the
share-group-types/id/action:post:addProjectAccess action
type: object
x-openstack:
action-name: addProjectAccess
Share_Group_TypesActionCreateRequest:
description: Empty body for create action
properties:
create:
type: 'null'
type: object
x-openstack:
action-name: create
Share_Group_TypesActionCreateResponse:
description: Response of the share-group-types/id/action:post:create
action
type: object
x-openstack:
action-name: create
Share_Group_TypesActionDeleteRequest:
description: Empty body for delete action
properties:
delete:
type: 'null'
type: object
x-openstack:
action-name: delete
Share_Group_TypesActionDeleteResponse:
description: Response of the share-group-types/id/action:post:delete
action
type: object
x-openstack:
action-name: delete
Share_Group_TypesActionRemoveprojectaccessRequest:
description: Empty body for removeProjectAccess action
properties:
removeProjectAccess:
type: 'null'
type: object
x-openstack:
action-name: removeProjectAccess
Share_Group_TypesActionRemoveprojectaccessResponse:
description: Response of the
share-group-types/id/action:post:removeProjectAccess action
type: object
x-openstack:
action-name: removeProjectAccess
Share_Group_TypesCreateRequest:
description: Request of the share-group-types:post operation
type: object
x-openstack:
action-name: create
Share_Group_TypesCreateResponse:
description: Response of the share-group-types:post:create action
type: object
x-openstack:
action-name: create
Share_Group_TypesDefaultResponse:
description: Response of the share-group-types/default:get operation
type: object
Share_Group_TypesGroup_SpecShowResponse:
description: Response of the share-group-types/id/group-specs/key:get
operation
type: object
Share_Group_TypesGroup_SpecUpdateRequest:
description: Request of the share-group-types/id/group-specs/key:put
operation
type: object
x-openstack:
action-name: update
Share_Group_TypesGroup_SpecUpdateResponse:
description: Response of the share-group-types/id/group-specs/key:put
operation
type: object
Share_Group_TypesGroup_SpecsCreateRequest:
description: Request of the share-group-types/id/group-specs:post
operation
type: object
x-openstack:
action-name: create
Share_Group_TypesGroup_SpecsCreateResponse:
description: Response of the share-group-types/id/group-specs:post
operation
type: object
Share_Group_TypesGroup_SpecsListResponse:
description: Response of the share-group-types/id/group-specs:get
operation
type: object
Share_Group_TypesListResponse:
description: Response of the share-group-types:get operation
type: object
Share_GroupsActionForce_DeleteRequest:
description: Empty body for force_delete action
properties:
force_delete:
type: 'null'
type: object
x-openstack:
action-name: force_delete
Share_GroupsActionForce_DeleteResponse:
description: Response of the share-groups/id/action:post:force_delete
action
type: object
x-openstack:
action-name: force_delete
Share_GroupsActionReset_StatusRequest:
description: Empty body for reset_status action
properties:
reset_status:
type: 'null'
type: object
x-openstack:
action-name: reset_status
Share_GroupsActionReset_StatusResponse:
description: Response of the share-groups/id/action:post:reset_status
action
type: object
x-openstack:
action-name: reset_status
Share_GroupsCreateRequest:
description: Request of the share-groups:post operation
type: object
x-openstack:
action-name: create
Share_GroupsCreateResponse:
description: Response of the share-groups:post operation
type: object
Share_GroupsDetailResponse:
description: Response of the share-groups/detail:get operation
type: object
Share_GroupsListResponse:
description: Response of the share-groups:get operation
type: object
Share_InstanceShowResponse:
description: Response of the share_instances/id:get operation
type: object
Share_InstancesActionForce_DeleteRequest:
description: Empty body for force_delete action
properties:
force_delete:
type: 'null'
type: object
x-openstack:
action-name: force_delete
Share_InstancesActionForce_DeleteResponse:
description: Response of the share_instances/id/action:post:force_delete
action
type: object
x-openstack:
action-name: force_delete
Share_InstancesActionOs-Force_DeleteRequest:
description: Empty body for os-force_delete action
properties:
os-force_delete:
type: 'null'
type: object
x-openstack:
action-name: os-force_delete
Share_InstancesActionOs-Force_DeleteResponse:
description: Response of the
share_instances/id/action:post:os-force_delete action
type: object
x-openstack:
action-name: os-force_delete
Share_InstancesActionOs-Reset_StatusRequest:
description: Empty body for os-reset_status action
properties:
os-reset_status:
type: 'null'
type: object
x-openstack:
action-name: os-reset_status
Share_InstancesActionOs-Reset_StatusResponse:
description: Response of the
share_instances/id/action:post:os-reset_status action
type: object
x-openstack:
action-name: os-reset_status
Share_InstancesActionReset_StatusRequest:
description: Empty body for reset_status action
properties:
reset_status:
type: 'null'
type: object
x-openstack:
action-name: reset_status
Share_InstancesActionReset_StatusResponse:
description: Response of the share_instances/id/action:post:reset_status
action
type: object
x-openstack:
action-name: reset_status
Share_InstancesExport_LocationShowResponse:
description: Response of the
share_instances/share_instance_id/export_locations/export_location_uuid:get
operation
type: object
Share_InstancesExport_LocationsListResponse:
description: Response of the
share_instances/share_instance_id/export_locations:get operation
type: object
Share_InstancesListResponse:
description: Response of the share_instances:get operation
type: object
Share_NetworkShowResponse:
description: Response of the share-networks/id:get operation
type: object
Share_NetworkUpdateRequest:
description: Request of the share-networks/id:put operation
type: object
x-openstack:
action-name: update
Share_NetworkUpdateResponse:
description: Response of the share-networks/id:put operation
type: object
Share_NetworksActionAdd_Security_ServiceRequest:
description: Empty body for add_security_service action
properties:
add_security_service:
type: 'null'
type: object
x-openstack:
action-name: add_security_service
Share_NetworksActionAdd_Security_ServiceResponse:
description: Response of the
share-networks/id/action:post:add_security_service action
type: object
x-openstack:
action-name: add_security_service
Share_NetworksActionAdd_Security_Service_CheckRequest:
description: Empty body for add_security_service_check action
properties:
add_security_service_check:
type: 'null'
type: object
x-openstack:
action-name: add_security_service_check
Share_NetworksActionAdd_Security_Service_CheckResponse:
description: Response of the
share-networks/id/action:post:add_security_service_check action
type: object
x-openstack:
action-name: add_security_service_check
Share_NetworksActionRemove_Security_ServiceRequest:
description: Empty body for remove_security_service action
properties:
remove_security_service:
type: 'null'
type: object
x-openstack:
action-name: remove_security_service
Share_NetworksActionRemove_Security_ServiceResponse:
description: Response of the
share-networks/id/action:post:remove_security_service action
type: object
x-openstack:
action-name: remove_security_service
Share_NetworksActionReset_StatusRequest:
description: Empty body for reset_status action
properties:
reset_status:
type: 'null'
type: object
x-openstack:
action-name: reset_status
Share_NetworksActionReset_StatusResponse:
description: Response of the share-networks/id/action:post:reset_status
action
type: object
x-openstack:
action-name: reset_status
Share_NetworksActionShare_Network_Subnet_Create_CheckRequest:
description: Empty body for share_network_subnet_create_check action
properties:
share_network_subnet_create_check:
type: 'null'
type: object
x-openstack:
action-name: share_network_subnet_create_check
Share_NetworksActionShare_Network_Subnet_Create_CheckResponse:
description: Response of the
share-networks/id/action:post:share_network_subnet_create_check action
type: object
x-openstack:
action-name: share_network_subnet_create_check
Share_NetworksActionUpdate_Security_ServiceRequest:
description: Empty body for update_security_service action
properties:
update_security_service:
type: 'null'
type: object
x-openstack:
action-name: update_security_service
Share_NetworksActionUpdate_Security_ServiceResponse:
description: Response of the
share-networks/id/action:post:update_security_service action
type: object
x-openstack:
action-name: update_security_service
Share_NetworksActionUpdate_Security_Service_CheckRequest:
description: Empty body for update_security_service_check action
properties:
update_security_service_check:
type: 'null'
type: object
x-openstack:
action-name: update_security_service_check
Share_NetworksActionUpdate_Security_Service_CheckResponse:
description: Response of the
share-networks/id/action:post:update_security_service_check action
type: object
x-openstack:
action-name: update_security_service_check
Share_NetworksCreateRequest:
description: Request of the share-networks:post operation
type: object
x-openstack:
action-name: create
Share_NetworksCreateResponse:
description: Response of the share-networks:post operation
type: object
Share_NetworksDetailResponse:
description: Response of the share-networks/detail:get operation
type: object
Share_NetworksListResponse:
description: Response of the share-networks:get operation
type: object
Share_NetworksSubnetShowResponse:
description: Response of the
share-networks/share_network_id/subnets/share_network_subnet_id:get
operation
type: object
Share_NetworksSubnetsCreateRequest:
description: Request of the share-networks/share_network_id/subnets:post
operation
type: object
x-openstack:
action-name: create
Share_NetworksSubnetsCreateResponse:
description: Response of the share-networks/share_network_id/subnets:post
operation
type: object
Share_NetworksSubnetsListResponse:
description: Response of the share-networks/share_network_id/subnets:get
operation
type: object
Share_NetworksSubnetsMetadataCreate_MetadataRequest:
description: Request of the
share-networks/share_network_id/subnets/resource_id/metadata:post
operation
type: object
x-openstack:
action-name: create_metadata
Share_NetworksSubnetsMetadataCreate_MetadataResponse:
description: Response of the
share-networks/share_network_id/subnets/resource_id/metadata:post
operation
type: object
Share_NetworksSubnetsMetadataList_MetadataResponse:
description: Response of the
share-networks/share_network_id/subnets/resource_id/metadata:get
operation
type: object
Share_NetworksSubnetsMetadataShow_MetadataResponse:
description: Response of the
share-networks/share_network_id/subnets/resource_id/metadata/key:get
operation
type: object
Share_NetworksSubnetsMetadataUpdate_All_MetadataRequest:
description: Request of the
share-networks/share_network_id/subnets/resource_id/metadata:put
operation
type: object
x-openstack:
action-name: update_all_metadata
Share_NetworksSubnetsMetadataUpdate_All_MetadataResponse:
description: Response of the
share-networks/share_network_id/subnets/resource_id/metadata:put
operation
type: object
Share_NetworksSubnetsMetadataUpdate_Metadata_ItemRequest:
description: Request of the
share-networks/share_network_id/subnets/resource_id/metadata/key:post
operation
type: object
x-openstack:
action-name: update_metadata_item
Share_NetworksSubnetsMetadataUpdate_Metadata_ItemResponse:
description: Response of the
share-networks/share_network_id/subnets/resource_id/metadata/key:post
operation
type: object
Share_ReplicaShowResponse:
description: Response of the share-replicas/id:get operation
type: object
Share_ReplicasActionForce_DeleteRequest:
description: Empty body for force_delete action
properties:
force_delete:
type: 'null'
type: object
x-openstack:
action-name: force_delete
Share_ReplicasActionForce_DeleteResponse:
description: Response of the share-replicas/id/action:post:force_delete
action
type: object
x-openstack:
action-name: force_delete
Share_ReplicasActionPromoteRequest:
description: Empty body for promote action
properties:
promote:
type: 'null'
type: object
x-openstack:
action-name: promote
Share_ReplicasActionPromoteResponse:
description: Response of the share-replicas/id/action:post:promote action
type: object
x-openstack:
action-name: promote
Share_ReplicasActionReset_Replica_StateRequest:
description: Empty body for reset_replica_state action
properties:
reset_replica_state:
type: 'null'
type: object
x-openstack:
action-name: reset_replica_state
Share_ReplicasActionReset_Replica_StateResponse:
description: Response of the
share-replicas/id/action:post:reset_replica_state action
type: object
x-openstack:
action-name: reset_replica_state
Share_ReplicasActionReset_StatusRequest:
description: Empty body for reset_status action
properties:
reset_status:
type: 'null'
type: object
x-openstack:
action-name: reset_status
Share_ReplicasActionReset_StatusResponse:
description: Response of the share-replicas/id/action:post:reset_status
action
type: object
x-openstack:
action-name: reset_status
Share_ReplicasActionResyncRequest:
description: Empty body for resync action
properties:
resync:
type: 'null'
type: object
x-openstack:
action-name: resync
Share_ReplicasActionResyncResponse:
description: Response of the share-replicas/id/action:post:resync action
type: object
x-openstack:
action-name: resync
Share_ReplicasCreateRequest:
description: Request of the share-replicas:post operation
type: object
x-openstack:
action-name: create
Share_ReplicasCreateResponse:
description: Response of the share-replicas:post operation
type: object
Share_ReplicasDetailResponse:
description: Response of the share-replicas/detail:get operation
type: object
Share_ReplicasExport_LocationShowResponse:
description: Response of the
share-replicas/share_replica_id/export-locations/export_location_uuid:get
operation
type: object
Share_ReplicasExport_LocationsListResponse:
description: Response of the
share-replicas/share_replica_id/export-locations:get operation
type: object
Share_ReplicasListResponse:
description: Response of the share-replicas:get operation
type: object
Share_ServerShowResponse:
description: Response of the share-servers/id:get operation
type: object
Share_ServersActionMigration_CancelRequest:
description: Empty body for migration_cancel action
properties:
migration_cancel:
type: 'null'
type: object
x-openstack:
action-name: migration_cancel
Share_ServersActionMigration_CancelResponse:
description: Response of the share-servers/id/action:post:migration_cancel
action
type: object
x-openstack:
action-name: migration_cancel
Share_ServersActionMigration_CheckRequest:
description: Empty body for migration_check action
properties:
migration_check:
type: 'null'
type: object
x-openstack:
action-name: migration_check
Share_ServersActionMigration_CheckResponse:
description: Response of the share-servers/id/action:post:migration_check
action
type: object
x-openstack:
action-name: migration_check
Share_ServersActionMigration_CompleteRequest:
description: Empty body for migration_complete action
properties:
migration_complete:
type: 'null'
type: object
x-openstack:
action-name: migration_complete
Share_ServersActionMigration_CompleteResponse:
description: Response of the
share-servers/id/action:post:migration_complete action
type: object
x-openstack:
action-name: migration_complete
Share_ServersActionMigration_Get_ProgressRequest:
description: Empty body for migration_get_progress action
properties:
migration_get_progress:
type: 'null'
type: object
x-openstack:
action-name: migration_get_progress
Share_ServersActionMigration_Get_ProgressResponse:
description: Response of the
share-servers/id/action:post:migration_get_progress action
type: object
x-openstack:
action-name: migration_get_progress
Share_ServersActionMigration_StartRequest:
description: Empty body for migration_start action
properties:
migration_start:
type: 'null'
type: object
x-openstack:
action-name: migration_start
Share_ServersActionMigration_StartResponse:
description: Response of the share-servers/id/action:post:migration_start
action
type: object
x-openstack:
action-name: migration_start
Share_ServersActionReset_StatusRequest:
description: Empty body for reset_status action
properties:
reset_status:
type: 'null'
type: object
x-openstack:
action-name: reset_status
Share_ServersActionReset_StatusResponse:
description: Response of the share-servers/id/action:post:reset_status
action
type: object
x-openstack:
action-name: reset_status
Share_ServersActionReset_Task_StateRequest:
description: Empty body for reset_task_state action
properties:
reset_task_state:
type: 'null'
type: object
x-openstack:
action-name: reset_task_state
Share_ServersActionReset_Task_StateResponse:
description: Response of the share-servers/id/action:post:reset_task_state
action
type: object
x-openstack:
action-name: reset_task_state
Share_ServersActionUnmanageRequest:
description: Empty body for unmanage action
properties:
unmanage:
type: 'null'
type: object
x-openstack:
action-name: unmanage
Share_ServersActionUnmanageResponse:
description: Response of the share-servers/id/action:post:unmanage action
type: object
x-openstack:
action-name: unmanage
Share_ServersDetailsResponse:
description: Response of the share-servers/id/details:get operation
type: object
Share_ServersListResponse:
description: Response of the share-servers:get operation
type: object
Share_ServersManageManageRequest:
description: Request of the share-servers/manage:post operation
type: object
x-openstack:
action-name: manage
Share_ServersManageResponse:
description: Response of the share-servers/manage:post operation
type: object
Share_TransferShowResponse:
description: Response of the share-transfers/id:get operation
type: object
Share_TransfersAcceptAcceptRequest:
description: Request of the share-transfers/id/accept:post operation
type: object
x-openstack:
action-name: accept
Share_TransfersAcceptResponse:
description: Response of the share-transfers/id/accept:post operation
type: object
Share_TransfersCreateRequest:
description: Request of the share-transfers:post operation
type: object
x-openstack:
action-name: create
Share_TransfersCreateResponse:
description: Response of the share-transfers:post operation
type: object
Share_TransfersDetailResponse:
description: Response of the share-transfers/detail:get operation
type: object
Share_TransfersListResponse:
description: Response of the share-transfers:get operation
type: object
SharesActionAccess_ListRequest:
description: Empty body for access_list action
properties:
access_list:
type: 'null'
type: object
x-openstack:
action-name: access_list
SharesActionAccess_ListResponse:
description: Response of the shares/id/action:post:access_list action
type: object
x-openstack:
action-name: access_list
SharesActionAllow_AccessRequest:
description: Empty body for allow_access action
properties:
allow_access:
type: 'null'
type: object
x-openstack:
action-name: allow_access
SharesActionAllow_AccessResponse:
description: Response of the shares/id/action:post:allow_access action
type: object
x-openstack:
action-name: allow_access
SharesActionDeny_AccessRequest:
description: Empty body for deny_access action
properties:
deny_access:
type: 'null'
type: object
x-openstack:
action-name: deny_access
SharesActionDeny_AccessResponse:
description: Response of the shares/id/action:post:deny_access action
type: object
x-openstack:
action-name: deny_access
SharesActionExtendRequest:
oneOf:
- $ref: '#/components/schemas/SharesActionExtend_264'
- $ref: '#/components/schemas/SharesActionExtend_27'
x-openstack:
action-name: extend
discriminator: microversion
SharesActionExtendResponse:
type: 'null'
x-openstack:
action-name: extend
SharesActionExtend_264:
additionalProperties: false
properties:
extend:
additionalProperties: true
properties:
force:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
new_size:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
required:
- new_size
type: object
required:
- extend
type: object
x-openstack:
action-name: extend
max-ver: '2.63'
min-ver: '2.64'
SharesActionExtend_27:
additionalProperties: false
properties:
extend:
additionalProperties: true
properties:
new_size:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
required:
- new_size
type: object
required:
- extend
type: object
x-openstack:
action-name: extend
max-ver: '2.63'
min-ver: '2.7'
SharesActionExtend_Legacy_20:
additionalProperties: false
properties:
os-extend:
additionalProperties: true
properties:
new_size:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
required:
- new_size
type: object
required:
- os-extend
type: object
x-openstack:
action-name: os-extend
max-ver: '2.6'
min-ver: '2.0'
SharesActionForce_DeleteResponse:
type: 'null'
x-openstack:
action-name: force_delete
SharesActionMigration_CancelResponse:
type: 'null'
x-openstack:
action-name: migration_cancel
SharesActionMigration_Cancel_222:
additionalProperties: false
properties:
migration_cancel: {}
required:
- migration_cancel
type: object
x-openstack:
action-name: migration_cancel
min-ver: '2.22'
SharesActionMigration_CompleteResponse:
type: 'null'
x-openstack:
action-name: migration_complete
SharesActionMigration_Complete_222:
additionalProperties: false
properties:
migration_complete: {}
required:
- migration_complete
type: object
x-openstack:
action-name: migration_complete
min-ver: '2.22'
SharesActionMigration_Get_ProgressResponse:
additionalProperties: false
properties:
details: {}
task_state: {}
total_progress:
max: 100
min: 0
type: integer
required:
- details
- task_state
- total_progress
type: object
x-openstack:
action-name: migration_get_progress
SharesActionMigration_Get_Progress_222:
additionalProperties: false
properties:
migration_get_progress: {}
required:
- migration_get_progress
type: object
x-openstack:
action-name: migration_get_progress
min-ver: '2.22'
SharesActionMigration_StartResponse:
type: 'null'
x-openstack:
action-name: migration_start
SharesActionMigration_Start_229:
additionalProperties: false
properties:
migration_start:
additionalProperties: true
properties:
force_host_assisted_migration:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
host:
type: string
new_share_network_id:
type:
- 'null'
- string
new_share_type_id:
type:
- 'null'
- string
nondisruptive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
preserve_metadata:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
preserve_snapshots:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
writable:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- f
- 'false'
- n
- no
- off
- on
- t
- 'true'
- y
- yes
type:
- boolean
- string
required:
- host
- nondisruptive
- preserve_metadata
- preserve_snapshots
- writable
type: object
required:
- migration_start
type: object
x-openstack:
action-name: migration_start
min-ver: '2.29'
SharesActionOs-Access_ListRequest:
description: Empty body for os-access_list action
properties:
os-access_list:
type: 'null'
type: object
x-openstack:
action-name: os-access_list
SharesActionOs-Access_ListResponse:
description: Response of the shares/id/action:post:os-access_list action
type: object
x-openstack:
action-name: os-access_list
SharesActionOs-Allow_AccessRequest:
description: Empty body for os-allow_access action
properties:
os-allow_access:
type: 'null'
type: object
x-openstack:
action-name: os-allow_access
SharesActionOs-Allow_AccessResponse:
description: Response of the shares/id/action:post:os-allow_access action
type: object
x-openstack:
action-name: os-allow_access
SharesActionOs-Deny_AccessRequest:
description: Empty body for os-deny_access action
properties:
os-deny_access:
type: 'null'
type: object
x-openstack:
action-name: os-deny_access
SharesActionOs-Deny_AccessResponse:
description: Response of the shares/id/action:post:os-deny_access action
type: object
x-openstack:
action-name: os-deny_access
SharesActionOs-ExtendResponse:
type: 'null'
x-openstack:
action-name: os-extend
SharesActionOs-Force_DeleteResponse:
type: 'null'
x-openstack:
action-name: os-force_delete
SharesActionOs-Reset_StatusResponse:
type: 'null'
x-openstack:
action-name: os-reset_status
SharesActionOs-ShrinkResponse:
type: 'null'
x-openstack:
action-name: os-shrink
SharesActionReset_StatusResponse:
type: 'null'
x-openstack:
action-name: reset_status
SharesActionReset_Task_StateResponse:
type: 'null'
x-openstack:
action-name: reset_task_state
SharesActionReset_Task_State_222:
additionalProperties: false
properties:
reset_task_state:
additionalProperties: true
properties:
os-task_state:
enum:
-
- data_copying_cancelled
- data_copying_completed
- data_copying_completing
- data_copying_error
- data_copying_in_progress
- data_copying_starting
- migration_cancelled
- migration_completing
- migration_driver_in_progress
- migration_driver_phase1_done
- migration_error
- migration_in_progress
- migration_starting
- migration_success
type:
- 'null'
- string
task_state:
enum:
-
- data_copying_cancelled
- data_copying_completed
- data_copying_completing
- data_copying_error
- data_copying_in_progress
- data_copying_starting
- migration_cancelled
- migration_completing
- migration_driver_in_progress
- migration_driver_phase1_done
- migration_error
- migration_in_progress
- migration_starting
- migration_success
type:
- 'null'
- string
required: []
type: object
required:
- reset_task_state
type: object
x-openstack:
action-name: reset_task_state
min-ver: '2.22'
SharesActionRestoreResponse:
type: 'null'
x-openstack:
action-name: restore
SharesActionRevertRequest:
description: Empty body for revert action
properties:
revert:
type: 'null'
type: object
x-openstack:
action-name: revert
SharesActionRevertResponse:
description: Response of the shares/id/action:post:revert action
type: object
x-openstack:
action-name: revert
SharesActionShare_Force_Delete_27:
additionalProperties: false
properties:
force_delete: {}
required:
- force_delete
type: object
x-openstack:
action-name: force_delete
min-ver: '2.7'
SharesActionShare_Force_Delete_Legacy_20:
additionalProperties: false
properties:
os-force_delete: {}
required:
- os-force_delete
type: object
x-openstack:
action-name: os-force_delete
max-ver: '2.6'
min-ver: '2.0'
SharesActionShare_Reset_Status_27:
additionalProperties: false
properties:
reset_status:
additionalProperties: true
properties:
os-status:
enum:
- available
- awaiting_transfer
- backup_creating
- backup_restoring
- backup_restoring_error
- creating
- creating_from_snapshot
- deferred_deleting
- deleted
- deleting
- ensuring
- error
- error_deferred_deleting
- error_deleting
- extending
- extending_error
- manage_error
- manage_error_unmanage_starting
- manage_starting
- migrating
- migrating_to
- replication_change
- restoring
- reverting
- reverting_error
- server_migrating
- server_migrating_to
- shrinking
- shrinking_error
- shrinking_possible_data_loss_error
- unmanage_error
- unmanage_starting
- unmanaged
type: string
status:
enum:
- available
- awaiting_transfer
- backup_creating
- backup_restoring
- backup_restoring_error
- creating
- creating_from_snapshot
- deferred_deleting
- deleted
- deleting
- ensuring
- error
- error_deferred_deleting
- error_deleting
- extending
- extending_error
- manage_error
- manage_error_unmanage_starting
- manage_starting
- migrating
- migrating_to
- replication_change
- restoring
- reverting
- reverting_error
- server_migrating
- server_migrating_to
- shrinking
- shrinking_error
- shrinking_possible_data_loss_error
- unmanage_error
- unmanage_starting
- unmanaged
type: string
required: []
type: object
required:
- reset_status
type: object
x-openstack:
action-name: reset_status
min-ver: '2.7'
SharesActionShare_Reset_Status_Legacy_20:
additionalProperties: false
properties:
os-reset_status:
additionalProperties: true
properties:
os-status:
enum:
- available
- awaiting_transfer
- backup_creating
- backup_restoring
- backup_restoring_error
- creating
- creating_from_snapshot
- deferred_deleting
- deleted
- deleting
- ensuring
- error
- error_deferred_deleting
- error_deleting
- extending
- extending_error
- manage_error
- manage_error_unmanage_starting
- manage_starting
- migrating
- migrating_to
- replication_change
- restoring
- reverting
- reverting_error
- server_migrating
- server_migrating_to
- shrinking
- shrinking_error
- shrinking_possible_data_loss_error
- unmanage_error
- unmanage_starting
- unmanaged
type: string
status:
enum:
- available
- awaiting_transfer
- backup_creating
- backup_restoring
- backup_restoring_error
- creating
- creating_from_snapshot
- deferred_deleting
- deleted
- deleting
- ensuring
- error
- error_deferred_deleting
- error_deleting
- extending
- extending_error
- manage_error
- manage_error_unmanage_starting
- manage_starting
- migrating
- migrating_to
- replication_change
- restoring
- reverting
- reverting_error
- server_migrating
- server_migrating_to
- shrinking
- shrinking_error
- shrinking_possible_data_loss_error
- unmanage_error
- unmanage_starting
- unmanaged
type: string
required: []
type: object
required:
- os-reset_status
type: object
x-openstack:
action-name: os-reset_status
max-ver: '2.6'
min-ver: '2.0'
SharesActionShare_Restore_269:
additionalProperties: false
properties:
restore: {}
required:
- restore
type: object
x-openstack:
action-name: restore
min-ver: '2.69'
SharesActionShare_Soft_Delete_269:
additionalProperties: false
properties:
soft_delete: {}
required:
- soft_delete
type: object
x-openstack:
action-name: soft_delete
min-ver: '2.69'
SharesActionShrinkResponse:
type: 'null'
x-openstack:
action-name: shrink
SharesActionShrink_27:
additionalProperties: false
properties:
shrink:
additionalProperties: true
properties:
new_size:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
required:
- new_size
type: object
required:
- shrink
type: object
x-openstack:
action-name: shrink
min-ver: '2.7'
SharesActionShrink_Legacy_20:
additionalProperties: false
properties:
os-shrink:
additionalProperties: true
properties:
new_size:
maximum: 2147483647
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
required:
- new_size
type: object
required:
- os-shrink
type: object
x-openstack:
action-name: os-shrink
max-ver: '2.6'
min-ver: '2.0'
SharesActionSoft_DeleteResponse:
type: 'null'
x-openstack:
action-name: soft_delete
SharesActionUnmanageResponse:
type: 'null'
x-openstack:
action-name: unmanage
SharesActionUnmanage_27:
additionalProperties: false
properties:
unmanage: {}
required:
- unmanage
type: object
x-openstack:
action-name: unmanage
min-ver: '2.7'
SharesCreateRequest:
description: Request of the shares:post operation
type: object
x-openstack:
action-name: create
SharesCreateResponse:
description: Response of the shares:post operation
type: object
SharesDetailResponse:
description: Response of the shares/detail:get operation
type: object
SharesExport_LocationShowResponse:
additionalProperties: false
properties:
export_location:
additionalProperties: false
properties:
created_at:
format: date-time
readonly: true
type: string
x-openstack:
apiref: created_at
id:
readonly: true
type: string
x-openstack:
apiref: export_location_id
is_admin_only:
type: boolean
x-openstack:
apiref: export_location_is_admin_only
path:
type: string
x-openstack:
apiref: export_location_path
preferred:
type: boolean
x-openstack:
apiref: export_location_preferred
share_instance_id:
type: string
x-openstack:
apiref: share_instance_id
updated_at:
format: date-time
readonly: true
type: string
x-openstack:
apiref: updated_at
required:
- created_at
- id
- path
- preferred
- updated_at
type: object
x-openstack:
apiref: export_location
required:
- export_location
type: object
SharesExport_LocationsListResponse:
additionalProperties: false
properties:
export_locations:
items:
additionalProperties: false
properties:
id:
type: string
x-openstack:
apiref: export_location_id
is_admin_only:
type: boolean
x-openstack:
apiref: export_location_is_admin_only
path:
type: string
x-openstack:
apiref: export_location_path
preferred:
type: boolean
x-openstack:
apiref: export_location_preferred
share_instance_id:
type: string
x-openstack:
apiref: share_instance_id
required:
- id
- path
- preferred
type: object
type: array
required:
- export_locations
type: object
x-openstack:
apiref: export_locations
SharesExport_LocationsMetadataCreate_MetadataResponse:
additionalProperties: false
properties:
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type: string
type:
- 'null'
- object
required:
- metadata
type: object
SharesExport_LocationsMetadataCreate_Metadata_287:
additionalProperties: false
properties:
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type: string
type:
- 'null'
- object
required:
- metadata
type: object
x-openstack:
min-ver: '2.87'
SharesExport_LocationsMetadataList_MetadataResponse:
additionalProperties: false
properties:
meta:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type: string
type:
- 'null'
- object
required:
- meta
type: object
SharesExport_LocationsMetadataShow_MetadataResponse:
additionalProperties: false
properties:
meta:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type: string
type:
- 'null'
- object
required:
- meta
type: object
SharesExport_LocationsMetadataUpdate_All_MetadataResponse:
additionalProperties: false
properties:
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type: string
type:
- 'null'
- object
required:
- metadata
type: object
SharesExport_LocationsMetadataUpdate_All_Metadata_287:
additionalProperties: true
properties:
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type: string
type:
- 'null'
- object
required:
- metadata
type: object
x-openstack:
min-ver: '2.87'
SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse:
additionalProperties: false
properties:
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type: string
type:
- 'null'
- object
required:
- metadata
type: object
SharesExport_LocationsMetadataUpdate_Metadata_Item_287:
additionalProperties: true
properties:
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type: string
type:
- 'null'
- object
required:
- metadata
type: object
x-openstack:
min-ver: '2.87'
SharesInstancesGet_Share_InstancesResponse:
description: Response of the shares/share_id/instances:get operation
type: object
SharesListResponse:
description: Response of the shares:get operation
type: object
SharesManageManageRequest:
description: Request of the shares/manage:post operation
type: object
x-openstack:
action-name: manage
SharesManageResponse:
description: Response of the shares/manage:post operation
type: object
SharesMetadataCreate_MetadataRequest:
description: Request of the shares/resource_id/metadata:post operation
type: object
x-openstack:
action-name: create_metadata
SharesMetadataCreate_MetadataResponse:
description: Response of the shares/resource_id/metadata:post operation
type: object
SharesMetadataList_MetadataResponse:
description: Response of the shares/resource_id/metadata:get operation
type: object
SharesMetadataShow_MetadataResponse:
description: Response of the shares/resource_id/metadata/key:get operation
type: object
SharesMetadataUpdate_All_MetadataRequest:
description: Request of the shares/resource_id/metadata:put operation
type: object
x-openstack:
action-name: update_all_metadata
SharesMetadataUpdate_All_MetadataResponse:
description: Response of the shares/resource_id/metadata:put operation
type: object
SharesMetadataUpdate_Metadata_ItemRequest:
description: Request of the shares/resource_id/metadata/key:post operation
type: object
x-openstack:
action-name: update_metadata_item
SharesMetadataUpdate_Metadata_ItemResponse:
description: Response of the shares/resource_id/metadata/key:post
operation
type: object
SnapshotShowResponse:
description: Response of the snapshots/id:get operation
type: object
SnapshotUpdateRequest:
description: Request of the snapshots/id:put operation
type: object
x-openstack:
action-name: update
SnapshotUpdateResponse:
description: Response of the snapshots/id:put operation
type: object
Snapshot_InstanceShowResponse:
description: Response of the snapshot-instances/id:get operation
type: object
Snapshot_InstancesActionReset_StatusRequest:
description: Empty body for reset_status action
properties:
reset_status:
type: 'null'
type: object
x-openstack:
action-name: reset_status
Snapshot_InstancesActionReset_StatusResponse:
description: Response of the
snapshot-instances/id/action:post:reset_status action
type: object
x-openstack:
action-name: reset_status
Snapshot_InstancesDetailResponse:
description: Response of the snapshot-instances/detail:get operation
type: object
Snapshot_InstancesExport_LocationShowResponse:
description: Response of the
snapshot-instances/snapshot_instance_id/export-locations/export_location_id:get
operation
type: object
Snapshot_InstancesExport_LocationsListResponse:
description: Response of the
snapshot-instances/snapshot_instance_id/export-locations:get operation
type: object
Snapshot_InstancesListResponse:
description: Response of the snapshot-instances:get operation
type: object
SnapshotsAccess_ListResponse:
description: Response of the snapshots/snapshot_id/access-list:get
operation
type: object
SnapshotsActionAllow_AccessRequest:
description: Empty body for allow_access action
properties:
allow_access:
type: 'null'
type: object
x-openstack:
action-name: allow_access
SnapshotsActionAllow_AccessResponse:
description: Response of the snapshots/id/action:post:allow_access action
type: object
x-openstack:
action-name: allow_access
SnapshotsActionDeny_AccessRequest:
description: Empty body for deny_access action
properties:
deny_access:
type: 'null'
type: object
x-openstack:
action-name: deny_access
SnapshotsActionDeny_AccessResponse:
description: Response of the snapshots/id/action:post:deny_access action
type: object
x-openstack:
action-name: deny_access
SnapshotsActionForce_DeleteRequest:
description: Empty body for force_delete action
properties:
force_delete:
type: 'null'
type: object
x-openstack:
action-name: force_delete
SnapshotsActionForce_DeleteResponse:
description: Response of the snapshots/id/action:post:force_delete action
type: object
x-openstack:
action-name: force_delete
SnapshotsActionOs-Force_DeleteRequest:
description: Empty body for os-force_delete action
properties:
os-force_delete:
type: 'null'
type: object
x-openstack:
action-name: os-force_delete
SnapshotsActionOs-Force_DeleteResponse:
description: Response of the snapshots/id/action:post:os-force_delete
action
type: object
x-openstack:
action-name: os-force_delete
SnapshotsActionOs-Reset_StatusRequest:
description: Empty body for os-reset_status action
properties:
os-reset_status:
type: 'null'
type: object
x-openstack:
action-name: os-reset_status
SnapshotsActionOs-Reset_StatusResponse:
description: Response of the snapshots/id/action:post:os-reset_status
action
type: object
x-openstack:
action-name: os-reset_status
SnapshotsActionReset_StatusRequest:
description: Empty body for reset_status action
properties:
reset_status:
type: 'null'
type: object
x-openstack:
action-name: reset_status
SnapshotsActionReset_StatusResponse:
description: Response of the snapshots/id/action:post:reset_status action
type: object
x-openstack:
action-name: reset_status
SnapshotsActionUnmanageRequest:
description: Empty body for unmanage action
properties:
unmanage:
type: 'null'
type: object
x-openstack:
action-name: unmanage
SnapshotsActionUnmanageResponse:
description: Response of the snapshots/id/action:post:unmanage action
type: object
x-openstack:
action-name: unmanage
SnapshotsCreateRequest:
description: Request of the snapshots:post operation
type: object
x-openstack:
action-name: create
SnapshotsCreateResponse:
description: Response of the snapshots:post operation
type: object
SnapshotsDetailResponse:
description: Response of the snapshots/detail:get operation
type: object
SnapshotsExport_LocationShowResponse:
description: Response of the
snapshots/snapshot_id/export-locations/export_location_id:get operation
type: object
SnapshotsExport_LocationsListResponse:
description: Response of the snapshots/snapshot_id/export-locations:get
operation
type: object
SnapshotsListResponse:
additionalProperties: false
properties:
count:
minimum: 0
type: integer
share_snapshots_links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: next
required:
- href
- rel
type: object
maxItems: 1
minItems: 1
type: array
snapshots:
items:
additionalProperties: false
properties:
id:
description: The UUID of the snapshot.
type:
- integer
- string
links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
enum:
- bookmark
- self
type: string
required:
- href
- rel
type: object
type: array
name:
description: The user-defined name of the snapshot.
type:
- 'null'
- string
required:
- id
- links
- name
type: object
type: array
required:
- snapshots
type: object
SnapshotsManageManageRequest:
description: Request of the snapshots/manage:post operation
type: object
x-openstack:
action-name: manage
SnapshotsManageResponse:
description: Response of the snapshots/manage:post operation
type: object
SnapshotsMetadataCreate_MetadataRequest:
description: Request of the snapshots/resource_id/metadata:post operation
type: object
x-openstack:
action-name: create_metadata
SnapshotsMetadataCreate_MetadataResponse:
description: Response of the snapshots/resource_id/metadata:post operation
type: object
SnapshotsMetadataList_MetadataResponse:
description: Response of the snapshots/resource_id/metadata:get operation
type: object
SnapshotsMetadataShow_MetadataResponse:
description: Response of the snapshots/resource_id/metadata/key:get
operation
type: object
SnapshotsMetadataUpdate_All_MetadataRequest:
description: Request of the snapshots/resource_id/metadata:put operation
type: object
x-openstack:
action-name: update_all_metadata
SnapshotsMetadataUpdate_All_MetadataResponse:
description: Response of the snapshots/resource_id/metadata:put operation
type: object
SnapshotsMetadataUpdate_Metadata_ItemRequest:
description: Request of the snapshots/resource_id/metadata/key:post
operation
type: object
x-openstack:
action-name: update_metadata_item
SnapshotsMetadataUpdate_Metadata_ItemResponse:
description: Response of the snapshots/resource_id/metadata/key:post
operation
type: object
TypeShowResponse:
description: Response of the types/id:get operation
type: object
TypeUpdateRequest:
description: Request of the types/id:put operation
type: object
x-openstack:
action-name: update
TypeUpdateResponse:
description: Response of the types/id:put:update action
type: object
x-openstack:
action-name: update
TypesActionAddprojectaccessRequest:
description: Empty body for addProjectAccess action
properties:
addProjectAccess:
type: 'null'
type: object
x-openstack:
action-name: addProjectAccess
TypesActionAddprojectaccessResponse:
description: Response of the types/id/action:post:addProjectAccess action
type: object
x-openstack:
action-name: addProjectAccess
TypesActionCreateRequest:
description: Empty body for create action
properties:
create:
type: 'null'
type: object
x-openstack:
action-name: create
TypesActionCreateResponse:
description: Response of the types/id/action:post:create action
type: object
x-openstack:
action-name: create
TypesActionDeleteRequest:
description: Empty body for delete action
properties:
delete:
type: 'null'
type: object
x-openstack:
action-name: delete
TypesActionDeleteResponse:
description: Response of the types/id/action:post:delete action
type: object
x-openstack:
action-name: delete
TypesActionRemoveprojectaccessRequest:
description: Empty body for removeProjectAccess action
properties:
removeProjectAccess:
type: 'null'
type: object
x-openstack:
action-name: removeProjectAccess
TypesActionRemoveprojectaccessResponse:
description: Response of the types/id/action:post:removeProjectAccess
action
type: object
x-openstack:
action-name: removeProjectAccess
TypesActionUpdateRequest:
description: Empty body for update action
properties:
update:
type: 'null'
type: object
x-openstack:
action-name: update
TypesActionUpdateResponse:
description: Response of the types/id/action:post:update action
type: object
x-openstack:
action-name: update
TypesCreateRequest:
description: Request of the types:post operation
type: object
x-openstack:
action-name: create
TypesCreateResponse:
description: Response of the types:post:create action
type: object
x-openstack:
action-name: create
TypesDefaultResponse:
description: Response of the types/default:get operation
type: object
TypesExtra_SpecShowResponse:
description: Response of the types/type_id/extra_specs/id:get operation
type: object
TypesExtra_SpecUpdateRequest:
description: Request of the types/type_id/extra_specs/id:put operation
type: object
x-openstack:
action-name: update
TypesExtra_SpecUpdateResponse:
description: Response of the types/type_id/extra_specs/id:put operation
type: object
TypesExtra_SpecsCreateRequest:
description: Request of the types/type_id/extra_specs:post operation
type: object
x-openstack:
action-name: create
TypesExtra_SpecsCreateResponse:
description: Response of the types/type_id/extra_specs:post operation
type: object
TypesExtra_SpecsListResponse:
description: Response of the types/type_id/extra_specs:get operation
type: object
TypesListResponse:
description: Response of the types:get operation
type: object
TypesOs_Share_Type_AccessOs-Share-Type-AccessResponse:
description: Response of the types/id/os-share-type-access:get operation
type: object
TypesShare_Type_AccessResponse:
description: Response of the types/id/share_type_access:get operation
type: object
securitySchemes:
ApiKeyAuth:
in: header
name: X-Auth-Token
type: apiKey
security:
- ApiKeyAuth: []
tags:
- name: availability-zones
- name: extensions
- name: limits
- name: messages
- name: os-availability-zone
- name: os-quota-class-sets
- name: os-quota-sets
- name: os-services
- name: os-share-manage
- name: os-share-unmanage
- name: quota-class-sets
- name: quota-sets
- name: resource-locks
- name: scheduler-stats
- name: security-services
- name: services
- name: share-access-rules
- name: share-backups
- name: share-group-snapshots
- name: share-group-types
- name: share-groups
- name: share-networks
- name: share-replicas
- name: share-servers
- name: share-transfers
- name: share_instances
- name: shares
- name: snapshot-instances
- name: snapshots
- name: types
- name: version