cinder.api package

Subpackages

• cinder.api.contrib package
  • Submodules
    • cinder.api.contrib.admin_actions module
      • AdminController
      • Admin_actions
      • BackupAdminController
      • SnapshotAdminController
      • VolumeAdminController
    • cinder.api.contrib.availability_zones module
      • Availability_zones
      • Controller
    • cinder.api.contrib.backups module
      • Backups
      • BackupsController
    • cinder.api.contrib.capabilities module
      • Capabilities
      • CapabilitiesController
    • cinder.api.contrib.cgsnapshots module
      • Cgsnapshots
      • CgsnapshotsController
    • cinder.api.contrib.consistencygroups module
      • ConsistencyGroupsController
      • Consistencygroups
    • cinder.api.contrib.extended_services module
      • Extended_services
    • cinder.api.contrib.extended_snapshot_attributes module
      • ExtendedSnapshotAttributesController
      • Extended_snapshot_attributes
    • cinder.api.contrib.hosts module
      • HostController
      • Hosts
      • check_host()
    • cinder.api.contrib.qos_specs_manage module
      • QoSSpecsController
      • Qos_specs_manage
    • cinder.api.contrib.quota_classes module
      • QuotaClassSetsController
      • Quota_classes
    • cinder.api.contrib.quotas module
      • QuotaSetsController
      • Quotas
    • cinder.api.contrib.resource_common_manage module
      • get_manageable_resources()
    • cinder.api.contrib.scheduler_hints module
      • Scheduler_hints
      • create()
    • cinder.api.contrib.scheduler_stats module
      • SchedulerStatsController
      • Scheduler_stats
    • cinder.api.contrib.services module
      • ServiceController
      • Services
    • cinder.api.contrib.snapshot_actions module
      • SnapshotActionsController
      • Snapshot_actions
    • cinder.api.contrib.snapshot_manage module
      • SnapshotManageController
      • Snapshot_manage
    • cinder.api.contrib.snapshot_unmanage module
      • SnapshotUnmanageController
      • Snapshot_unmanage
    • cinder.api.contrib.types_extra_specs module
      • Types_extra_specs
      • VolumeTypeExtraSpecsController
    • cinder.api.contrib.types_manage module
      • Types_manage
      • VolumeTypesManageController
    • cinder.api.contrib.used_limits module
      • UsedLimitsController
      • Used_limits
    • cinder.api.contrib.volume_actions module
      • VolumeActionsController
      • Volume_actions
    • cinder.api.contrib.volume_encryption_metadata module
      • VolumeEncryptionMetadataController
      • Volume_encryption_metadata
    • cinder.api.contrib.volume_host_attribute module
      • VolumeHostAttributeController
      • Volume_host_attribute
    • cinder.api.contrib.volume_image_metadata module
      • VolumeImageMetadataController
      • Volume_image_metadata
    • cinder.api.contrib.volume_manage module
      • VolumeManageController
      • Volume_manage
    • cinder.api.contrib.volume_mig_status_attribute module
      • VolumeMigStatusAttributeController
      • Volume_mig_status_attribute
    • cinder.api.contrib.volume_tenant_attribute module
      • VolumeTenantAttributeController
      • Volume_tenant_attribute
    • cinder.api.contrib.volume_transfer module
      • VolumeTransferController
      • Volume_transfer
    • cinder.api.contrib.volume_type_access module
      • VolumeTypeAccessController
      • VolumeTypeActionController
      • Volume_type_access
    • cinder.api.contrib.volume_type_encryption module
      • VolumeTypeEncryptionController
      • Volume_type_encryption
    • cinder.api.contrib.volume_unmanage module
      • VolumeUnmanageController
      • Volume_unmanage
  • Module contents
    • select_extensions()
    • standard_extensions()
• cinder.api.middleware package
  • Submodules
    • cinder.api.middleware.auth module
      • CinderKeystoneContext
      • InjectContext
      • NoAuthMiddleware
      • NoAuthMiddlewareBase
      • NoAuthMiddlewareIncludeProjectID
      • pipeline_factory()
    • cinder.api.middleware.fault module
      • FaultWrapper
    • cinder.api.middleware.request_id module
      • RequestId
  • Module contents
• cinder.api.openstack package
  • Submodules
    • cinder.api.openstack.api_version_request module
      • APIVersionRequest
      • max_api_version()
      • min_api_version()
    • cinder.api.openstack.versioned_method module
      • VersionedMethod
    • cinder.api.openstack.wsgi module
      • ActionDispatcher
      • Controller
      • ControllerMetaclass
      • DictSerializer
      • Fault
      • JSONDeserializer
      • JSONDictSerializer
      • OverLimitFault
      • Request
      • Resource
      • ResourceExceptionHandler
      • ResponseObject
      • TextDeserializer
      • action()
      • action_peek_json()
      • deserializers()
      • extends()
      • response()
      • serializers()
  • Module contents
    • APIMapper
      • APIMapper.connect()
      • APIMapper.routematch()
    • APIRouter
      • APIRouter.ExtensionManager
      • APIRouter.factory()
    • ProjectMapper
      • ProjectMapper.resource()
• cinder.api.schemas package
  • Submodules
    • cinder.api.schemas.admin_actions module
    • cinder.api.schemas.attachments module
    • cinder.api.schemas.backups module
    • cinder.api.schemas.clusters module
    • cinder.api.schemas.default_types module
    • cinder.api.schemas.group_snapshots module
    • cinder.api.schemas.group_specs module
    • cinder.api.schemas.group_types module
    • cinder.api.schemas.groups module
    • cinder.api.schemas.qos_specs module
    • cinder.api.schemas.quota_classes module
    • cinder.api.schemas.quotas module
    • cinder.api.schemas.scheduler_hints module
    • cinder.api.schemas.services module
    • cinder.api.schemas.snapshot_actions module
    • cinder.api.schemas.snapshot_manage module
    • cinder.api.schemas.snapshots module
    • cinder.api.schemas.types_extra_specs module
    • cinder.api.schemas.volume_actions module
    • cinder.api.schemas.volume_image_metadata module
    • cinder.api.schemas.volume_manage module
    • cinder.api.schemas.volume_metadata module
    • cinder.api.schemas.volume_transfer module
    • cinder.api.schemas.volume_type_access module
    • cinder.api.schemas.volume_type_encryption module
    • cinder.api.schemas.volume_types module
    • cinder.api.schemas.volumes module
    • cinder.api.schemas.workers module
  • Module contents
• cinder.api.v2 package
  • Subpackages
    • cinder.api.v2.views package
      • Submodules
      • Module contents
  • Submodules
    • cinder.api.v2.limits module
      • Limit
      • Limiter
      • LimitsController
      • RateLimitingMiddleware
      • WsgiLimiter
      • WsgiLimiterProxy
      • create_resource()
    • cinder.api.v2.snapshots module
      • SnapshotsController
      • create_resource()
    • cinder.api.v2.volume_metadata module
      • Controller
      • create_resource()
    • cinder.api.v2.volumes module
      • VolumeController
      • create_resource()
  • Module contents
• cinder.api.v3 package
  • Subpackages
    • cinder.api.v3.views package
      • Submodules
      • Module contents
  • Submodules
    • cinder.api.v3.attachments module
      • AttachmentsController
      • create_resource()
    • cinder.api.v3.backups module
      • BackupsController
      • create_resource()
    • cinder.api.v3.clusters module
      • ClusterController
      • create_resource()
    • cinder.api.v3.consistencygroups module
      • ConsistencyGroupsController
      • create_resource()
    • cinder.api.v3.default_types module
      • DefaultTypesController
      • create_resource()
    • cinder.api.v3.group_snapshots module
      • GroupSnapshotsController
      • create_resource()
    • cinder.api.v3.group_specs module
      • GroupTypeSpecsController
      • create_resource()
    • cinder.api.v3.group_types module
      • GroupTypesController
      • create_resource()
    • cinder.api.v3.groups module
      • GroupsController
      • create_resource()
    • cinder.api.v3.limits module
      • LimitsController
      • create_resource()
    • cinder.api.v3.messages module
      • MessagesController
      • create_resource()
    • cinder.api.v3.resource_common_manage module
      • ManageResource
    • cinder.api.v3.resource_filters module
      • ResourceFiltersController
      • create_resource()
    • cinder.api.v3.router module
      • APIRouter
    • cinder.api.v3.snapshot_manage module
      • SnapshotManageController
      • create_resource()
    • cinder.api.v3.snapshot_metadata module
      • Controller
      • create_resource()
    • cinder.api.v3.snapshots module
      • SnapshotsController
      • create_resource()
    • cinder.api.v3.types module
      • VolumeTypesController
      • create_resource()
    • cinder.api.v3.volume_manage module
      • VolumeManageController
      • create_resource()
    • cinder.api.v3.volume_metadata module
      • Controller
      • create_resource()
    • cinder.api.v3.volume_transfer module
      • VolumeTransferController
      • create_resource()
    • cinder.api.v3.volumes module
      • VolumeController
      • create_resource()
    • cinder.api.v3.workers module
      • WorkerController
      • create_resource()
  • Module contents
• cinder.api.validation package
  • Submodules
    • cinder.api.validation.parameter_types module
    • cinder.api.validation.validators module
      • FormatChecker
  • Module contents
    • schema()
• cinder.api.views package
  • Submodules
    • cinder.api.views.availability_zones module
      • ViewBuilder
    • cinder.api.views.backups module
      • ViewBuilder
    • cinder.api.views.capabilities module
      • ViewBuilder
    • cinder.api.views.cgsnapshots module
      • ViewBuilder
    • cinder.api.views.consistencygroups module
      • ViewBuilder
    • cinder.api.views.limits module
      • ViewBuilder
    • cinder.api.views.manageable_snapshots module
      • ViewBuilder
    • cinder.api.views.manageable_volumes module
      • ViewBuilder
    • cinder.api.views.qos_specs module
      • ViewBuilder
    • cinder.api.views.scheduler_stats module
      • ViewBuilder
    • cinder.api.views.snapshots module
      • ViewBuilder
    • cinder.api.views.transfers module
      • ViewBuilder
    • cinder.api.views.types module
      • ViewBuilder
    • cinder.api.views.versions module
      • ViewBuilder
      • get_view_builder()
  • Module contents

Submodules

• cinder.api.api_utils module
  • GenericProjectInfo
  • add_visible_admin_metadata()
  • get_project()
  • is_none_string()
  • remove_invalid_filter_options()
  • validate_integer()
  • validate_project_and_authorize()
  • walk_class_hierarchy()
• cinder.api.common module
  • METADATA_TYPES
    • METADATA_TYPES.image
    • METADATA_TYPES.user
  • ViewBuilder
  • convert_filter_attributes()
  • get_cluster_host()
  • get_enabled_resource_filters()
  • get_pagination_params()
  • get_request_url()
  • get_sort_params()
  • get_time_comparison_operators()
  • limited()
  • process_general_filtering()
  • reject_invalid_filters()
  • remove_version_from_href()
• cinder.api.extensions module
  • ControllerExtension
  • ExtensionDescriptor
    • ExtensionDescriptor.alias
    • ExtensionDescriptor.get_controller_extensions()
    • ExtensionDescriptor.get_resources()
    • ExtensionDescriptor.name
    • ExtensionDescriptor.updated
  • ExtensionManager
    • ExtensionManager.get_controller_extensions()
    • ExtensionManager.get_resources()
    • ExtensionManager.is_loaded()
    • ExtensionManager.load_extension()
    • ExtensionManager.register()
  • ExtensionsResource
    • ExtensionsResource.create()
    • ExtensionsResource.delete()
    • ExtensionsResource.index()
    • ExtensionsResource.show()
  • ResourceExtension
  • extension_authorizer()
  • load_standard_extensions()
• cinder.api.microversions module
  • get_api_version()
  • get_mv_header()
  • get_prior_version()
• cinder.api.urlmap module
  • Accept
    • Accept.best_match()
    • Accept.content_type_params()
  • URLMap
  • parse_list_header()
  • parse_options_header()
  • unquote_header_value()
  • urlmap_factory()
• cinder.api.versions module
  • Versions
    • Versions.ExtensionManager
      • Versions.ExtensionManager.get_controller_extensions()
      • Versions.ExtensionManager.get_resources()
      • Versions.ExtensionManager.is_loaded()
      • Versions.ExtensionManager.load_extension()
      • Versions.ExtensionManager.register()
  • VersionsController
    • VersionsController.all()
    • VersionsController.index()
    • VersionsController.versioned_methods
    • VersionsController.wsgi_actions
    • VersionsController.wsgi_extensions
  • create_resource()

Module contents

root_app_factory(loader, global_conf, **local_conf)