responses:
'201':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
permissions:
items:
type: string
type: array
- required:
+ required: &id001
- cephfs
type: object
pwdExpirationDate:
username:
description: Username
type: string
- required:
+ required: &id002
- token
- username
- permissions
- sso
- pwdUpdateRequired
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ permissions:
+ description: List of permissions acquired
+ properties:
+ cephfs:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: *id001
+ type: object
+ pwdExpirationDate:
+ description: Password expiration date
+ type: string
+ pwdUpdateRequired:
+ description: Is password update required?
+ type: boolean
+ sso:
+ description: Uses single sign on?
+ type: boolean
+ token:
+ description: Authentication Token
+ type: string
+ username:
+ description: Username
+ type: string
+ required: *id002
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
permissions:
items:
type: string
type: array
- required:
+ required: &id003
- cephfs
type: object
pwdUpdateRequired:
username:
description: Username
type: string
- required:
+ required: &id004
- username
- permissions
- sso
- pwdUpdateRequired
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ permissions:
+ description: List of permissions acquired
+ properties:
+ cephfs:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: *id003
+ type: object
+ pwdUpdateRequired:
+ description: Is password update required?
+ type: boolean
+ sso:
+ description: Uses single sign on?
+ type: boolean
+ username:
+ description: Username
+ type: string
+ required: *id004
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v2.0+json:
+ application/json:
schema:
items:
properties:
type: string
type: array
type: object
- required:
+ required: &id005
- value
- pool_name
type: array
+ application/vnd.ceph.api.v2.0+json:
+ schema:
+ items:
+ properties:
+ pool_name:
+ description: pool name
+ type: string
+ value:
+ description: ''
+ items:
+ type: string
+ type: array
+ type: object
+ required: *id005
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
type: string
type: array
type: object
- required:
+ required: &id006
- status
- value
- pool_name
type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ pool_name:
+ description: pool name
+ type: string
+ status:
+ description: ''
+ type: integer
+ value:
+ description: ''
+ items:
+ type: string
+ type: array
+ type: object
+ required: *id006
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
type: string
type: array
type: object
- required:
+ required: &id007
- value
- pool_name
type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ pool_name:
+ description: pool name
+ type: string
+ value:
+ description: ''
+ items:
+ type: string
+ type: array
+ type: object
+ required: *id007
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
mirror_mode:
description: Mirror Mode
type: string
- required:
+ required: &id008
- mirror_mode
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ mirror_mode:
+ description: Mirror Mode
+ type: string
+ required: *id008
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
site_name:
description: Site Name
type: string
- required:
+ required: &id009
- site_name
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ site_name:
+ description: Site Name
+ type: string
+ required: *id009
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
content_data:
items:
type: string
type: array
- required:
+ required: &id010
- name
- health_color
- health
- peer_uuids
type: object
type: array
- required:
+ required: &id011
- daemons
- pools
- image_error
status:
description: ''
type: integer
- required:
+ required: &id012
- site_name
- status
- content_data
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ content_data:
+ description: ''
+ properties:
+ daemons:
+ description: ''
+ items:
+ type: string
+ type: array
+ image_error:
+ description: ''
+ items:
+ type: string
+ type: array
+ image_ready:
+ description: ''
+ items:
+ type: string
+ type: array
+ image_syncing:
+ description: ''
+ items:
+ type: string
+ type: array
+ pools:
+ description: Pools
+ items:
+ properties:
+ health:
+ description: pool health
+ type: string
+ health_color:
+ description: ''
+ type: string
+ mirror_mode:
+ description: status
+ type: string
+ name:
+ description: Pool name
+ type: string
+ peer_uuids:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: *id010
+ type: object
+ type: array
+ required: *id011
+ type: object
+ site_name:
+ description: site name
+ type: string
+ status:
+ description: ''
+ type: integer
+ required: *id012
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
description: ''
type: integer
type: object
- required:
+ required: &id013
- group
- num_images
type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ group:
+ description: group name
+ type: string
+ num_images:
+ description: ''
+ type: integer
+ type: object
+ required: *id013
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
images:
items:
type: object
type: array
- required:
+ required: &id014
- images
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ images:
+ description: List of images in the group with their pool, namespace,
+ and name
+ items:
+ type: object
+ type: array
+ required: *id014
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ properties: {}
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties: {}
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
description: snapshot state
type: integer
type: object
- required:
+ required: &id015
- id
- name
- state
- namespace_type
type: array
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ id:
+ description: snapshot id
+ type: string
+ name:
+ description: snapshot name
+ type: string
+ namespace_type:
+ description: namespace type
+ type: integer
+ state:
+ description: snapshot state
+ type: integer
+ type: object
+ required: *id015
+ type: array
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
'403':
description: Unauthorized access. Please check your permissions.
'500':
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
id:
state:
description: snapshot state
type: integer
- required:
+ required: &id016
- id
- name
- state
- image_snap_name
- image_snaps
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ id:
+ description: snapshot id
+ type: string
+ image_snap_name:
+ description: image snapshot name
+ type: string
+ image_snaps:
+ description: image snapshots
+ items:
+ type: object
+ type: array
+ name:
+ description: snapshot name
+ type: string
+ namespace_type:
+ description: namespace type
+ type: integer
+ state:
+ description: snapshot state
+ type: integer
+ required: *id016
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ properties: {}
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties: {}
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
fs_name:
description: Remote filesystem name
type: string
- required:
+ required: &id017
- client_name
- cluster_name
- fs_name
recovery_count:
description: Number of peer recoveries
type: integer
- required:
+ required: &id018
- failure_count
- recovery_count
type: object
uuid:
description: Peer UUID
type: string
- required:
+ required: &id019
- uuid
- remote
- stats
type: object
type: array
- required:
+ required: &id020
- filesystem_id
- name
- directory_count
type: object
type: array
type: object
- required:
+ required: &id021
- daemon_id
- filesystems
type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ daemon_id:
+ description: Daemon ID
+ type: integer
+ filesystems:
+ description: List of filesystems on daemon
+ items:
+ properties:
+ directory_count:
+ description: Directory count
+ type: integer
+ filesystem_id:
+ description: Filesystem ID
+ type: integer
+ name:
+ description: Filesystem name
+ type: string
+ peers:
+ description: List of peer objects
+ items:
+ properties:
+ remote:
+ description: Remote peer information
+ properties:
+ client_name:
+ description: Ceph client name
+ type: string
+ cluster_name:
+ description: Remote cluster name
+ type: string
+ fs_name:
+ description: Remote filesystem name
+ type: string
+ required: *id017
+ type: object
+ stats:
+ description: Peer statistics
+ properties:
+ failure_count:
+ description: Number of sync failures
+ type: integer
+ recovery_count:
+ description: Number of peer recoveries
+ type: integer
+ required: *id018
+ type: object
+ uuid:
+ description: Peer UUID
+ type: string
+ required: *id019
+ type: object
+ type: array
+ required: *id020
+ type: object
+ type: array
+ type: object
+ required: *id021
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
site_name:
description: Remote site name
type: string
- required:
+ required: &id022
- client_name
- site_name
- fs_name
type: object
type: object
- required:
+ required: &id023
- uuid
type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ uuid:
+ description: Peer ID
+ properties:
+ client_name:
+ description: Ceph client name
+ type: string
+ fs_name:
+ description: File system name
+ type: string
+ site_name:
+ description: Remote site name
+ type: string
+ required: *id022
+ type: object
+ type: object
+ required: *id023
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
max_bytes:
max_files:
description: ''
type: integer
- required:
+ required: &id024
- max_bytes
- max_files
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ max_bytes:
+ description: ''
+ type: integer
+ max_files:
+ description: ''
+ type: integer
+ required: *id024
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
bytes:
subdirs:
description: ''
type: integer
- required:
+ required: &id025
- bytes
- files
- subdirs
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ bytes:
+ description: ''
+ type: integer
+ files:
+ description: ''
+ type: integer
+ subdirs:
+ description: ''
+ type: integer
+ required: *id025
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
description: Config option type
type: string
type: object
- required:
+ required: &id026
- name
- type
- level
- can_update_at_runtime
- flags
type: array
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get Cluster Configuration by name
- tags:
- - ClusterConfiguration
- /api/cluster_conf/{name}:
- delete:
- parameters:
- - in: path
- name: name
- required: true
- schema:
- type: string
- - in: query
- name: section
- required: true
- schema:
- type: string
- responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
- content:
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
+ schema:
+ items:
+ properties:
+ can_update_at_runtime:
+ description: Check if can update at runtime
+ type: boolean
+ daemon_default:
+ description: Daemon specific default value
+ type: string
+ default:
+ description: Default value for the config option
+ type: string
+ desc:
+ description: Description of the configuration
+ type: string
+ enum_values:
+ description: List of enums allowed
+ items:
+ type: string
+ type: array
+ flags:
+ description: List of flags associated
+ items:
+ type: string
+ type: array
+ level:
+ description: Config option level
+ type: string
+ long_desc:
+ description: Elaborated description
+ type: string
+ max:
+ description: Maximum value
+ type: string
+ min:
+ description: Minimum value
+ type: string
+ name:
+ description: Name of the config option
+ type: string
+ see_also:
+ description: Related config options
+ items:
+ type: string
+ type: array
+ services:
+ description: Services associated with the config option
+ items:
+ type: string
+ type: array
+ tags:
+ description: Tags associated with the cluster
+ items:
+ type: string
+ type: array
+ type:
+ description: Config option type
+ type: string
+ type: object
+ required: *id026
+ type: array
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get Cluster Configuration by name
+ tags:
+ - ClusterConfiguration
+ /api/cluster_conf/{name}:
+ delete:
+ parameters:
+ - in: path
+ name: name
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: section
+ required: true
+ schema:
+ type: string
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
tags:
- ClusterConfiguration
get:
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v2.0+json:
+ application/json:
schema:
properties:
max_size:
type:
description: Type of Rule
type: integer
- required:
+ required: &id027
- rule_id
- rule_name
- ruleset
- max_size
- steps
type: object
+ application/vnd.ceph.api.v2.0+json:
+ schema:
+ properties:
+ max_size:
+ description: Maximum size of Rule
+ type: integer
+ min_size:
+ description: Minimum size of Rule
+ type: integer
+ rule_id:
+ description: Rule ID
+ type: integer
+ rule_name:
+ description: Rule Name
+ type: string
+ ruleset:
+ description: RuleSet related to the rule
+ type: integer
+ steps:
+ description: Steps included in the rule
+ items:
+ type: object
+ type: array
+ type:
+ description: Type of Rule
+ type: integer
+ required: *id027
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v2.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
description: ''
type: string
type: object
- required:
+ required: &id028
- crush-failure-domain
- k
- m
- technique
- name
type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ crush-failure-domain:
+ description: ''
+ type: string
+ k:
+ description: Number of data chunks
+ type: integer
+ m:
+ description: Number of coding chunks
+ type: integer
+ name:
+ description: Name of the profile
+ type: string
+ plugin:
+ description: Plugin Info
+ type: string
+ technique:
+ description: ''
+ type: string
+ type: object
+ required: *id028
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
cephfs:
rgw:
description: ''
type: boolean
- required:
+ required: &id029
- rbd
- mirroring
- iscsi
- nfs
- dashboard
type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get List Of Features
- tags:
- - FeatureTogglesEndpoint
- /api/feedback:
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ cephfs:
+ description: ''
+ type: boolean
+ dashboard:
+ description: ''
+ type: boolean
+ iscsi:
+ description: ''
+ type: boolean
+ mirroring:
+ description: ''
+ type: boolean
+ nfs:
+ description: ''
+ type: boolean
+ rbd:
+ description: ''
+ type: boolean
+ rgw:
+ description: ''
+ type: boolean
+ required: *id029
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get List Of Features
+ tags:
+ - FeatureTogglesEndpoint
+ /api/feedback:
get:
description: "\n List all issues details.\n "
parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
instance:
description: grafana instance
type: string
- required:
+ required: &id030
- instance
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ instance:
+ description: grafana instance
+ type: string
+ required: *id030
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
client_perf:
write_op_per_sec:
description: ''
type: integer
- required:
+ required: &id031
- read_bytes_sec
- read_op_per_sec
- recovering_bytes_per_sec
total_used_raw_bytes:
description: ''
type: integer
- required:
+ required: &id032
- total_avail_bytes
- total_bytes
- total_used_raw_bytes
type: object
- required:
+ required: &id033
- stats
type: object
fs_map:
ro_compat:
description: ''
type: string
- required:
+ required: &id034
- compat
- ro_compat
- incompat
up:
description: ''
type: string
- required:
+ required: &id035
- session_autoclose
- balancer
- up
standbys:
description: ''
type: string
- required:
+ required: &id036
- mdsmap
- standbys
type: object
type: array
- required:
+ required: &id037
- filesystems
type: object
health:
status:
description: ''
type: string
- required:
+ required: &id038
- checks
- mutes
- status
up:
description: ''
type: integer
- required:
+ required: &id039
- up
- down
type: object
standbys:
description: ''
type: string
- required:
+ required: &id040
- active_name
- standbys
type: object
mons:
description: ''
type: string
- required:
+ required: &id041
- mons
type: object
quorum:
items:
type: integer
type: array
- required:
+ required: &id042
- monmap
- quorum
type: object
up:
description: ''
type: integer
- required:
+ required: &id043
- in
- up
type: object
type: array
- required:
+ required: &id044
- osds
type: object
pg_info:
num_objects_unfound:
description: ''
type: integer
- required:
+ required: &id045
- num_objects
- num_object_copies
- num_objects_degraded
statuses:
description: ''
type: string
- required:
+ required: &id046
- object_stats
- pgs_per_osd
- statuses
scrub_status:
description: ''
type: string
- required:
+ required: &id047
- client_perf
- df
- fs_map
- rgw
- scrub_status
type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get Cluster's health report with lesser details
- tags:
- - Health
- /api/health/snapshot:
- get:
- parameters: []
- responses:
- '200':
- content:
application/vnd.ceph.api.v1.0+json:
schema:
properties:
- fsid:
- description: Cluster filesystem ID
- type: string
- fsmap:
- description: Filesystem map details
+ client_perf:
+ description: ''
properties:
- num_active:
- description: Number of active mds
+ read_bytes_sec:
+ description: ''
type: integer
- num_standbys:
- description: Standby MDS count
+ read_op_per_sec:
+ description: ''
type: integer
- required:
- - num_active
- - num_standbys
+ recovering_bytes_per_sec:
+ description: ''
+ type: integer
+ write_bytes_sec:
+ description: ''
+ type: integer
+ write_op_per_sec:
+ description: ''
+ type: integer
+ required: *id031
type: object
- health:
- description: Cluster health overview
+ df:
+ description: ''
properties:
- checks:
- description: Health checks keyed by name
+ stats:
+ description: ''
properties:
- <check_name>:
- description: Individual health check object
- properties:
- muted:
- description: Whether the check is muted
- type: boolean
- severity:
- description: Health severity level
- type: string
- summary:
- description: Summary details
- properties:
- count:
- description: Occurrence count
- type: integer
- message:
- description: Human-readable summary
- type: string
- required:
- - message
- - count
- type: object
- required:
- - severity
- - summary
- - muted
- type: object
- required:
- - <check_name>
+ total_avail_bytes:
+ description: ''
+ type: integer
+ total_bytes:
+ description: ''
+ type: integer
+ total_used_raw_bytes:
+ description: ''
+ type: integer
+ required: *id032
type: object
- mutes:
- description: List of muted check names
- items:
- type: string
- type: array
- status:
- description: Overall health status
- type: string
- required:
- - status
- - checks
- - mutes
+ required: *id033
type: object
- mgrmap:
- description: Manager map details
+ fs_map:
+ description: ''
properties:
- num_active:
- description: Number of active managers
- type: integer
- num_standbys:
- description: Standby manager count
- type: integer
- required:
- - num_active
- - num_standbys
- type: object
- monmap:
- description: Monitor map details
+ filesystems:
+ description: ''
+ items:
+ properties:
+ mdsmap:
+ description: ''
+ properties:
+ balancer:
+ description: ''
+ type: string
+ btime:
+ description: ''
+ type: string
+ compat:
+ description: ''
+ properties:
+ compat:
+ description: ''
+ type: string
+ incompat:
+ description: ''
+ type: string
+ ro_compat:
+ description: ''
+ type: string
+ required: *id034
+ type: object
+ created:
+ description: ''
+ type: string
+ damaged:
+ description: ''
+ items:
+ type: integer
+ type: array
+ data_pools:
+ description: ''
+ items:
+ type: integer
+ type: array
+ enabled:
+ description: ''
+ type: boolean
+ epoch:
+ description: ''
+ type: integer
+ ever_allowed_features:
+ description: ''
+ type: integer
+ explicitly_allowed_features:
+ description: ''
+ type: integer
+ failed:
+ description: ''
+ items:
+ type: integer
+ type: array
+ flags:
+ description: ''
+ type: integer
+ fs_name:
+ description: ''
+ type: string
+ in:
+ description: ''
+ items:
+ type: integer
+ type: array
+ info:
+ description: ''
+ type: string
+ last_failure:
+ description: ''
+ type: integer
+ last_failure_osd_epoch:
+ description: ''
+ type: integer
+ max_file_size:
+ description: ''
+ type: integer
+ max_mds:
+ description: ''
+ type: integer
+ metadata_pool:
+ description: ''
+ type: integer
+ modified:
+ description: ''
+ type: string
+ required_client_features:
+ description: ''
+ type: string
+ root:
+ description: ''
+ type: integer
+ session_autoclose:
+ description: ''
+ type: integer
+ session_timeout:
+ description: ''
+ type: integer
+ standby_count_wanted:
+ description: ''
+ type: integer
+ stopped:
+ description: ''
+ items:
+ type: integer
+ type: array
+ tableserver:
+ description: ''
+ type: integer
+ up:
+ description: ''
+ type: string
+ required: *id035
+ type: object
+ standbys:
+ description: ''
+ type: string
+ required: *id036
+ type: object
+ type: array
+ required: *id037
+ type: object
+ health:
+ description: ''
properties:
- num_mons:
- description: Number of monitors
- type: integer
- required:
- - num_mons
+ checks:
+ description: ''
+ type: string
+ mutes:
+ description: ''
+ type: string
+ status:
+ description: ''
+ type: string
+ required: *id038
type: object
- num_hosts:
- description: Count of hosts
+ hosts:
+ description: ''
type: integer
- num_iscsi_gateways:
- description: Iscsi gateways status
+ iscsi_daemons:
+ description: ''
properties:
down:
- description: Count of iSCSI gateways not running
+ description: ''
type: integer
up:
- description: Count of iSCSI gateways running
+ description: ''
type: integer
- required:
- - up
- - down
+ required: *id039
type: object
- num_rgw_gateways:
- description: Count of RGW gateway daemons running
- type: integer
- osdmap:
- description: OSD map details
+ mgr_map:
+ description: ''
properties:
- in:
- description: Number of OSDs in
- type: integer
- num_osds:
- description: Total OSD count
- type: integer
- up:
- description: Number of OSDs up
- type: integer
- required:
- - in
- - up
- - num_osds
+ active_name:
+ description: ''
+ type: string
+ standbys:
+ description: ''
+ type: string
+ required: *id040
type: object
- pgmap:
- description: Placement group map details
+ mon_status:
+ description: ''
properties:
- bytes_total:
- description: Total capacity in bytes
- type: integer
- bytes_used:
- description: Used capacity in bytes
- type: integer
- num_pgs:
- description: Total PG count
- type: integer
- num_pools:
- description: Number of pools
- type: integer
- pgs_by_state:
- description: List of PG counts by state
+ monmap:
+ description: ''
+ properties:
+ mons:
+ description: ''
+ type: string
+ required: *id041
+ type: object
+ quorum:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required: *id042
+ type: object
+ osd_map:
+ description: ''
+ properties:
+ osds:
+ description: ''
items:
properties:
- count:
- description: Count of PGs in this state
+ in:
+ description: ''
type: integer
- state_name:
- description: Placement group state
- type: string
- required:
- - state_name
- - count
+ up:
+ description: ''
+ type: integer
+ required: *id043
type: object
type: array
- required:
- - pgs_by_state
- - num_pools
- - num_pgs
- - bytes_used
- - bytes_total
+ required: *id044
type: object
- required:
- - fsid
- - health
- - monmap
- - osdmap
- - pgmap
- - mgrmap
- - fsmap
- - num_rgw_gateways
- - num_iscsi_gateways
- - num_hosts
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get a quick overview of cluster health at a moment, analogous to the
- ceph status command in CLI.
- tags:
- - Health
- /api/host:
- get:
- parameters:
- - allowEmptyValue: true
- description: Host Sources
- in: query
- name: sources
- schema:
- type: string
- - default: false
- description: Host Facts
- in: query
- name: facts
- schema:
- type: boolean
- - default: 0
- in: query
- name: offset
- schema:
- type: integer
- - default: 5
- in: query
- name: limit
- schema:
- type: integer
- - default: ''
- in: query
- name: search
- schema:
- type: string
- - default: ''
- in: query
- name: sort
- schema:
- type: string
- - default: true
- description: Include Service Instances
- in: query
- name: include_service_instances
- schema:
- type: boolean
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.3+json:
- schema:
- properties:
- addr:
- description: Host address
- type: string
- ceph_version:
- description: Ceph version
- type: string
- hostname:
- description: Hostname
- type: string
- labels:
- description: Labels related to the host
- items:
- type: string
- type: array
- service_instances:
- description: Service instances related to the host
- items:
- properties:
- count:
- description: Number of instances of the service
- type: integer
- type:
- description: type of service
- type: string
- required:
- - type
- - count
- type: object
- type: array
- service_type:
+ pg_info:
description: ''
- type: string
- services:
- description: Services related to the host
- items:
- properties:
- id:
- description: Service Id
- type: string
- type:
- description: type of service
- type: string
- required:
- - type
- - id
- type: object
- type: array
- sources:
- description: Host Sources
properties:
- ceph:
+ object_stats:
description: ''
- type: boolean
- orchestrator:
+ properties:
+ num_object_copies:
+ description: ''
+ type: integer
+ num_objects:
+ description: ''
+ type: integer
+ num_objects_degraded:
+ description: ''
+ type: integer
+ num_objects_misplaced:
+ description: ''
+ type: integer
+ num_objects_unfound:
+ description: ''
+ type: integer
+ required: *id045
+ type: object
+ pgs_per_osd:
description: ''
- type: boolean
- required:
- - ceph
- - orchestrator
+ type: integer
+ statuses:
+ description: ''
+ type: string
+ required: *id046
type: object
- status:
+ pools:
description: ''
type: string
- required:
- - hostname
- - services
- - service_instances
- - ceph_version
- - addr
- - labels
- - service_type
- - sources
- - status
+ rgw:
+ description: ''
+ type: integer
+ scrub_status:
+ description: ''
+ type: string
+ required: *id047
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: List Host Specifications
- tags:
- - Host
- post:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- addr:
- description: Network Address
- type: string
- hostname:
- description: Hostname
- type: string
- labels:
- description: Host Labels
- items:
- type: string
- type: array
- status:
- description: Host Status
- type: string
- required:
- - hostname
- type: object
- responses:
- '201':
- content:
- application/vnd.ceph.api.v0.1+json:
- type: object
- description: Resource created.
- '202':
- content:
- application/vnd.ceph.api.v0.1+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Host
- /api/host/{hostname}:
- delete:
- parameters:
- - in: path
- name: hostname
- required: true
- schema:
- type: string
- responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
+ summary: Get Cluster's health report with lesser details
tags:
- - Host
+ - Health
+ /api/health/snapshot:
get:
- description: "\n Get the specified host.\n :raises: cherrypy.HTTPError:\
- \ If host not found.\n "
- parameters:
- - in: path
- name: hostname
- required: true
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.2+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Host
- put:
- description: "\n Update the specified host.\n Note, this is only\
- \ supported when Ceph Orchestrator is enabled.\n :param hostname: The\
- \ name of the host to be processed.\n :param update_labels: To update\
- \ the labels.\n :param labels: List of labels.\n :param maintenance:\
- \ Enter/Exit maintenance mode.\n :param force: Force enter maintenance\
- \ mode.\n :param drain: Drain host\n "
- parameters:
- - description: Hostname
- in: path
- name: hostname
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- drain:
- default: false
- description: Drain Host
- type: boolean
- force:
- default: false
- description: Force Enter Maintenance
- type: boolean
- labels:
- description: Host Labels
- items:
- type: string
- type: array
- maintenance:
- default: false
- description: Enter/Exit Maintenance
- type: boolean
- update_labels:
- default: false
- description: Update Labels
- type: boolean
- type: object
- responses:
- '200':
- content:
- application/vnd.ceph.api.v0.1+json:
- schema:
- properties: {}
- type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v0.1+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Host
- /api/host/{hostname}/daemons:
- get:
- parameters:
- - in: path
- name: hostname
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Host
- /api/host/{hostname}/devices:
- get:
- parameters:
- - in: path
- name: hostname
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Host
- /api/host/{hostname}/identify_device:
- post:
- description: "\n Identify a device by switching on the device light for\
- \ N seconds.\n :param hostname: The hostname of the device to process.\n\
- \ :param device: The device identifier to process, e.g. ``/dev/dm-0``\
- \ or\n ``ABC1234DEF567-1R1234_ABC8DE0Q``.\n :param duration:\
- \ The duration in seconds how long the LED should flash.\n "
- parameters:
- - in: path
- name: hostname
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- device:
- type: string
- duration:
- type: string
- required:
- - device
- - duration
- type: object
- responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Host
- /api/host/{hostname}/inventory:
- get:
- parameters:
- - description: Hostname
- in: path
- name: hostname
- required: true
- schema:
- type: string
- - allowEmptyValue: true
- description: Trigger asynchronous refresh
- in: query
- name: refresh
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
- addr:
- description: Host address
+ fsid:
+ description: Cluster filesystem ID
type: string
- devices:
- description: Host devices
- items:
- properties:
- available:
- description: If the device can be provisioned to an OSD
- type: boolean
- device_id:
- description: Device's udev ID
- type: string
- human_readable_type:
- description: Device type. ssd or hdd
- type: string
- lsm_data:
- description: ''
- properties:
- errors:
- description: ''
- items:
+ fsmap:
+ description: Filesystem map details
+ properties:
+ num_active:
+ description: Number of active mds
+ type: integer
+ num_standbys:
+ description: Standby MDS count
+ type: integer
+ required: &id048
+ - num_active
+ - num_standbys
+ type: object
+ health:
+ description: Cluster health overview
+ properties:
+ checks:
+ description: Health checks keyed by name
+ properties:
+ <check_name>:
+ description: Individual health check object
+ properties:
+ muted:
+ description: Whether the check is muted
+ type: boolean
+ severity:
+ description: Health severity level
type: string
- type: array
- health:
- description: ''
- type: string
- ledSupport:
- description: ''
- properties:
- FAILstatus:
- description: ''
- type: string
- FAILsupport:
- description: ''
- type: string
- IDENTstatus:
- description: ''
- type: string
- IDENTsupport:
- description: ''
- type: string
- required:
- - IDENTsupport
- - IDENTstatus
- - FAILsupport
- - FAILstatus
- type: object
- linkSpeed:
- description: ''
- type: string
- mediaType:
- description: ''
- type: string
- rpm:
- description: ''
- type: string
- serialNum:
- description: ''
- type: string
- transport:
- description: ''
+ summary:
+ description: Summary details
+ properties:
+ count:
+ description: Occurrence count
+ type: integer
+ message:
+ description: Human-readable summary
+ type: string
+ required: &id049
+ - message
+ - count
+ type: object
+ required: &id050
+ - severity
+ - summary
+ - muted
+ type: object
+ required: &id051
+ - <check_name>
+ type: object
+ mutes:
+ description: List of muted check names
+ items:
+ type: string
+ type: array
+ status:
+ description: Overall health status
+ type: string
+ required: &id052
+ - status
+ - checks
+ - mutes
+ type: object
+ mgrmap:
+ description: Manager map details
+ properties:
+ num_active:
+ description: Number of active managers
+ type: integer
+ num_standbys:
+ description: Standby manager count
+ type: integer
+ required: &id053
+ - num_active
+ - num_standbys
+ type: object
+ monmap:
+ description: Monitor map details
+ properties:
+ num_mons:
+ description: Number of monitors
+ type: integer
+ required: &id054
+ - num_mons
+ type: object
+ num_hosts:
+ description: Count of hosts
+ type: integer
+ num_iscsi_gateways:
+ description: Iscsi gateways status
+ properties:
+ down:
+ description: Count of iSCSI gateways not running
+ type: integer
+ up:
+ description: Count of iSCSI gateways running
+ type: integer
+ required: &id055
+ - up
+ - down
+ type: object
+ num_rgw_gateways:
+ description: Count of RGW gateway daemons running
+ type: integer
+ osdmap:
+ description: OSD map details
+ properties:
+ in:
+ description: Number of OSDs in
+ type: integer
+ num_osds:
+ description: Total OSD count
+ type: integer
+ up:
+ description: Number of OSDs up
+ type: integer
+ required: &id056
+ - in
+ - up
+ - num_osds
+ type: object
+ pgmap:
+ description: Placement group map details
+ properties:
+ bytes_total:
+ description: Total capacity in bytes
+ type: integer
+ bytes_used:
+ description: Used capacity in bytes
+ type: integer
+ num_pgs:
+ description: Total PG count
+ type: integer
+ num_pools:
+ description: Number of pools
+ type: integer
+ pgs_by_state:
+ description: List of PG counts by state
+ items:
+ properties:
+ count:
+ description: Count of PGs in this state
+ type: integer
+ state_name:
+ description: Placement group state
type: string
- required:
- - serialNum
- - transport
- - mediaType
- - rpm
- - linkSpeed
- - health
- - ledSupport
- - errors
+ required: &id057
+ - state_name
+ - count
type: object
- lvs:
- description: ''
- items:
+ type: array
+ required: &id058
+ - pgs_by_state
+ - num_pools
+ - num_pgs
+ - bytes_used
+ - bytes_total
+ type: object
+ required: &id059
+ - fsid
+ - health
+ - monmap
+ - osdmap
+ - pgmap
+ - mgrmap
+ - fsmap
+ - num_rgw_gateways
+ - num_iscsi_gateways
+ - num_hosts
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ fsid:
+ description: Cluster filesystem ID
+ type: string
+ fsmap:
+ description: Filesystem map details
+ properties:
+ num_active:
+ description: Number of active mds
+ type: integer
+ num_standbys:
+ description: Standby MDS count
+ type: integer
+ required: *id048
+ type: object
+ health:
+ description: Cluster health overview
+ properties:
+ checks:
+ description: Health checks keyed by name
+ properties:
+ <check_name>:
+ description: Individual health check object
properties:
- block_uuid:
- description: ''
- type: string
- cluster_fsid:
- description: ''
- type: string
- cluster_name:
- description: ''
- type: string
- name:
- description: ''
- type: string
- osd_fsid:
- description: ''
- type: string
- osd_id:
- description: ''
- type: string
- osdspec_affinity:
- description: ''
- type: string
- type:
- description: ''
+ muted:
+ description: Whether the check is muted
+ type: boolean
+ severity:
+ description: Health severity level
type: string
- required:
- - name
- - osd_id
- - cluster_name
- - type
- - osd_fsid
- - cluster_fsid
- - osdspec_affinity
- - block_uuid
+ summary:
+ description: Summary details
+ properties:
+ count:
+ description: Occurrence count
+ type: integer
+ message:
+ description: Human-readable summary
+ type: string
+ required: *id049
+ type: object
+ required: *id050
type: object
- type: array
- osd_ids:
- description: Device OSD IDs
- items:
- type: integer
- type: array
- path:
- description: Device path
+ required: *id051
+ type: object
+ mutes:
+ description: List of muted check names
+ items:
type: string
- rejected_reasons:
- description: ''
- items:
- type: string
- type: array
- sys_api:
- description: ''
- properties:
- human_readable_size:
- description: ''
- type: string
- locked:
- description: ''
- type: integer
- model:
- description: ''
- type: string
- nr_requests:
- description: ''
- type: string
- partitions:
- description: ''
- properties:
- partition_name:
- description: ''
- properties:
- holders:
- description: ''
- items:
- type: string
- type: array
- human_readable_size:
- description: ''
- type: string
- sectors:
- description: ''
- type: string
- sectorsize:
- description: ''
- type: integer
- size:
- description: ''
- type: integer
- start:
- description: ''
- type: string
- required:
- - start
- - sectors
- - sectorsize
- - size
- - human_readable_size
- - holders
- type: object
- required:
- - partition_name
- type: object
- path:
- description: ''
- type: string
- removable:
- description: ''
- type: string
- rev:
- description: ''
- type: string
- ro:
- description: ''
- type: string
- rotational:
- description: ''
- type: string
- sas_address:
- description: ''
- type: string
- sas_device_handle:
- description: ''
- type: string
- scheduler_mode:
- description: ''
- type: string
- sectors:
- description: ''
- type: integer
- sectorsize:
- description: ''
- type: string
- size:
- description: ''
+ type: array
+ status:
+ description: Overall health status
+ type: string
+ required: *id052
+ type: object
+ mgrmap:
+ description: Manager map details
+ properties:
+ num_active:
+ description: Number of active managers
+ type: integer
+ num_standbys:
+ description: Standby manager count
+ type: integer
+ required: *id053
+ type: object
+ monmap:
+ description: Monitor map details
+ properties:
+ num_mons:
+ description: Number of monitors
+ type: integer
+ required: *id054
+ type: object
+ num_hosts:
+ description: Count of hosts
+ type: integer
+ num_iscsi_gateways:
+ description: Iscsi gateways status
+ properties:
+ down:
+ description: Count of iSCSI gateways not running
+ type: integer
+ up:
+ description: Count of iSCSI gateways running
+ type: integer
+ required: *id055
+ type: object
+ num_rgw_gateways:
+ description: Count of RGW gateway daemons running
+ type: integer
+ osdmap:
+ description: OSD map details
+ properties:
+ in:
+ description: Number of OSDs in
+ type: integer
+ num_osds:
+ description: Total OSD count
+ type: integer
+ up:
+ description: Number of OSDs up
+ type: integer
+ required: *id056
+ type: object
+ pgmap:
+ description: Placement group map details
+ properties:
+ bytes_total:
+ description: Total capacity in bytes
+ type: integer
+ bytes_used:
+ description: Used capacity in bytes
+ type: integer
+ num_pgs:
+ description: Total PG count
+ type: integer
+ num_pools:
+ description: Number of pools
+ type: integer
+ pgs_by_state:
+ description: List of PG counts by state
+ items:
+ properties:
+ count:
+ description: Count of PGs in this state
type: integer
- support_discard:
- description: ''
- type: string
- vendor:
- description: ''
+ state_name:
+ description: Placement group state
type: string
- required:
- - removable
- - ro
- - vendor
- - model
- - rev
- - sas_address
- - sas_device_handle
- - support_discard
- - rotational
- - nr_requests
- - scheduler_mode
- - partitions
- - sectors
- - sectorsize
- - size
- - human_readable_size
- - path
- - locked
+ required: *id057
type: object
- required:
- - rejected_reasons
- - available
- - path
- - sys_api
- - lvs
- - human_readable_type
- - device_id
- - lsm_data
- - osd_ids
- type: object
- type: array
- labels:
- description: Host labels
- items:
- type: string
- type: array
- name:
- description: Hostname
- type: string
- required:
- - name
- - addr
- - devices
- - labels
+ type: array
+ required: *id058
+ type: object
+ required: *id059
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get inventory of a host
+ summary: Get a quick overview of cluster health at a moment, analogous to the
+ ceph status command in CLI.
tags:
- - Host
- /api/host/{hostname}/smart:
+ - Health
+ /api/host:
get:
parameters:
- - in: path
- name: hostname
- required: true
+ - allowEmptyValue: true
+ description: Host Sources
+ in: query
+ name: sources
+ schema:
+ type: string
+ - default: false
+ description: Host Facts
+ in: query
+ name: facts
+ schema:
+ type: boolean
+ - default: 0
+ in: query
+ name: offset
+ schema:
+ type: integer
+ - default: 5
+ in: query
+ name: limit
+ schema:
+ type: integer
+ - default: ''
+ in: query
+ name: search
+ schema:
+ type: string
+ - default: ''
+ in: query
+ name: sort
schema:
type: string
+ - default: true
+ description: Include Service Instances
+ in: query
+ name: include_service_instances
+ schema:
+ type: boolean
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Host
- /api/iscsi/discoveryauth:
- get:
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
- items:
- properties:
- mutual_password:
- description: ''
- type: string
- mutual_user:
- description: ''
- type: string
- password:
- description: password
+ properties:
+ addr:
+ description: Host address
+ type: string
+ ceph_version:
+ description: Ceph version
+ type: string
+ hostname:
+ description: Hostname
+ type: string
+ labels:
+ description: Labels related to the host
+ items:
type: string
- user:
- description: username
+ type: array
+ service_instances:
+ description: Service instances related to the host
+ items:
+ properties:
+ count:
+ description: Number of instances of the service
+ type: integer
+ type:
+ description: type of service
+ type: string
+ required: &id060
+ - type
+ - count
+ type: object
+ type: array
+ service_type:
+ description: ''
+ type: string
+ services:
+ description: Services related to the host
+ items:
+ properties:
+ id:
+ description: Service Id
+ type: string
+ type:
+ description: type of service
+ type: string
+ required: &id061
+ - type
+ - id
+ type: object
+ type: array
+ sources:
+ description: Host Sources
+ properties:
+ ceph:
+ description: ''
+ type: boolean
+ orchestrator:
+ description: ''
+ type: boolean
+ required: &id062
+ - ceph
+ - orchestrator
+ type: object
+ status:
+ description: ''
+ type: string
+ required: &id063
+ - hostname
+ - services
+ - service_instances
+ - ceph_version
+ - addr
+ - labels
+ - service_type
+ - sources
+ - status
+ type: object
+ application/vnd.ceph.api.v1.3+json:
+ schema:
+ properties:
+ addr:
+ description: Host address
+ type: string
+ ceph_version:
+ description: Ceph version
+ type: string
+ hostname:
+ description: Hostname
+ type: string
+ labels:
+ description: Labels related to the host
+ items:
type: string
- type: object
- required:
- - user
- - password
- - mutual_user
- - mutual_password
- type: array
+ type: array
+ service_instances:
+ description: Service instances related to the host
+ items:
+ properties:
+ count:
+ description: Number of instances of the service
+ type: integer
+ type:
+ description: type of service
+ type: string
+ required: *id060
+ type: object
+ type: array
+ service_type:
+ description: ''
+ type: string
+ services:
+ description: Services related to the host
+ items:
+ properties:
+ id:
+ description: Service Id
+ type: string
+ type:
+ description: type of service
+ type: string
+ required: *id061
+ type: object
+ type: array
+ sources:
+ description: Host Sources
+ properties:
+ ceph:
+ description: ''
+ type: boolean
+ orchestrator:
+ description: ''
+ type: boolean
+ required: *id062
+ type: object
+ status:
+ description: ''
+ type: string
+ required: *id063
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get Iscsi discoveryauth Details
+ summary: List Host Specifications
tags:
- - Iscsi
- put:
- parameters:
- - description: Username
- in: query
- name: user
- required: true
- schema:
- type: string
- - description: Password
- in: query
- name: password
- required: true
- schema:
- type: string
- - description: Mutual UserName
- in: query
- name: mutual_user
- required: true
- schema:
- type: string
- - description: Mutual Password
- in: query
- name: mutual_password
- required: true
- schema:
- type: string
+ - Host
+ post:
+ parameters: []
requestBody:
content:
application/json:
schema:
properties:
- mutual_password:
- description: Mutual Password
- type: string
- mutual_user:
- description: Mutual UserName
+ addr:
+ description: Network Address
type: string
- password:
- description: Password
+ hostname:
+ description: Hostname
type: string
- user:
- description: Username
+ labels:
+ description: Host Labels
+ items:
+ type: string
+ type: array
+ status:
+ description: Host Status
type: string
required:
- - user
- - password
- - mutual_user
- - mutual_password
+ - hostname
type: object
responses:
- '200':
+ '201':
content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v0.1+json:
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
- application/vnd.ceph.api.v1.0+json:
- type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v0.1+json:
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Set Iscsi discoveryauth
tags:
- - Iscsi
- /api/iscsi/target:
- get:
- parameters: []
+ - Host
+ /api/host/{hostname}:
+ delete:
+ parameters:
+ - in: path
+ name: hostname
+ required: true
+ schema:
+ type: string
responses:
- '200':
+ '202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
trace.
security:
- jwt: []
tags:
- - IscsiTarget
- post:
- parameters: []
+ - Host
+ get:
+ description: "\n Get the specified host.\n :raises: cherrypy.HTTPError:\
+ \ If host not found.\n "
+ parameters:
+ - in: path
+ name: hostname
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.2+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Host
+ put:
+ description: "\n Update the specified host.\n Note, this is only\
+ \ supported when Ceph Orchestrator is enabled.\n :param hostname: The\
+ \ name of the host to be processed.\n :param update_labels: To update\
+ \ the labels.\n :param labels: List of labels.\n :param maintenance:\
+ \ Enter/Exit maintenance mode.\n :param force: Force enter maintenance\
+ \ mode.\n :param drain: Drain host\n "
+ parameters:
+ - description: Hostname
+ in: path
+ name: hostname
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- acl_enabled:
- type: string
- auth:
- type: string
- clients:
- type: string
- disks:
- type: string
- groups:
- type: string
- portals:
- type: string
- target_controls:
- type: string
- target_iqn:
- type: string
+ drain:
+ default: false
+ description: Drain Host
+ type: boolean
+ force:
+ default: false
+ description: Force Enter Maintenance
+ type: boolean
+ labels:
+ description: Host Labels
+ items:
+ type: string
+ type: array
+ maintenance:
+ default: false
+ description: Enter/Exit Maintenance
+ type: boolean
+ update_labels:
+ default: false
+ description: Update Labels
+ type: boolean
type: object
responses:
- '201':
+ '200':
content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
+ application/json:
+ schema:
+ properties: {}
+ type: object
+ application/vnd.ceph.api.v0.1+json:
+ schema:
+ properties: {}
+ type: object
+ description: Resource updated.
'202':
content:
- application/vnd.ceph.api.v1.0+json:
- type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v0.1+json:
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - IscsiTarget
- /api/iscsi/target/{target_iqn}:
- delete:
+ - Host
+ /api/host/{hostname}/daemons:
+ get:
parameters:
- in: path
- name: target_iqn
+ name: hostname
required: true
schema:
type: string
responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - IscsiTarget
+ - Host
+ /api/host/{hostname}/devices:
get:
parameters:
- in: path
- name: target_iqn
+ name: hostname
required: true
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - IscsiTarget
- put:
+ - Host
+ /api/host/{hostname}/identify_device:
+ post:
+ description: "\n Identify a device by switching on the device light for\
+ \ N seconds.\n :param hostname: The hostname of the device to process.\n\
+ \ :param device: The device identifier to process, e.g. ``/dev/dm-0``\
+ \ or\n ``ABC1234DEF567-1R1234_ABC8DE0Q``.\n :param duration:\
+ \ The duration in seconds how long the LED should flash.\n "
parameters:
- in: path
- name: target_iqn
+ name: hostname
required: true
schema:
type: string
application/json:
schema:
properties:
- acl_enabled:
- type: string
- auth:
- type: string
- clients:
- type: string
- disks:
- type: string
- groups:
- type: string
- new_target_iqn:
- type: string
- portals:
+ device:
type: string
- target_controls:
+ duration:
type: string
+ required:
+ - device
+ - duration
type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - IscsiTarget
- /api/logs/all:
+ - Host
+ /api/host/{hostname}/inventory:
get:
- parameters: []
+ parameters:
+ - description: Hostname
+ in: path
+ name: hostname
+ required: true
+ schema:
+ type: string
+ - allowEmptyValue: true
+ description: Trigger asynchronous refresh
+ in: query
+ name: refresh
+ schema:
+ type: string
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
- audit_log:
- description: Audit log
+ addr:
+ description: Host address
+ type: string
+ devices:
+ description: Host devices
items:
properties:
- addrs:
+ available:
+ description: If the device can be provisioned to an OSD
+ type: boolean
+ device_id:
+ description: Device's udev ID
+ type: string
+ human_readable_type:
+ description: Device type. ssd or hdd
+ type: string
+ lsm_data:
description: ''
properties:
- addrvec:
+ errors:
description: ''
items:
- properties:
- addr:
- description: IP Address
- type: string
- nonce:
- description: ''
- type: integer
- type:
- description: ''
- type: string
- required:
- - type
- - addr
- - nonce
- type: object
+ type: string
type: array
- required:
- - addrvec
+ health:
+ description: ''
+ type: string
+ ledSupport:
+ description: ''
+ properties:
+ FAILstatus:
+ description: ''
+ type: string
+ FAILsupport:
+ description: ''
+ type: string
+ IDENTstatus:
+ description: ''
+ type: string
+ IDENTsupport:
+ description: ''
+ type: string
+ required: &id064
+ - IDENTsupport
+ - IDENTstatus
+ - FAILsupport
+ - FAILstatus
+ type: object
+ linkSpeed:
+ description: ''
+ type: string
+ mediaType:
+ description: ''
+ type: string
+ rpm:
+ description: ''
+ type: string
+ serialNum:
+ description: ''
+ type: string
+ transport:
+ description: ''
+ type: string
+ required: &id065
+ - serialNum
+ - transport
+ - mediaType
+ - rpm
+ - linkSpeed
+ - health
+ - ledSupport
+ - errors
type: object
- channel:
- description: ''
- type: string
- message:
- description: ''
- type: string
- name:
- description: ''
- type: string
- priority:
- description: ''
- type: string
- rank:
+ lvs:
description: ''
+ items:
+ properties:
+ block_uuid:
+ description: ''
+ type: string
+ cluster_fsid:
+ description: ''
+ type: string
+ cluster_name:
+ description: ''
+ type: string
+ name:
+ description: ''
+ type: string
+ osd_fsid:
+ description: ''
+ type: string
+ osd_id:
+ description: ''
+ type: string
+ osdspec_affinity:
+ description: ''
+ type: string
+ type:
+ description: ''
+ type: string
+ required: &id066
+ - name
+ - osd_id
+ - cluster_name
+ - type
+ - osd_fsid
+ - cluster_fsid
+ - osdspec_affinity
+ - block_uuid
+ type: object
+ type: array
+ osd_ids:
+ description: Device OSD IDs
+ items:
+ type: integer
+ type: array
+ path:
+ description: Device path
type: string
- seq:
+ rejected_reasons:
description: ''
- type: integer
- stamp:
+ items:
+ type: string
+ type: array
+ sys_api:
description: ''
- type: string
- required:
- - name
- - rank
- - addrs
- - stamp
- - seq
- - channel
- - priority
- - message
- type: object
- type: array
- clog:
- description: ''
- items:
- type: string
- type: array
- required:
- - clog
- - audit_log
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Display Logs Configuration
- tags:
- - Logs
- /api/mgr/module:
- get:
- description: "\n Get the list of managed modules.\n :return: A\
- \ list of objects with the fields 'enabled', 'name' and 'options'.\n \
- \ :rtype: list\n "
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- schema:
- items:
- properties:
- always_on:
- description: Is it an always on module?
- type: boolean
- enabled:
- description: Is Module Enabled
- type: boolean
- name:
- description: Module Name
- type: string
- options:
- description: Module Options
- properties:
- Option_name:
- description: Options
properties:
- default_value:
- description: Default value for the option
- type: integer
- desc:
- description: Description of the option
+ human_readable_size:
+ description: ''
type: string
- enum_allowed:
+ locked:
description: ''
- items:
- type: string
- type: array
- flags:
- description: List of flags associated
type: integer
- level:
- description: Option level
+ model:
+ description: ''
type: string
- long_desc:
- description: Elaborated description
+ nr_requests:
+ description: ''
type: string
- max:
- description: Maximum value
+ partitions:
+ description: ''
+ properties:
+ partition_name:
+ description: ''
+ properties:
+ holders:
+ description: ''
+ items:
+ type: string
+ type: array
+ human_readable_size:
+ description: ''
+ type: string
+ sectors:
+ description: ''
+ type: string
+ sectorsize:
+ description: ''
+ type: integer
+ size:
+ description: ''
+ type: integer
+ start:
+ description: ''
+ type: string
+ required: &id067
+ - start
+ - sectors
+ - sectorsize
+ - size
+ - human_readable_size
+ - holders
+ type: object
+ required: &id068
+ - partition_name
+ type: object
+ path:
+ description: ''
type: string
- min:
- description: Minimum value
+ removable:
+ description: ''
type: string
- name:
- description: Name of the option
+ rev:
+ description: ''
type: string
- see_also:
- description: Related options
- items:
- type: string
- type: array
- tags:
- description: Tags associated with the option
- items:
- type: string
- type: array
- type:
- description: Type of the option
+ ro:
+ description: ''
type: string
- required:
- - name
- - type
- - level
- - flags
- - default_value
- - min
- - max
- - enum_allowed
- - desc
- - long_desc
- - tags
- - see_also
+ rotational:
+ description: ''
+ type: string
+ sas_address:
+ description: ''
+ type: string
+ sas_device_handle:
+ description: ''
+ type: string
+ scheduler_mode:
+ description: ''
+ type: string
+ sectors:
+ description: ''
+ type: integer
+ sectorsize:
+ description: ''
+ type: string
+ size:
+ description: ''
+ type: integer
+ support_discard:
+ description: ''
+ type: string
+ vendor:
+ description: ''
+ type: string
+ required: &id069
+ - removable
+ - ro
+ - vendor
+ - model
+ - rev
+ - sas_address
+ - sas_device_handle
+ - support_discard
+ - rotational
+ - nr_requests
+ - scheduler_mode
+ - partitions
+ - sectors
+ - sectorsize
+ - size
+ - human_readable_size
+ - path
+ - locked
type: object
- required:
- - Option_name
+ required: &id070
+ - rejected_reasons
+ - available
+ - path
+ - sys_api
+ - lvs
+ - human_readable_type
+ - device_id
+ - lsm_data
+ - osd_ids
type: object
- type: object
- required:
+ type: array
+ labels:
+ description: Host labels
+ items:
+ type: string
+ type: array
+ name:
+ description: Hostname
+ type: string
+ required: &id071
- name
- - enabled
- - always_on
- - options
- type: array
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: List Mgr modules
- tags:
- - MgrModule
- /api/mgr/module/{module_name}:
- get:
- description: "\n Retrieve the values of the persistent configuration\
- \ settings.\n :param module_name: The name of the Ceph Mgr module.\n\
- \ :type module_name: str\n :return: The values of the module\
- \ options.\n :rtype: dict\n "
- parameters:
- - in: path
- name: module_name
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - MgrModule
- put:
- description: "\n Set the values of the persistent configuration settings.\n\
- \ :param module_name: The name of the Ceph Mgr module.\n :type\
- \ module_name: str\n :param config: The values of the module options\
- \ to be stored.\n :type config: dict\n "
- parameters:
- - in: path
- name: module_name
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- config:
- type: string
- required:
- - config
- type: object
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - MgrModule
- /api/mgr/module/{module_name}/disable:
- post:
- description: "\n Disable the specified Ceph Mgr module.\n :param\
- \ module_name: The name of the Ceph Mgr module.\n :type module_name:\
- \ str\n "
- parameters:
- - in: path
- name: module_name
- required: true
- schema:
- type: string
- responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - MgrModule
- /api/mgr/module/{module_name}/enable:
- post:
- description: "\n Enable the specified Ceph Mgr module.\n :param\
- \ module_name: The name of the Ceph Mgr module.\n :type module_name:\
- \ str\n "
- parameters:
- - in: path
- name: module_name
- required: true
- schema:
- type: string
- responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - MgrModule
- /api/mgr/module/{module_name}/options:
- get:
- description: "\n Get the module options of the specified Ceph Mgr module.\n\
- \ :param module_name: The name of the Ceph Mgr module.\n :type\
- \ module_name: str\n :return: The module options as list of dicts.\n\
- \ :rtype: list\n "
- parameters:
- - in: path
- name: module_name
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - MgrModule
- /api/monitor:
- get:
- parameters: []
- responses:
- '200':
- content:
+ - addr
+ - devices
+ - labels
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties:
- in_quorum:
- description: ''
+ addr:
+ description: Host address
+ type: string
+ devices:
+ description: Host devices
items:
properties:
- addr:
- description: ''
- type: string
- name:
- description: ''
+ available:
+ description: If the device can be provisioned to an OSD
+ type: boolean
+ device_id:
+ description: Device's udev ID
type: string
- priority:
- description: ''
- type: integer
- public_addr:
- description: ''
+ human_readable_type:
+ description: Device type. ssd or hdd
type: string
- public_addrs:
+ lsm_data:
description: ''
properties:
- addrvec:
+ errors:
description: ''
items:
- properties:
- addr:
- description: ''
- type: string
- nonce:
- description: ''
- type: integer
- type:
- description: ''
- type: string
- required:
- - type
- - addr
- - nonce
- type: object
+ type: string
type: array
- required:
- - addrvec
- type: object
- rank:
- description: ''
- type: integer
- stats:
- description: ''
- properties:
- num_sessions:
+ health:
+ description: ''
+ type: string
+ ledSupport:
description: ''
- items:
- type: integer
- type: array
- required:
- - num_sessions
- type: object
- weight:
- description: ''
- type: integer
- required:
- - rank
- - name
- - public_addrs
- - addr
- - public_addr
- - priority
- - weight
- - stats
- type: object
- type: array
- mon_status:
- description: ''
- properties:
- election_epoch:
- description: ''
- type: integer
- extra_probe_peers:
- description: ''
- items:
- type: string
- type: array
- feature_map:
- description: ''
- properties:
- client:
- description: ''
- items:
- properties:
- features:
- description: ''
- type: string
- num:
- description: ''
- type: integer
- release:
- description: ''
- type: string
- required:
- - features
- - release
- - num
- type: object
- type: array
- mds:
- description: ''
- items:
- properties:
- features:
- description: ''
- type: string
- num:
- description: ''
- type: integer
- release:
- description: ''
- type: string
- required:
- - features
- - release
- - num
- type: object
- type: array
- mgr:
- description: ''
- items:
properties:
- features:
+ FAILstatus:
description: ''
type: string
- num:
- description: ''
- type: integer
- release:
+ FAILsupport:
description: ''
type: string
- required:
- - features
- - release
- - num
- type: object
- type: array
- mon:
- description: ''
- items:
- properties:
- features:
+ IDENTstatus:
description: ''
type: string
- num:
- description: ''
- type: integer
- release:
+ IDENTsupport:
description: ''
type: string
- required:
- - features
- - release
- - num
+ required: *id064
type: object
- type: array
- required:
- - mon
- - mds
- - client
- - mgr
- type: object
- features:
- description: ''
- properties:
- quorum_con:
- description: ''
- type: string
- quorum_mon:
- description: ''
- items:
+ linkSpeed:
+ description: ''
type: string
- type: array
- required_con:
- description: ''
- type: string
- required_mon:
- description: ''
- items:
- type: integer
- type: array
- required:
- - required_con
- - required_mon
- - quorum_con
- - quorum_mon
- type: object
- monmap:
- description: ''
- properties:
- created:
- description: ''
- type: string
- epoch:
- description: ''
- type: integer
- features:
- description: ''
+ mediaType:
+ description: ''
+ type: string
+ rpm:
+ description: ''
+ type: string
+ serialNum:
+ description: ''
+ type: string
+ transport:
+ description: ''
+ type: string
+ required: *id065
+ type: object
+ lvs:
+ description: ''
+ items:
properties:
- optional:
+ block_uuid:
description: ''
- items:
- type: string
- type: array
- persistent:
+ type: string
+ cluster_fsid:
description: ''
- items:
- type: string
- type: array
- required:
- - persistent
- - optional
- type: object
- fsid:
- description: ''
- type: string
- min_mon_release:
- description: ''
+ type: string
+ cluster_name:
+ description: ''
+ type: string
+ name:
+ description: ''
+ type: string
+ osd_fsid:
+ description: ''
+ type: string
+ osd_id:
+ description: ''
+ type: string
+ osdspec_affinity:
+ description: ''
+ type: string
+ type:
+ description: ''
+ type: string
+ required: *id066
+ type: object
+ type: array
+ osd_ids:
+ description: Device OSD IDs
+ items:
type: integer
- min_mon_release_name:
- description: ''
- type: string
- modified:
- description: ''
+ type: array
+ path:
+ description: Device path
+ type: string
+ rejected_reasons:
+ description: ''
+ items:
type: string
- mons:
- description: ''
- items:
+ type: array
+ sys_api:
+ description: ''
+ properties:
+ human_readable_size:
+ description: ''
+ type: string
+ locked:
+ description: ''
+ type: integer
+ model:
+ description: ''
+ type: string
+ nr_requests:
+ description: ''
+ type: string
+ partitions:
+ description: ''
properties:
- addr:
- description: ''
- type: string
- name:
- description: ''
- type: string
- priority:
- description: ''
- type: integer
- public_addr:
- description: ''
- type: string
- public_addrs:
+ partition_name:
description: ''
properties:
- addrvec:
+ holders:
description: ''
items:
- properties:
- addr:
- description: ''
- type: string
- nonce:
- description: ''
- type: integer
- type:
- description: ''
- type: string
- required:
- - type
- - addr
- - nonce
- type: object
+ type: string
type: array
- required:
- - addrvec
- type: object
- rank:
- description: ''
- type: integer
- stats:
- description: ''
- properties:
- num_sessions:
+ human_readable_size:
description: ''
- items:
- type: integer
- type: array
- required:
- - num_sessions
+ type: string
+ sectors:
+ description: ''
+ type: string
+ sectorsize:
+ description: ''
+ type: integer
+ size:
+ description: ''
+ type: integer
+ start:
+ description: ''
+ type: string
+ required: *id067
type: object
- weight:
- description: ''
- type: integer
- required:
- - rank
- - name
- - public_addrs
- - addr
- - public_addr
- - priority
- - weight
- - stats
+ required: *id068
type: object
- type: array
- required:
- - epoch
- - fsid
- - modified
- - created
- - min_mon_release
- - min_mon_release_name
- - features
- - mons
- type: object
- name:
- description: ''
- type: string
- outside_quorum:
- description: ''
- items:
- type: string
- type: array
- quorum:
- description: ''
- items:
- type: integer
- type: array
- quorum_age:
- description: ''
- type: integer
- rank:
- description: ''
- type: integer
- state:
- description: ''
- type: string
- sync_provider:
- description: ''
- items:
- type: string
- type: array
- required:
- - name
- - rank
- - state
- - election_epoch
- - quorum
- - quorum_age
- - features
- - outside_quorum
- - extra_probe_peers
- - sync_provider
- - monmap
- - feature_map
- type: object
- out_quorum:
- description: ''
+ path:
+ description: ''
+ type: string
+ removable:
+ description: ''
+ type: string
+ rev:
+ description: ''
+ type: string
+ ro:
+ description: ''
+ type: string
+ rotational:
+ description: ''
+ type: string
+ sas_address:
+ description: ''
+ type: string
+ sas_device_handle:
+ description: ''
+ type: string
+ scheduler_mode:
+ description: ''
+ type: string
+ sectors:
+ description: ''
+ type: integer
+ sectorsize:
+ description: ''
+ type: string
+ size:
+ description: ''
+ type: integer
+ support_discard:
+ description: ''
+ type: string
+ vendor:
+ description: ''
+ type: string
+ required: *id069
+ type: object
+ required: *id070
+ type: object
+ type: array
+ labels:
+ description: Host labels
items:
- type: integer
+ type: string
type: array
- required:
- - mon_status
- - in_quorum
- - out_quorum
+ name:
+ description: Hostname
+ type: string
+ required: *id071
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get Monitor Details
+ summary: Get inventory of a host
tags:
- - Monitor
- /api/multi-cluster/auth:
- post:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- cluster_alias:
- type: string
- hub_url:
- type: string
- password:
- type: string
- ssl_certificate:
- type: string
- ssl_verify:
- default: false
- type: boolean
- ttl:
- type: string
- url:
- type: string
- username:
- type: string
- required:
- - url
- - cluster_alias
- - username
- type: object
+ - Host
+ /api/host/{hostname}/smart:
+ get:
+ parameters:
+ - in: path
+ name: hostname
+ required: true
+ schema:
+ type: string
responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Authenticate to a remote cluster
tags:
- - Multi-cluster
- /api/multi-cluster/check_token_status:
+ - Host
+ /api/iscsi/discoveryauth:
get:
parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ items:
+ properties:
+ mutual_password:
+ description: ''
+ type: string
+ mutual_user:
+ description: ''
+ type: string
+ password:
+ description: password
+ type: string
+ user:
+ description: username
+ type: string
+ type: object
+ required: &id072
+ - user
+ - password
+ - mutual_user
+ - mutual_password
+ type: array
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ items:
+ properties:
+ mutual_password:
+ description: ''
+ type: string
+ mutual_user:
+ description: ''
+ type: string
+ password:
+ description: password
+ type: string
+ user:
+ description: username
+ type: string
+ type: object
+ required: *id072
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Get Iscsi discoveryauth Details
tags:
- - Multi-cluster
- /api/multi-cluster/delete_cluster/{cluster_name}/{cluster_user}:
- delete:
+ - Iscsi
+ put:
parameters:
- - in: path
- name: cluster_name
+ - description: Username
+ in: query
+ name: user
required: true
schema:
type: string
- - in: path
- name: cluster_user
+ - description: Password
+ in: query
+ name: password
+ required: true
+ schema:
+ type: string
+ - description: Mutual UserName
+ in: query
+ name: mutual_user
+ required: true
+ schema:
+ type: string
+ - description: Mutual Password
+ in: query
+ name: mutual_password
required: true
schema:
type: string
- responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Multi-cluster
- /api/multi-cluster/edit_cluster:
- put:
- parameters: []
requestBody:
content:
application/json:
schema:
properties:
- cluster_alias:
- type: string
- name:
+ mutual_password:
+ description: Mutual Password
type: string
- ssl_certificate:
+ mutual_user:
+ description: Mutual UserName
type: string
- url:
+ password:
+ description: Password
type: string
- username:
+ user:
+ description: Username
type: string
- verify:
- default: false
- type: boolean
required:
- - name
- - url
- - cluster_alias
- - username
+ - user
+ - password
+ - mutual_user
+ - mutual_password
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Set Iscsi discoveryauth
tags:
- - Multi-cluster
- /api/multi-cluster/get_config:
- get:
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Multi-cluster
- /api/multi-cluster/get_prometheus_api_url:
+ - Iscsi
+ /api/iscsi/target:
get:
parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Multi-cluster
- /api/multi-cluster/reconnect_cluster:
- put:
+ - IscsiTarget
+ post:
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- cluster_token:
+ acl_enabled:
type: string
- password:
+ auth:
type: string
- ssl_certificate:
+ clients:
type: string
- ssl_verify:
- default: false
- type: boolean
- ttl:
+ disks:
type: string
- url:
+ groups:
type: string
- username:
+ portals:
+ type: string
+ target_controls:
+ type: string
+ target_iqn:
type: string
- required:
- - url
type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Multi-cluster
- /api/multi-cluster/security_config:
- get:
- parameters: []
+ - IscsiTarget
+ /api/iscsi/target/{target_iqn}:
+ delete:
+ parameters:
+ - in: path
+ name: target_iqn
+ required: true
+ schema:
+ type: string
responses:
- '200':
+ '202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - IscsiTarget
+ get:
+ parameters:
+ - in: path
+ name: target_iqn
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Multi-cluster
- /api/multi-cluster/set_config:
+ - IscsiTarget
put:
- parameters: []
+ parameters:
+ - in: path
+ name: target_iqn
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- config:
+ acl_enabled:
+ type: string
+ auth:
+ type: string
+ clients:
+ type: string
+ disks:
+ type: string
+ groups:
+ type: string
+ new_target_iqn:
+ type: string
+ portals:
+ type: string
+ target_controls:
type: string
- required:
- - config
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Multi-cluster
- /api/nfs-ganesha/cluster:
+ - IscsiTarget
+ /api/logs/all:
get:
- parameters:
- - default: false
- in: query
- name: info
- schema:
- type: boolean
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v0.1+json:
- type: object
+ application/json:
+ schema:
+ properties:
+ audit_log:
+ description: Audit log
+ items:
+ properties:
+ addrs:
+ description: ''
+ properties:
+ addrvec:
+ description: ''
+ items:
+ properties:
+ addr:
+ description: IP Address
+ type: string
+ nonce:
+ description: ''
+ type: integer
+ type:
+ description: ''
+ type: string
+ required: &id073
+ - type
+ - addr
+ - nonce
+ type: object
+ type: array
+ required: &id074
+ - addrvec
+ type: object
+ channel:
+ description: ''
+ type: string
+ message:
+ description: ''
+ type: string
+ name:
+ description: ''
+ type: string
+ priority:
+ description: ''
+ type: string
+ rank:
+ description: ''
+ type: string
+ seq:
+ description: ''
+ type: integer
+ stamp:
+ description: ''
+ type: string
+ required: &id075
+ - name
+ - rank
+ - addrs
+ - stamp
+ - seq
+ - channel
+ - priority
+ - message
+ type: object
+ type: array
+ clog:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: &id076
+ - clog
+ - audit_log
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ audit_log:
+ description: Audit log
+ items:
+ properties:
+ addrs:
+ description: ''
+ properties:
+ addrvec:
+ description: ''
+ items:
+ properties:
+ addr:
+ description: IP Address
+ type: string
+ nonce:
+ description: ''
+ type: integer
+ type:
+ description: ''
+ type: string
+ required: *id073
+ type: object
+ type: array
+ required: *id074
+ type: object
+ channel:
+ description: ''
+ type: string
+ message:
+ description: ''
+ type: string
+ name:
+ description: ''
+ type: string
+ priority:
+ description: ''
+ type: string
+ rank:
+ description: ''
+ type: string
+ seq:
+ description: ''
+ type: integer
+ stamp:
+ description: ''
+ type: string
+ required: *id075
+ type: object
+ type: array
+ clog:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: *id076
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Display Logs Configuration
tags:
- - NFS-Ganesha
- /api/nfs-ganesha/export:
+ - Logs
+ /api/mgr/module:
get:
- parameters:
- - allowEmptyValue: true
- in: query
- name: cluster_id
- schema:
- type: string
+ description: "\n Get the list of managed modules.\n :return: A\
+ \ list of objects with the fields 'enabled', 'name' and 'options'.\n \
+ \ :rtype: list\n "
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
- access_type:
- description: Export access type
+ always_on:
+ description: Is it an always on module?
+ type: boolean
+ enabled:
+ description: Is Module Enabled
+ type: boolean
+ name:
+ description: Module Name
type: string
- clients:
- description: List of client configurations
- items:
- properties:
- access_type:
- description: Client access type
- type: string
- addresses:
- description: list of IP addresses
- items:
- type: string
- type: array
- squash:
- description: Client squash policy
- type: string
- required:
- - addresses
- - access_type
- - squash
- type: object
- type: array
- cluster_id:
- description: Cluster identifier
- type: string
- export_id:
- description: Export ID
- type: integer
- fsal:
- description: FSAL configuration
+ options:
+ description: Module Options
properties:
- fs_name:
- description: CephFS filesystem name
- type: string
- name:
- description: name of FSAL
- type: string
- sec_label_xattr:
- description: Name of xattr for security label
- type: string
- user_id:
- description: User id
- type: string
- required:
- - name
+ Option_name:
+ description: Options
+ properties:
+ default_value:
+ description: Default value for the option
+ type: integer
+ desc:
+ description: Description of the option
+ type: string
+ enum_allowed:
+ description: ''
+ items:
+ type: string
+ type: array
+ flags:
+ description: List of flags associated
+ type: integer
+ level:
+ description: Option level
+ type: string
+ long_desc:
+ description: Elaborated description
+ type: string
+ max:
+ description: Maximum value
+ type: string
+ min:
+ description: Minimum value
+ type: string
+ name:
+ description: Name of the option
+ type: string
+ see_also:
+ description: Related options
+ items:
+ type: string
+ type: array
+ tags:
+ description: Tags associated with the option
+ items:
+ type: string
+ type: array
+ type:
+ description: Type of the option
+ type: string
+ required: &id077
+ - name
+ - type
+ - level
+ - flags
+ - default_value
+ - min
+ - max
+ - enum_allowed
+ - desc
+ - long_desc
+ - tags
+ - see_also
+ type: object
+ required: &id078
+ - Option_name
type: object
- path:
- description: Export path
- type: string
- protocols:
- description: List of protocol types
- items:
- type: integer
- type: array
- pseudo:
- description: Pseudo FS path
- type: string
- security_label:
- description: Security label
- type: string
- squash:
- description: Export squash policy
+ type: object
+ required: &id079
+ - name
+ - enabled
+ - always_on
+ - options
+ type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ always_on:
+ description: Is it an always on module?
+ type: boolean
+ enabled:
+ description: Is Module Enabled
+ type: boolean
+ name:
+ description: Module Name
type: string
- transports:
- description: List of transport types
- items:
- type: string
- type: array
+ options:
+ description: Module Options
+ properties:
+ Option_name:
+ description: Options
+ properties:
+ default_value:
+ description: Default value for the option
+ type: integer
+ desc:
+ description: Description of the option
+ type: string
+ enum_allowed:
+ description: ''
+ items:
+ type: string
+ type: array
+ flags:
+ description: List of flags associated
+ type: integer
+ level:
+ description: Option level
+ type: string
+ long_desc:
+ description: Elaborated description
+ type: string
+ max:
+ description: Maximum value
+ type: string
+ min:
+ description: Minimum value
+ type: string
+ name:
+ description: Name of the option
+ type: string
+ see_also:
+ description: Related options
+ items:
+ type: string
+ type: array
+ tags:
+ description: Tags associated with the option
+ items:
+ type: string
+ type: array
+ type:
+ description: Type of the option
+ type: string
+ required: *id077
+ type: object
+ required: *id078
+ type: object
type: object
- required:
- - export_id
- - path
- - cluster_id
- - pseudo
- - access_type
- - squash
- - security_label
- - protocols
- - transports
- - fsal
- - clients
+ required: *id079
type: array
description: OK
'400':
trace.
security:
- jwt: []
- summary: List all or cluster specific NFS-Ganesha exports
+ summary: List Mgr modules
tags:
- - NFS-Ganesha
- post:
- parameters: []
+ - MgrModule
+ /api/mgr/module/{module_name}:
+ get:
+ description: "\n Retrieve the values of the persistent configuration\
+ \ settings.\n :param module_name: The name of the Ceph Mgr module.\n\
+ \ :type module_name: str\n :return: The values of the module\
+ \ options.\n :rtype: dict\n "
+ parameters:
+ - in: path
+ name: module_name
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - MgrModule
+ put:
+ description: "\n Set the values of the persistent configuration settings.\n\
+ \ :param module_name: The name of the Ceph Mgr module.\n :type\
+ \ module_name: str\n :param config: The values of the module options\
+ \ to be stored.\n :type config: dict\n "
+ parameters:
+ - in: path
+ name: module_name
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- access_type:
- description: Export access type
+ config:
type: string
- clients:
- description: List of client configurations
- items:
- properties:
- access_type:
- description: Client access type
- type: string
- addresses:
- description: list of IP addresses
- items:
- type: string
- type: array
- squash:
- description: Client squash policy
- type: string
- required:
- - addresses
- - access_type
- - squash
- type: object
- type: array
- cluster_id:
- description: Cluster identifier
- type: string
- fsal:
- description: FSAL configuration
- properties:
- fs_name:
- description: CephFS filesystem name
- type: string
- name:
- description: name of FSAL
- type: string
- sec_label_xattr:
- description: Name of xattr for security label
- type: string
- required:
- - name
- type: object
- path:
- description: Export path
- type: string
- protocols:
- description: List of protocol types
- items:
- type: integer
- type: array
- pseudo:
- description: Pseudo FS path
- type: string
- security_label:
- description: Security label
- type: string
- squash:
- description: Export squash policy
- type: string
- transports:
- description: List of transport types
- items:
- type: string
- type: array
required:
- - path
- - cluster_id
- - pseudo
- - access_type
- - squash
- - security_label
- - protocols
- - transports
- - fsal
- - clients
+ - config
type: object
responses:
- '201':
+ '200':
content:
- application/vnd.ceph.api.v2.0+json:
+ application/json:
schema:
- properties:
- access_type:
- description: Export access type
- type: string
- clients:
- description: List of client configurations
- items:
- properties:
- access_type:
- description: Client access type
- type: string
- addresses:
- description: list of IP addresses
- items:
- type: string
- type: array
- squash:
- description: Client squash policy
- type: string
- required:
- - addresses
- - access_type
- - squash
- type: object
- type: array
- cluster_id:
- description: Cluster identifier
- type: string
- export_id:
- description: Export ID
- type: integer
- fsal:
- description: FSAL configuration
- properties:
- fs_name:
- description: CephFS filesystem name
- type: string
- name:
- description: name of FSAL
- type: string
- sec_label_xattr:
- description: Name of xattr for security label
- type: string
- user_id:
- description: User id
- type: string
- required:
- - name
- type: object
- path:
- description: Export path
- type: string
- protocols:
- description: List of protocol types
- items:
- type: integer
- type: array
- pseudo:
- description: Pseudo FS path
- type: string
- security_label:
- description: Security label
- type: string
- squash:
- description: Export squash policy
- type: string
- transports:
- description: List of transport types
- items:
- type: string
- type: array
- required:
- - export_id
- - path
- - cluster_id
- - pseudo
- - access_type
- - squash
- - security_label
- - protocols
- - transports
- - fsal
- - clients
type: object
- description: Resource created.
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource updated.
'202':
content:
- application/vnd.ceph.api.v2.0+json:
- type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Creates a new NFS-Ganesha export
tags:
- - NFS-Ganesha
- /api/nfs-ganesha/export/{cluster_id}/{export_id}:
- delete:
+ - MgrModule
+ /api/mgr/module/{module_name}/disable:
+ post:
+ description: "\n Disable the specified Ceph Mgr module.\n :param\
+ \ module_name: The name of the Ceph Mgr module.\n :type module_name:\
+ \ str\n "
parameters:
- - description: Cluster identifier
- in: path
- name: cluster_id
+ - in: path
+ name: module_name
required: true
schema:
type: string
- - description: Export ID
- in: path
- name: export_id
- required: true
- schema:
- type: integer
responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
- application/vnd.ceph.api.v2.0+json:
- type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
- '204':
- content:
- application/vnd.ceph.api.v2.0+json:
- type: object
- description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Deletes an NFS-Ganesha export
tags:
- - NFS-Ganesha
- get:
+ - MgrModule
+ /api/mgr/module/{module_name}/enable:
+ post:
+ description: "\n Enable the specified Ceph Mgr module.\n :param\
+ \ module_name: The name of the Ceph Mgr module.\n :type module_name:\
+ \ str\n "
parameters:
- - description: Cluster identifier
- in: path
- name: cluster_id
+ - in: path
+ name: module_name
required: true
schema:
type: string
- - description: Export ID
- in: path
- name: export_id
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource created.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - MgrModule
+ /api/mgr/module/{module_name}/options:
+ get:
+ description: "\n Get the module options of the specified Ceph Mgr module.\n\
+ \ :param module_name: The name of the Ceph Mgr module.\n :type\
+ \ module_name: str\n :return: The module options as list of dicts.\n\
+ \ :rtype: list\n "
+ parameters:
+ - in: path
+ name: module_name
required: true
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
- properties:
- access_type:
- description: Export access type
- type: string
- clients:
- description: List of client configurations
- items:
- properties:
- access_type:
- description: Client access type
- type: string
- addresses:
- description: list of IP addresses
- items:
- type: string
- type: array
- squash:
- description: Client squash policy
- type: string
- required:
- - addresses
- - access_type
- - squash
- type: object
- type: array
- cluster_id:
- description: Cluster identifier
- type: string
- export_id:
- description: Export ID
- type: integer
- fsal:
- description: FSAL configuration
- properties:
- fs_name:
- description: CephFS filesystem name
- type: string
- name:
- description: name of FSAL
- type: string
- sec_label_xattr:
- description: Name of xattr for security label
- type: string
- user_id:
- description: User id
- type: string
- required:
- - name
- type: object
- path:
- description: Export path
- type: string
- protocols:
- description: List of protocol types
- items:
- type: integer
- type: array
- pseudo:
- description: Pseudo FS path
- type: string
- security_label:
- description: Security label
- type: string
- squash:
- description: Export squash policy
- type: string
- transports:
- description: List of transport types
- items:
- type: string
- type: array
- required:
- - export_id
- - path
- - cluster_id
- - pseudo
- - access_type
- - squash
- - security_label
- - protocols
- - transports
- - fsal
- - clients
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get an NFS-Ganesha export
tags:
- - NFS-Ganesha
- put:
- parameters:
- - description: Cluster identifier
- in: path
- name: cluster_id
- required: true
- schema:
- type: string
- - description: Export ID
- in: path
- name: export_id
- required: true
- schema:
- type: integer
- requestBody:
- content:
- application/json:
- schema:
- properties:
- access_type:
- description: Export access type
- type: string
- clients:
- description: List of client configurations
- items:
- properties:
- access_type:
- description: Client access type
- type: string
- addresses:
- description: list of IP addresses
- items:
- type: string
- type: array
- squash:
- description: Client squash policy
- type: string
- required:
- - addresses
- - access_type
- - squash
- type: object
- type: array
- fsal:
- description: FSAL configuration
- properties:
- fs_name:
- description: CephFS filesystem name
- type: string
- name:
- description: name of FSAL
- type: string
- sec_label_xattr:
- description: Name of xattr for security label
- type: string
- required:
- - name
- type: object
- path:
- description: Export path
- type: string
- protocols:
- description: List of protocol types
- items:
- type: integer
- type: array
- pseudo:
- description: Pseudo FS path
- type: string
- security_label:
- description: Security label
- type: string
- squash:
- description: Export squash policy
- type: string
- transports:
- description: List of transport types
- items:
- type: string
- type: array
- required:
- - path
- - pseudo
- - access_type
- - squash
- - security_label
- - protocols
- - transports
- - fsal
- - clients
- type: object
+ - MgrModule
+ /api/monitor:
+ get:
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v2.0+json:
+ application/json:
schema:
properties:
- access_type:
- description: Export access type
- type: string
- clients:
- description: List of client configurations
+ in_quorum:
+ description: ''
items:
properties:
- access_type:
- description: Client access type
+ addr:
+ description: ''
type: string
- addresses:
- description: list of IP addresses
- items:
- type: string
- type: array
- squash:
- description: Client squash policy
+ name:
+ description: ''
type: string
- required:
- - addresses
- - access_type
- - squash
+ priority:
+ description: ''
+ type: integer
+ public_addr:
+ description: ''
+ type: string
+ public_addrs:
+ description: ''
+ properties:
+ addrvec:
+ description: ''
+ items:
+ properties:
+ addr:
+ description: ''
+ type: string
+ nonce:
+ description: ''
+ type: integer
+ type:
+ description: ''
+ type: string
+ required: &id080
+ - type
+ - addr
+ - nonce
+ type: object
+ type: array
+ required: &id081
+ - addrvec
+ type: object
+ rank:
+ description: ''
+ type: integer
+ stats:
+ description: ''
+ properties:
+ num_sessions:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required: &id082
+ - num_sessions
+ type: object
+ weight:
+ description: ''
+ type: integer
+ required: &id083
+ - rank
+ - name
+ - public_addrs
+ - addr
+ - public_addr
+ - priority
+ - weight
+ - stats
type: object
type: array
- cluster_id:
- description: Cluster identifier
- type: string
- export_id:
- description: Export ID
- type: integer
- fsal:
- description: FSAL configuration
+ mon_status:
+ description: ''
properties:
- fs_name:
- description: CephFS filesystem name
- type: string
+ election_epoch:
+ description: ''
+ type: integer
+ extra_probe_peers:
+ description: ''
+ items:
+ type: string
+ type: array
+ feature_map:
+ description: ''
+ properties:
+ client:
+ description: ''
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required: &id084
+ - features
+ - release
+ - num
+ type: object
+ type: array
+ mds:
+ description: ''
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required: &id085
+ - features
+ - release
+ - num
+ type: object
+ type: array
+ mgr:
+ description: ''
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required: &id086
+ - features
+ - release
+ - num
+ type: object
+ type: array
+ mon:
+ description: ''
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required: &id087
+ - features
+ - release
+ - num
+ type: object
+ type: array
+ required: &id088
+ - mon
+ - mds
+ - client
+ - mgr
+ type: object
+ features:
+ description: ''
+ properties:
+ quorum_con:
+ description: ''
+ type: string
+ quorum_mon:
+ description: ''
+ items:
+ type: string
+ type: array
+ required_con:
+ description: ''
+ type: string
+ required_mon:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required: &id089
+ - required_con
+ - required_mon
+ - quorum_con
+ - quorum_mon
+ type: object
+ monmap:
+ description: ''
+ properties:
+ created:
+ description: ''
+ type: string
+ epoch:
+ description: ''
+ type: integer
+ features:
+ description: ''
+ properties:
+ optional:
+ description: ''
+ items:
+ type: string
+ type: array
+ persistent:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: &id090
+ - persistent
+ - optional
+ type: object
+ fsid:
+ description: ''
+ type: string
+ min_mon_release:
+ description: ''
+ type: integer
+ min_mon_release_name:
+ description: ''
+ type: string
+ modified:
+ description: ''
+ type: string
+ mons:
+ description: ''
+ items:
+ properties:
+ addr:
+ description: ''
+ type: string
+ name:
+ description: ''
+ type: string
+ priority:
+ description: ''
+ type: integer
+ public_addr:
+ description: ''
+ type: string
+ public_addrs:
+ description: ''
+ properties:
+ addrvec:
+ description: ''
+ items:
+ properties:
+ addr:
+ description: ''
+ type: string
+ nonce:
+ description: ''
+ type: integer
+ type:
+ description: ''
+ type: string
+ required: &id091
+ - type
+ - addr
+ - nonce
+ type: object
+ type: array
+ required: &id092
+ - addrvec
+ type: object
+ rank:
+ description: ''
+ type: integer
+ stats:
+ description: ''
+ properties:
+ num_sessions:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required: &id093
+ - num_sessions
+ type: object
+ weight:
+ description: ''
+ type: integer
+ required: &id094
+ - rank
+ - name
+ - public_addrs
+ - addr
+ - public_addr
+ - priority
+ - weight
+ - stats
+ type: object
+ type: array
+ required: &id095
+ - epoch
+ - fsid
+ - modified
+ - created
+ - min_mon_release
+ - min_mon_release_name
+ - features
+ - mons
+ type: object
name:
- description: name of FSAL
- type: string
- sec_label_xattr:
- description: Name of xattr for security label
+ description: ''
type: string
- user_id:
- description: User id
+ outside_quorum:
+ description: ''
+ items:
+ type: string
+ type: array
+ quorum:
+ description: ''
+ items:
+ type: integer
+ type: array
+ quorum_age:
+ description: ''
+ type: integer
+ rank:
+ description: ''
+ type: integer
+ state:
+ description: ''
type: string
- required:
- - name
+ sync_provider:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: &id096
+ - name
+ - rank
+ - state
+ - election_epoch
+ - quorum
+ - quorum_age
+ - features
+ - outside_quorum
+ - extra_probe_peers
+ - sync_provider
+ - monmap
+ - feature_map
type: object
- path:
- description: Export path
- type: string
- protocols:
- description: List of protocol types
+ out_quorum:
+ description: ''
items:
type: integer
type: array
- pseudo:
- description: Pseudo FS path
- type: string
- security_label:
- description: Security label
- type: string
- squash:
- description: Export squash policy
- type: string
- transports:
- description: List of transport types
- items:
- type: string
- type: array
- required:
- - export_id
- - path
- - cluster_id
- - pseudo
- - access_type
- - squash
- - security_label
- - protocols
- - transports
- - fsal
- - clients
+ required: &id097
+ - mon_status
+ - in_quorum
+ - out_quorum
type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v2.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Updates an NFS-Ganesha export
- tags:
- - NFS-Ganesha
- /api/nvmeof/gateway:
- get:
- parameters:
- - allowEmptyValue: true
- in: query
- name: gw_group
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: server_address
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get information about the NVMeoF gateway
- tags:
- - NVMe-oF Gateway
- /api/nvmeof/gateway/group:
- get:
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - NVMe-oF Gateway
- /api/nvmeof/gateway/listener_info/{nqn}:
- get:
- parameters:
- - in: path
- name: nqn
- required: true
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: gw_group
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: server_address
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get NVMeoF gateway's listeners info
- tags:
- - NVMe-oF Gateway
- /api/nvmeof/gateway/log_level:
- get:
- parameters:
- - allowEmptyValue: true
- in: query
- name: gw_group
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: server_address
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get NVMeoF gateway log level information
- tags:
- - NVMe-oF Gateway
- put:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- gw_group:
- type: string
- log_level:
- type: string
- server_address:
- type: string
- required:
- - log_level
- type: object
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Set NVMeoF gateway log levels
- tags:
- - NVMe-oF Gateway
- /api/nvmeof/gateway/stats:
- get:
- parameters:
- - allowEmptyValue: true
- in: query
- name: gw_group
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: server_address
- schema:
- type: string
- responses:
- '200':
- content:
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ properties:
+ in_quorum:
+ description: ''
+ items:
+ properties:
+ addr:
+ description: ''
+ type: string
+ name:
+ description: ''
+ type: string
+ priority:
+ description: ''
+ type: integer
+ public_addr:
+ description: ''
+ type: string
+ public_addrs:
+ description: ''
+ properties:
+ addrvec:
+ description: ''
+ items:
+ properties:
+ addr:
+ description: ''
+ type: string
+ nonce:
+ description: ''
+ type: integer
+ type:
+ description: ''
+ type: string
+ required: *id080
+ type: object
+ type: array
+ required: *id081
+ type: object
+ rank:
+ description: ''
+ type: integer
+ stats:
+ description: ''
+ properties:
+ num_sessions:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required: *id082
+ type: object
+ weight:
+ description: ''
+ type: integer
+ required: *id083
+ type: object
+ type: array
+ mon_status:
+ description: ''
+ properties:
+ election_epoch:
+ description: ''
+ type: integer
+ extra_probe_peers:
+ description: ''
+ items:
+ type: string
+ type: array
+ feature_map:
+ description: ''
+ properties:
+ client:
+ description: ''
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required: *id084
+ type: object
+ type: array
+ mds:
+ description: ''
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required: *id085
+ type: object
+ type: array
+ mgr:
+ description: ''
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required: *id086
+ type: object
+ type: array
+ mon:
+ description: ''
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required: *id087
+ type: object
+ type: array
+ required: *id088
+ type: object
+ features:
+ description: ''
+ properties:
+ quorum_con:
+ description: ''
+ type: string
+ quorum_mon:
+ description: ''
+ items:
+ type: string
+ type: array
+ required_con:
+ description: ''
+ type: string
+ required_mon:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required: *id089
+ type: object
+ monmap:
+ description: ''
+ properties:
+ created:
+ description: ''
+ type: string
+ epoch:
+ description: ''
+ type: integer
+ features:
+ description: ''
+ properties:
+ optional:
+ description: ''
+ items:
+ type: string
+ type: array
+ persistent:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: *id090
+ type: object
+ fsid:
+ description: ''
+ type: string
+ min_mon_release:
+ description: ''
+ type: integer
+ min_mon_release_name:
+ description: ''
+ type: string
+ modified:
+ description: ''
+ type: string
+ mons:
+ description: ''
+ items:
+ properties:
+ addr:
+ description: ''
+ type: string
+ name:
+ description: ''
+ type: string
+ priority:
+ description: ''
+ type: integer
+ public_addr:
+ description: ''
+ type: string
+ public_addrs:
+ description: ''
+ properties:
+ addrvec:
+ description: ''
+ items:
+ properties:
+ addr:
+ description: ''
+ type: string
+ nonce:
+ description: ''
+ type: integer
+ type:
+ description: ''
+ type: string
+ required: *id091
+ type: object
+ type: array
+ required: *id092
+ type: object
+ rank:
+ description: ''
+ type: integer
+ stats:
+ description: ''
+ properties:
+ num_sessions:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required: *id093
+ type: object
+ weight:
+ description: ''
+ type: integer
+ required: *id094
+ type: object
+ type: array
+ required: *id095
+ type: object
+ name:
+ description: ''
+ type: string
+ outside_quorum:
+ description: ''
+ items:
+ type: string
+ type: array
+ quorum:
+ description: ''
+ items:
+ type: integer
+ type: array
+ quorum_age:
+ description: ''
+ type: integer
+ rank:
+ description: ''
+ type: integer
+ state:
+ description: ''
+ type: string
+ sync_provider:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: *id096
+ type: object
+ out_quorum:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required: *id097
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get Monitor Details
+ tags:
+ - Monitor
+ /api/multi-cluster/auth:
+ post:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ cluster_alias:
+ type: string
+ hub_url:
+ type: string
+ password:
+ type: string
+ ssl_certificate:
+ type: string
+ ssl_verify:
+ default: false
+ type: boolean
+ ttl:
+ type: string
+ url:
+ type: string
+ username:
+ type: string
+ required:
+ - url
+ - cluster_alias
+ - username
+ type: object
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource created.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Authenticate to a remote cluster
+ tags:
+ - Multi-cluster
+ /api/multi-cluster/check_token_status:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Multi-cluster
+ /api/multi-cluster/delete_cluster/{cluster_name}/{cluster_user}:
+ delete:
+ parameters:
+ - in: path
+ name: cluster_name
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: cluster_user
+ required: true
+ schema:
+ type: string
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Multi-cluster
+ /api/multi-cluster/edit_cluster:
+ put:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ cluster_alias:
+ type: string
+ name:
+ type: string
+ ssl_certificate:
+ type: string
+ url:
+ type: string
+ username:
+ type: string
+ verify:
+ default: false
+ type: boolean
+ required:
+ - name
+ - url
+ - cluster_alias
+ - username
+ type: object
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Multi-cluster
+ /api/multi-cluster/get_config:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Multi-cluster
+ /api/multi-cluster/get_prometheus_api_url:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Multi-cluster
+ /api/multi-cluster/reconnect_cluster:
+ put:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ cluster_token:
+ type: string
+ password:
+ type: string
+ ssl_certificate:
+ type: string
+ ssl_verify:
+ default: false
+ type: boolean
+ ttl:
+ type: string
+ url:
+ type: string
+ username:
+ type: string
+ required:
+ - url
+ type: object
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Multi-cluster
+ /api/multi-cluster/security_config:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Multi-cluster
+ /api/multi-cluster/set_config:
+ put:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ config:
+ type: string
+ required:
+ - config
+ type: object
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Multi-cluster
+ /api/nfs-ganesha/cluster:
+ get:
+ parameters:
+ - default: false
+ in: query
+ name: info
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v0.1+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - NFS-Ganesha
+ /api/nfs-ganesha/export:
+ get:
+ parameters:
+ - allowEmptyValue: true
+ in: query
+ name: cluster_id
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ items:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required: &id098
+ - addresses
+ - access_type
+ - squash
+ type: object
+ type: array
+ cluster_id:
+ description: Cluster identifier
+ type: string
+ export_id:
+ description: Export ID
+ type: integer
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ user_id:
+ description: User id
+ type: string
+ required: &id099
+ - name
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ type: object
+ required: &id100
+ - export_id
+ - path
+ - cluster_id
+ - pseudo
+ - access_type
+ - squash
+ - security_label
+ - protocols
+ - transports
+ - fsal
+ - clients
+ type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required: *id098
+ type: object
+ type: array
+ cluster_id:
+ description: Cluster identifier
+ type: string
+ export_id:
+ description: Export ID
+ type: integer
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ user_id:
+ description: User id
+ type: string
+ required: *id099
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ type: object
+ required: *id100
+ type: array
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: List all or cluster specific NFS-Ganesha exports
+ tags:
+ - NFS-Ganesha
+ post:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required:
+ - addresses
+ - access_type
+ - squash
+ type: object
+ type: array
+ cluster_id:
+ description: Cluster identifier
+ type: string
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ required:
+ - name
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ required:
+ - path
+ - cluster_id
+ - pseudo
+ - access_type
+ - squash
+ - security_label
+ - protocols
+ - transports
+ - fsal
+ - clients
+ type: object
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required: &id101
+ - addresses
+ - access_type
+ - squash
+ type: object
+ type: array
+ cluster_id:
+ description: Cluster identifier
+ type: string
+ export_id:
+ description: Export ID
+ type: integer
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ user_id:
+ description: User id
+ type: string
+ required: &id102
+ - name
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ required: &id103
+ - export_id
+ - path
+ - cluster_id
+ - pseudo
+ - access_type
+ - squash
+ - security_label
+ - protocols
+ - transports
+ - fsal
+ - clients
+ type: object
+ application/vnd.ceph.api.v2.0+json:
+ schema:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required: *id101
+ type: object
+ type: array
+ cluster_id:
+ description: Cluster identifier
+ type: string
+ export_id:
+ description: Export ID
+ type: integer
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ user_id:
+ description: User id
+ type: string
+ required: *id102
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ required: *id103
+ type: object
+ description: Resource created.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v2.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Creates a new NFS-Ganesha export
+ tags:
+ - NFS-Ganesha
+ /api/nfs-ganesha/export/{cluster_id}/{export_id}:
+ delete:
+ parameters:
+ - description: Cluster identifier
+ in: path
+ name: cluster_id
+ required: true
+ schema:
+ type: string
+ - description: Export ID
+ in: path
+ name: export_id
+ required: true
+ schema:
+ type: integer
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v2.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v2.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Deletes an NFS-Ganesha export
+ tags:
+ - NFS-Ganesha
+ get:
+ parameters:
+ - description: Cluster identifier
+ in: path
+ name: cluster_id
+ required: true
+ schema:
+ type: string
+ - description: Export ID
+ in: path
+ name: export_id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required: &id104
+ - addresses
+ - access_type
+ - squash
+ type: object
+ type: array
+ cluster_id:
+ description: Cluster identifier
+ type: string
+ export_id:
+ description: Export ID
+ type: integer
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ user_id:
+ description: User id
+ type: string
+ required: &id105
+ - name
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ required: &id106
+ - export_id
+ - path
+ - cluster_id
+ - pseudo
+ - access_type
+ - squash
+ - security_label
+ - protocols
+ - transports
+ - fsal
+ - clients
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required: *id104
+ type: object
+ type: array
+ cluster_id:
+ description: Cluster identifier
+ type: string
+ export_id:
+ description: Export ID
+ type: integer
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ user_id:
+ description: User id
+ type: string
+ required: *id105
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ required: *id106
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get an NFS-Ganesha export
+ tags:
+ - NFS-Ganesha
+ put:
+ parameters:
+ - description: Cluster identifier
+ in: path
+ name: cluster_id
+ required: true
+ schema:
+ type: string
+ - description: Export ID
+ in: path
+ name: export_id
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required:
+ - addresses
+ - access_type
+ - squash
+ type: object
+ type: array
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ required:
+ - name
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ required:
+ - path
+ - pseudo
+ - access_type
+ - squash
+ - security_label
+ - protocols
+ - transports
+ - fsal
+ - clients
+ type: object
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required: &id107
+ - addresses
+ - access_type
+ - squash
+ type: object
+ type: array
+ cluster_id:
+ description: Cluster identifier
+ type: string
+ export_id:
+ description: Export ID
+ type: integer
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ user_id:
+ description: User id
+ type: string
+ required: &id108
+ - name
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ required: &id109
+ - export_id
+ - path
+ - cluster_id
+ - pseudo
+ - access_type
+ - squash
+ - security_label
+ - protocols
+ - transports
+ - fsal
+ - clients
+ type: object
+ application/vnd.ceph.api.v2.0+json:
+ schema:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
+ properties:
+ access_type:
+ description: Client access type
+ type: string
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
+ type: string
+ required: *id107
+ type: object
+ type: array
+ cluster_id:
+ description: Cluster identifier
+ type: string
+ export_id:
+ description: Export ID
+ type: integer
+ fsal:
+ description: FSAL configuration
+ properties:
+ fs_name:
+ description: CephFS filesystem name
+ type: string
+ name:
+ description: name of FSAL
+ type: string
+ sec_label_xattr:
+ description: Name of xattr for security label
+ type: string
+ user_id:
+ description: User id
+ type: string
+ required: *id108
+ type: object
+ path:
+ description: Export path
+ type: string
+ protocols:
+ description: List of protocol types
+ items:
+ type: integer
+ type: array
+ pseudo:
+ description: Pseudo FS path
+ type: string
+ security_label:
+ description: Security label
+ type: string
+ squash:
+ description: Export squash policy
+ type: string
+ transports:
+ description: List of transport types
+ items:
+ type: string
+ type: array
+ required: *id109
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v2.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Updates an NFS-Ganesha export
+ tags:
+ - NFS-Ganesha
+ /api/nvmeof/gateway:
+ get:
+ parameters:
+ - allowEmptyValue: true
+ in: query
+ name: gw_group
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: server_address
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get information about the NVMeoF gateway
+ tags:
+ - NVMe-oF Gateway
+ /api/nvmeof/gateway/group:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - NVMe-oF Gateway
+ /api/nvmeof/gateway/listener_info/{nqn}:
+ get:
+ parameters:
+ - in: path
+ name: nqn
+ required: true
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: gw_group
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: server_address
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get NVMeoF gateway's listeners info
+ tags:
+ - NVMe-oF Gateway
+ /api/nvmeof/gateway/log_level:
+ get:
+ parameters:
+ - allowEmptyValue: true
+ in: query
+ name: gw_group
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: server_address
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get NVMeoF gateway log level information
+ tags:
+ - NVMe-oF Gateway
+ put:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ gw_group:
+ type: string
+ log_level:
+ type: string
+ server_address:
+ type: string
+ required:
+ - log_level
+ type: object
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Set NVMeoF gateway log levels
+ tags:
+ - NVMe-oF Gateway
+ /api/nvmeof/gateway/stats:
+ get:
+ parameters:
+ - allowEmptyValue: true
+ in: query
+ name: gw_group
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: server_address
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.1+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
list_of_flags:
items:
type: string
type: array
- required:
+ required: &id110
- list_of_flags
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ list_of_flags:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: *id110
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
list_of_flags:
items:
type: string
type: array
- required:
+ required: &id111
- list_of_flags
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ list_of_flags:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: *id111
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
flags:
osd:
description: OSD ID
type: integer
- required:
+ required: &id112
- osd
- flags
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ flags:
+ description: List of active flags
+ items:
+ type: string
+ type: array
+ osd:
+ description: OSD ID
+ type: integer
+ required: *id112
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
added:
items:
type: string
type: array
- required:
+ required: &id113
- added
- removed
- ids
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ added:
+ description: List of added flags
+ items:
+ type: string
+ type: array
+ ids:
+ description: List of updated OSDs
+ items:
+ type: integer
+ type: array
+ removed:
+ description: List of removed flags
+ items:
+ type: string
+ type: array
+ required: *id113
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
active:
items:
type: string
type: array
- required:
+ required: &id114
- safe_to_destroy
- active
- missing_stats
- stored_pgs
- is_safe_to_destroy
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ active:
+ description: ''
+ items:
+ type: integer
+ type: array
+ is_safe_to_destroy:
+ description: Is OSD safe to destroy?
+ type: boolean
+ missing_stats:
+ description: ''
+ items:
+ type: string
+ type: array
+ safe_to_destroy:
+ description: Is OSD safe to destroy?
+ items:
+ type: string
+ type: array
+ stored_pgs:
+ description: Stored Pool groups in Osd
+ items:
+ type: string
+ type: array
+ required: *id114
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v0.1+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ properties:
+ mon.a:
+ description: Service ID
+ properties:
+ .cache_bytes:
+ description: ''
+ properties:
+ description:
+ description: ''
+ type: string
+ nick:
+ description: ''
+ type: string
+ priority:
+ description: ''
+ type: integer
+ type:
+ description: ''
+ type: integer
+ units:
+ description: ''
+ type: integer
+ value:
+ description: ''
+ type: integer
+ required: &id115
+ - description
+ - nick
+ - type
+ - priority
+ - units
+ - value
+ type: object
+ required: &id116
+ - .cache_bytes
+ type: object
+ required: &id117
+ - mon.a
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties:
value:
description: ''
type: integer
- required:
- - description
- - nick
- - type
- - priority
- - units
- - value
+ required: *id115
type: object
- required:
- - .cache_bytes
+ required: *id116
type: object
- required:
- - mon.a
+ required: *id117
type: object
description: OK
'400':
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
type:
description: ''
type: string
- required:
+ required: &id118
- type
type: object
hit_set_period:
target_version:
description: ''
type: string
- required:
+ required: &id119
- ready_epoch
- last_epoch_started
- last_epoch_clean
pg_num_min:
description: ''
type: integer
- required:
+ required: &id120
- pg_num_min
- pg_num_max
type: object
description: ''
type: integer
type: object
- required:
+ required: &id121
- pool
- pool_name
- flags
- last_force_op_resend_preluminous
- removed_snaps
type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ application_metadata:
+ description: ''
+ items:
+ type: string
+ type: array
+ auid:
+ description: ''
+ type: integer
+ cache_min_evict_age:
+ description: ''
+ type: integer
+ cache_min_flush_age:
+ description: ''
+ type: integer
+ cache_mode:
+ description: ''
+ type: string
+ cache_target_dirty_high_ratio_micro:
+ description: ''
+ type: integer
+ cache_target_dirty_ratio_micro:
+ description: ''
+ type: integer
+ cache_target_full_ratio_micro:
+ description: ''
+ type: integer
+ create_time:
+ description: ''
+ type: string
+ crush_rule:
+ description: ''
+ type: string
+ erasure_code_profile:
+ description: ''
+ type: string
+ expected_num_objects:
+ description: ''
+ type: integer
+ fast_read:
+ description: ''
+ type: boolean
+ flags:
+ description: ''
+ type: integer
+ flags_names:
+ description: flags name
+ type: string
+ grade_table:
+ description: ''
+ items:
+ type: string
+ type: array
+ hit_set_count:
+ description: ''
+ type: integer
+ hit_set_grade_decay_rate:
+ description: ''
+ type: integer
+ hit_set_params:
+ description: ''
+ properties:
+ type:
+ description: ''
+ type: string
+ required: *id118
+ type: object
+ hit_set_period:
+ description: ''
+ type: integer
+ hit_set_search_last_n:
+ description: ''
+ type: integer
+ last_change:
+ description: ''
+ type: string
+ last_force_op_resend:
+ description: ''
+ type: string
+ last_force_op_resend_preluminous:
+ description: ''
+ type: string
+ last_force_op_resend_prenautilus:
+ description: ''
+ type: string
+ last_pg_merge_meta:
+ description: ''
+ properties:
+ last_epoch_clean:
+ description: ''
+ type: integer
+ last_epoch_started:
+ description: ''
+ type: integer
+ ready_epoch:
+ description: ''
+ type: integer
+ source_pgid:
+ description: ''
+ type: string
+ source_version:
+ description: ''
+ type: string
+ target_version:
+ description: ''
+ type: string
+ required: *id119
+ type: object
+ min_read_recency_for_promote:
+ description: ''
+ type: integer
+ min_size:
+ description: ''
+ type: integer
+ min_write_recency_for_promote:
+ description: ''
+ type: integer
+ object_hash:
+ description: ''
+ type: integer
+ options:
+ description: ''
+ properties:
+ pg_num_max:
+ description: ''
+ type: integer
+ pg_num_min:
+ description: ''
+ type: integer
+ required: *id120
+ type: object
+ pg_autoscale_mode:
+ description: ''
+ type: string
+ pg_num:
+ description: ''
+ type: integer
+ pg_num_pending:
+ description: ''
+ type: integer
+ pg_num_target:
+ description: ''
+ type: integer
+ pg_placement_num:
+ description: ''
+ type: integer
+ pg_placement_num_target:
+ description: ''
+ type: integer
+ pool:
+ description: pool id
+ type: integer
+ pool_name:
+ description: pool name
+ type: string
+ pool_snaps:
+ description: ''
+ items:
+ type: string
+ type: array
+ quota_max_bytes:
+ description: ''
+ type: integer
+ quota_max_objects:
+ description: ''
+ type: integer
+ read_tier:
+ description: ''
+ type: integer
+ removed_snaps:
+ description: ''
+ items:
+ type: string
+ type: array
+ size:
+ description: pool size
+ type: integer
+ snap_epoch:
+ description: ''
+ type: integer
+ snap_mode:
+ description: ''
+ type: string
+ snap_seq:
+ description: ''
+ type: integer
+ stripe_width:
+ description: ''
+ type: integer
+ target_max_bytes:
+ description: ''
+ type: integer
+ target_max_objects:
+ description: ''
+ type: integer
+ tier_of:
+ description: ''
+ type: integer
+ tiers:
+ description: ''
+ items:
+ type: string
+ type: array
+ type:
+ description: type of pool
+ type: string
+ use_gmt_hitset:
+ description: ''
+ type: boolean
+ write_tier:
+ description: ''
+ type: integer
+ type: object
+ required: *id121
+ type: array
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Display Pool List
+ tags:
+ - Pool
+ post:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ pool:
+ default: rbd-mirror
+ type: string
+ type: object
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource created.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Pool
+ /api/pool/{pool_name}:
+ delete:
+ parameters:
+ - in: path
+ name: pool_name
+ required: true
+ schema:
+ type: string
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Pool
+ get:
+ parameters:
+ - in: path
+ name: pool_name
+ required: true
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: attrs
+ schema:
+ type: string
+ - default: false
+ in: query
+ name: stats
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Pool
+ put:
+ parameters:
+ - in: path
+ name: pool_name
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ application_metadata:
+ type: string
+ configuration:
+ type: string
+ flags:
+ type: string
+ rbd_mirroring:
+ type: string
+ type: object
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Pool
+ /api/pool/{pool_name}/configuration:
+ get:
+ parameters:
+ - in: path
+ name: pool_name
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Pool
+ /api/prometheus:
+ get:
+ parameters:
+ - default: false
+ in: query
+ name: cluster_filter
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Prometheus
+ /api/prometheus/alertgroup:
+ get:
+ parameters:
+ - default: false
+ in: query
+ name: cluster_filter
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Display Pool List
tags:
- - Pool
- post:
+ - Prometheus
+ /api/prometheus/data:
+ get:
parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- pool:
- default: rbd-mirror
- type: string
- type: object
responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Pool
- /api/pool/{pool_name}:
- delete:
- parameters:
- - in: path
- name: pool_name
- required: true
- schema:
- type: string
+ - Prometheus
+ /api/prometheus/notifications:
+ get:
+ parameters: []
responses:
- '202':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - PrometheusNotifications
+ /api/prometheus/prometheus_query_data:
+ get:
+ parameters: []
+ responses:
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Pool
+ - Prometheus
+ /api/prometheus/rules:
get:
- parameters:
- - in: path
- name: pool_name
- required: true
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: attrs
- schema:
- type: string
- - default: false
- in: query
- name: stats
- schema:
- type: boolean
+ parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Pool
- put:
- parameters:
- - in: path
- name: pool_name
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- application_metadata:
- type: string
- configuration:
- type: string
- flags:
- type: string
- rbd_mirroring:
- type: string
- type: object
+ - Prometheus
+ /api/prometheus/silence:
+ post:
+ parameters: []
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Pool
- /api/pool/{pool_name}/configuration:
- get:
+ - Prometheus
+ /api/prometheus/silence/{s_id}:
+ delete:
parameters:
- in: path
- name: pool_name
+ name: s_id
required: true
schema:
type: string
responses:
- '200':
+ '202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Pool
- /api/prometheus:
+ - Prometheus
+ /api/prometheus/silences:
get:
- parameters:
- - default: false
- in: query
- name: cluster_filter
- schema:
- type: boolean
+ parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- Prometheus
- /api/prometheus/alertgroup:
+ /api/rgw/accounts:
get:
+ description: "\n List all account ids or all detailed account info based\
+ \ on the 'detailed' query parameter.\n\n - If detailed=True, returns\
+ \ detailed account info.\n - If detailed=False, returns only account\
+ \ ids.\n "
parameters:
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
- default: false
in: query
- name: cluster_filter
+ name: detailed
schema:
type: boolean
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Prometheus
- /api/prometheus/data:
- get:
+ - RgwUserAccounts
+ post:
+ description: "\n Create an account\n\n :param account_name: Account\
+ \ name\n :return: Returns account resource.\n :rtype: Dict[str,\
+ \ Any]\n "
parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ account_name:
+ description: Account name
+ type: string
+ daemon_name:
+ description: Name of the daemon
+ type: string
+ email:
+ description: Email
+ type: string
+ max_access_keys:
+ description: Max access keys
+ type: integer
+ max_buckets:
+ description: Max buckets
+ type: integer
+ max_group:
+ description: Max groups
+ type: integer
+ max_roles:
+ description: Max roles
+ type: integer
+ max_users:
+ description: Max users
+ type: integer
+ tenant:
+ description: Tenant
+ type: string
+ required:
+ - account_name
+ type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Prometheus
- /api/prometheus/notifications:
- get:
- parameters: []
- responses:
- '200':
+ schema:
+ type: object
+ description: Resource created.
+ '202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Update RGW account info
tags:
- - PrometheusNotifications
- /api/prometheus/prometheus_query_data:
- get:
- parameters: []
+ - RgwUserAccounts
+ /api/rgw/accounts/{account_id}:
+ delete:
+ description: "\n Removes an account\n\n :param account_id: account\
+ \ identifier\n :return: None.\n "
+ parameters:
+ - description: Account id
+ in: path
+ name: account_id
+ required: true
+ schema:
+ type: string
+ - allowEmptyValue: true
+ description: Name of the daemon
+ in: query
+ name: daemon_name
+ schema:
+ type: string
responses:
- '200':
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Delete RGW Account
tags:
- - Prometheus
- /api/prometheus/rules:
+ - RgwUserAccounts
get:
- parameters: []
+ description: "\n Get an account by account id\n "
+ parameters:
+ - description: Account id
+ in: path
+ name: account_id
+ required: true
+ schema:
+ type: string
+ - allowEmptyValue: true
+ description: Name of the daemon
+ in: query
+ name: daemon_name
+ schema:
+ type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Get RGW Account by id
tags:
- - Prometheus
- /api/prometheus/silence:
- post:
- parameters: []
+ - RgwUserAccounts
+ put:
+ description: "\n Modifies an account\n\n :param account_id: Account\
+ \ identifier\n :return: Returns modified account resource.\n \
+ \ :rtype: Dict[str, Any]\n "
+ parameters:
+ - description: Account id
+ in: path
+ name: account_id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ account_name:
+ description: Account name
+ type: string
+ daemon_name:
+ description: Name of the daemon
+ type: string
+ email:
+ description: Email
+ type: string
+ max_access_keys:
+ description: Max access keys
+ type: integer
+ max_buckets:
+ description: Max buckets
+ type: integer
+ max_group:
+ description: Max groups
+ type: integer
+ max_roles:
+ description: Max roles
+ type: integer
+ max_users:
+ description: Max users
+ type: integer
+ tenant:
+ description: Tenant
+ type: string
+ required:
+ - account_name
+ type: object
responses:
- '201':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
+ schema:
+ type: object
+ description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Update RGW account info
tags:
- - Prometheus
- /api/prometheus/silence/{s_id}:
- delete:
+ - RgwUserAccounts
+ /api/rgw/accounts/{account_id}/quota:
+ put:
+ description: "\n Modifies quota\n\n :param account_id: Account\
+ \ identifier\n :param quota_type: 'account' or 'bucket'\n :return:\
+ \ Returns modified quota.\n :rtype: Dict[str, Any]\n "
parameters:
- - in: path
- name: s_id
+ - description: Account id
+ in: path
+ name: account_id
required: true
schema:
type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ enabled:
+ type: string
+ max_objects:
+ description: Max objects
+ type: string
+ max_size:
+ description: Max size
+ type: string
+ quota_type:
+ description: Quota type
+ type: string
+ required:
+ - quota_type
+ - max_size
+ - max_objects
+ - enabled
+ type: object
responses:
- '202':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Set RGW Account/Bucket quota
tags:
- - Prometheus
- /api/prometheus/silences:
- get:
- parameters: []
+ - RgwUserAccounts
+ /api/rgw/accounts/{account_id}/quota/status:
+ put:
+ description: "\n Enable/Disable quota\n\n :param account_id: Account\
+ \ identifier\n :param quota_type: 'account' or 'bucket'\n :param\
+ \ quota_status: 'enable' or 'disable'\n :return: Returns modified quota.\n\
+ \ :rtype: Dict[str, Any]\n "
+ parameters:
+ - description: Account id
+ in: path
+ name: account_id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ quota_status:
+ description: Quota status
+ type: string
+ quota_type:
+ description: Quota type
+ type: string
+ required:
+ - quota_type
+ - quota_status
+ type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Enable/Disable RGW Account/Bucket quota
tags:
- - Prometheus
- /api/rgw/accounts:
+ - RgwUserAccounts
+ /api/rgw/bucket:
get:
- description: "\n List all account ids or all detailed account info based\
- \ on the 'detailed' query parameter.\n\n - If detailed=True, returns\
- \ detailed account info.\n - If detailed=False, returns only account\
- \ ids.\n "
parameters:
+ - default: false
+ in: query
+ name: stats
+ schema:
+ type: boolean
- allowEmptyValue: true
in: query
name: daemon_name
schema:
type: string
- - default: false
+ - allowEmptyValue: true
in: query
- name: detailed
+ name: uid
schema:
- type: boolean
+ type: string
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
- type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.1+json:
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwUserAccounts
+ - RgwBucket
post:
- description: "\n Create an account\n\n :param account_name: Account\
- \ name\n :return: Returns account resource.\n :rtype: Dict[str,\
- \ Any]\n "
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- account_name:
- description: Account name
+ bucket:
+ type: string
+ bucket_policy:
+ type: string
+ canned_acl:
type: string
daemon_name:
- description: Name of the daemon
type: string
- email:
- description: Email
+ encryption_state:
+ default: 'false'
type: string
- max_access_keys:
- description: Max access keys
- type: integer
- max_buckets:
- description: Max buckets
- type: integer
- max_group:
- description: Max groups
- type: integer
- max_roles:
- description: Max roles
- type: integer
- max_users:
- description: Max users
- type: integer
- tenant:
- description: Tenant
+ encryption_type:
+ type: string
+ key_id:
+ type: string
+ lock_enabled:
+ default: 'false'
+ type: string
+ lock_mode:
+ type: string
+ lock_retention_period_days:
+ type: string
+ lock_retention_period_years:
+ type: string
+ placement_target:
+ type: string
+ replication:
+ default: 'false'
+ type: string
+ tags:
+ type: string
+ uid:
+ type: string
+ zonegroup:
type: string
required:
- - account_name
+ - bucket
+ - uid
type: object
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Update RGW account info
tags:
- - RgwUserAccounts
- /api/rgw/accounts/{account_id}:
+ - RgwBucket
+ /api/rgw/bucket/deleteEncryption:
delete:
- description: "\n Removes an account\n\n :param account_id: account\
- \ identifier\n :return: None.\n "
parameters:
- - description: Account id
- in: path
- name: account_id
+ - in: query
+ name: bucket_name
required: true
schema:
type: string
- allowEmptyValue: true
- description: Name of the daemon
in: query
name: daemon_name
schema:
type: string
+ - allowEmptyValue: true
+ in: query
+ name: owner
+ schema:
+ type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Delete RGW Account
tags:
- - RgwUserAccounts
+ - RgwBucket
+ /api/rgw/bucket/getEncryption:
get:
- description: "\n Get an account by account id\n "
parameters:
- - description: Account id
- in: path
- name: account_id
+ - in: query
+ name: bucket_name
required: true
schema:
type: string
- allowEmptyValue: true
- description: Name of the daemon
in: query
name: daemon_name
schema:
type: string
+ - allowEmptyValue: true
+ in: query
+ name: owner
+ schema:
+ type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get RGW Account by id
tags:
- - RgwUserAccounts
- put:
- description: "\n Modifies an account\n\n :param account_id: Account\
- \ identifier\n :return: Returns modified account resource.\n \
- \ :rtype: Dict[str, Any]\n "
+ - RgwBucket
+ /api/rgw/bucket/getEncryptionConfig:
+ get:
parameters:
- - description: Account id
- in: path
- name: account_id
- required: true
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: owner
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - RgwBucket
+ /api/rgw/bucket/lifecycle:
+ get:
+ parameters:
+ - default: ''
+ in: query
+ name: bucket_name
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: owner
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: tenant
schema:
type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - RgwBucket
+ put:
+ parameters: []
requestBody:
content:
application/json:
schema:
properties:
- account_name:
- description: Account name
+ bucket_name:
+ default: ''
type: string
daemon_name:
- description: Name of the daemon
type: string
- email:
- description: Email
+ lifecycle:
+ default: ''
+ type: string
+ owner:
type: string
- max_access_keys:
- description: Max access keys
- type: integer
- max_buckets:
- description: Max buckets
- type: integer
- max_group:
- description: Max groups
- type: integer
- max_roles:
- description: Max roles
- type: integer
- max_users:
- description: Max users
- type: integer
tenant:
- description: Tenant
type: string
- required:
- - account_name
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Update RGW account info
tags:
- - RgwUserAccounts
- /api/rgw/accounts/{account_id}/quota:
- put:
- description: "\n Modifies quota\n\n :param account_id: Account\
- \ identifier\n :param quota_type: 'account' or 'bucket'\n :return:\
- \ Returns modified quota.\n :rtype: Dict[str, Any]\n "
+ - RgwBucket
+ /api/rgw/bucket/notification:
+ delete:
parameters:
- - description: Account id
- in: path
- name: account_id
+ - in: query
+ name: bucket_name
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- enabled:
- type: string
- max_objects:
- description: Max objects
- type: string
- max_size:
- description: Max size
- type: string
- quota_type:
- description: Quota type
- type: string
- required:
- - quota_type
- - max_size
- - max_objects
- - enabled
- type: object
+ - in: query
+ name: notification_id
+ required: true
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: owner
+ schema:
+ type: string
responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Set RGW Account/Bucket quota
+ summary: Delete the bucket notification
tags:
- - RgwUserAccounts
- /api/rgw/accounts/{account_id}/quota/status:
- put:
- description: "\n Enable/Disable quota\n\n :param account_id: Account\
- \ identifier\n :param quota_type: 'account' or 'bucket'\n :param\
- \ quota_status: 'enable' or 'disable'\n :return: Returns modified quota.\n\
- \ :rtype: Dict[str, Any]\n "
+ - RgwBucket
+ get:
parameters:
- - description: Account id
- in: path
- name: account_id
+ - in: query
+ name: bucket_name
required: true
schema:
type: string
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: owner
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get the bucket notification
+ tags:
+ - RgwBucket
+ put:
+ parameters: []
requestBody:
content:
application/json:
schema:
properties:
- quota_status:
- description: Quota status
+ bucket_name:
type: string
- quota_type:
- description: Quota type
+ daemon_name:
+ type: string
+ notification:
+ default: ''
+ type: string
+ owner:
type: string
required:
- - quota_type
- - quota_status
+ - bucket_name
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Enable/Disable RGW Account/Bucket quota
+ summary: Create or update the bucket notification
tags:
- - RgwUserAccounts
- /api/rgw/bucket:
+ - RgwBucket
+ /api/rgw/bucket/ratelimit:
get:
- parameters:
- - default: false
- in: query
- name: stats
- schema:
- type: boolean
- - allowEmptyValue: true
- in: query
- name: daemon_name
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: uid
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.1+json:
- type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Get the bucket global rate limit
tags:
- RgwBucket
- post:
+ /api/rgw/bucket/setEncryptionConfig:
+ put:
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- bucket:
- type: string
- bucket_policy:
- type: string
- canned_acl:
+ config:
type: string
daemon_name:
type: string
- encryption_state:
- default: 'false'
- type: string
encryption_type:
type: string
- key_id:
- type: string
- lock_enabled:
- default: 'false'
- type: string
- lock_mode:
- type: string
- lock_retention_period_days:
- type: string
- lock_retention_period_years:
- type: string
- placement_target:
- type: string
- replication:
- default: 'false'
- type: string
- tags:
- type: string
- uid:
- type: string
- zonegroup:
+ kms_provider:
type: string
- required:
- - bucket
- - uid
type: object
responses:
- '201':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
+ schema:
+ type: object
+ description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- RgwBucket
- /api/rgw/bucket/deleteEncryption:
+ /api/rgw/bucket/{bucket}:
delete:
parameters:
- - in: query
- name: bucket_name
+ - in: path
+ name: bucket
required: true
schema:
type: string
name: daemon_name
schema:
type: string
- - allowEmptyValue: true
- in: query
- name: owner
- schema:
- type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- RgwBucket
- /api/rgw/bucket/getEncryption:
get:
parameters:
- - in: query
- name: bucket_name
+ - in: path
+ name: bucket
required: true
schema:
type: string
name: daemon_name
schema:
type: string
- - allowEmptyValue: true
- in: query
- name: owner
- schema:
- type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- RgwBucket
- /api/rgw/bucket/getEncryptionConfig:
- get:
+ put:
parameters:
- - allowEmptyValue: true
- in: query
- name: daemon_name
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: owner
+ - in: path
+ name: bucket
+ required: true
schema:
type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ bucket_id:
+ type: string
+ bucket_policy:
+ type: string
+ canned_acl:
+ type: string
+ daemon_name:
+ type: string
+ encryption_state:
+ default: 'false'
+ type: string
+ encryption_type:
+ type: string
+ key_id:
+ type: string
+ lifecycle:
+ type: string
+ lock_mode:
+ type: string
+ lock_retention_period_days:
+ type: string
+ lock_retention_period_years:
+ type: string
+ mfa_delete:
+ type: string
+ mfa_token_pin:
+ type: string
+ mfa_token_serial:
+ type: string
+ replication:
+ type: string
+ tags:
+ type: string
+ uid:
+ type: string
+ versioning_state:
+ type: string
+ required:
+ - bucket_id
+ type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
- jwt: []
tags:
- RgwBucket
- /api/rgw/bucket/lifecycle:
+ /api/rgw/bucket/{uid}/ratelimit:
get:
parameters:
- - default: ''
- in: query
- name: bucket_name
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: daemon_name
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: owner
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: tenant
+ - in: path
+ name: uid
+ required: true
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Get the bucket rate limit
tags:
- RgwBucket
put:
- parameters: []
+ parameters:
+ - in: path
+ name: uid
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- bucket_name:
- default: ''
+ enabled:
type: string
- daemon_name:
+ max_read_bytes:
type: string
- lifecycle:
- default: ''
+ max_read_ops:
type: string
- owner:
+ max_write_bytes:
type: string
- tenant:
+ max_write_ops:
type: string
+ required:
+ - enabled
+ - max_read_ops
+ - max_write_ops
+ - max_read_bytes
+ - max_write_bytes
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwBucket
- /api/rgw/bucket/notification:
- delete:
- parameters:
- - in: query
- name: bucket_name
- required: true
- schema:
- type: string
- - in: query
- name: notification_id
- required: true
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: daemon_name
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: owner
- schema:
- type: string
- responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
- '204':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Delete the bucket notification
- tags:
- - RgwBucket
- get:
- parameters:
- - in: query
- name: bucket_name
- required: true
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: daemon_name
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: owner
- schema:
- type: string
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Update the bucket rate limit
+ tags:
+ - RgwBucket
+ /api/rgw/daemon:
+ get:
+ parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ items:
+ properties:
+ id:
+ description: Daemon ID
+ type: string
+ port:
+ description: Port
+ type: integer
+ server_hostname:
+ description: ''
+ type: string
+ version:
+ description: Ceph Version
+ type: string
+ zone_name:
+ description: Zone
+ type: string
+ zonegroup_name:
+ description: Zone Group
+ type: string
+ type: object
+ required: &id122
+ - id
+ - version
+ - server_hostname
+ - zonegroup_name
+ - zone_name
+ - port
+ type: array
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ items:
+ properties:
+ id:
+ description: Daemon ID
+ type: string
+ port:
+ description: Port
+ type: integer
+ server_hostname:
+ description: ''
+ type: string
+ version:
+ description: Ceph Version
+ type: string
+ zone_name:
+ description: Zone
+ type: string
+ zonegroup_name:
+ description: Zone Group
+ type: string
+ type: object
+ required: *id122
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get the bucket notification
+ summary: Display RGW Daemons
tags:
- - RgwBucket
+ - RgwDaemon
+ /api/rgw/daemon/set_multisite_config:
put:
parameters: []
requestBody:
application/json:
schema:
properties:
- bucket_name:
- type: string
daemon_name:
type: string
- notification:
- default: ''
+ realm_name:
type: string
- owner:
+ zone_name:
+ type: string
+ zonegroup_name:
type: string
- required:
- - bucket_name
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Create or update the bucket notification
tags:
- - RgwBucket
- /api/rgw/bucket/ratelimit:
+ - RgwDaemon
+ /api/rgw/daemon/{svc_id}:
get:
- parameters: []
+ parameters:
+ - in: path
+ name: svc_id
+ required: true
+ schema:
+ type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get the bucket global rate limit
tags:
- - RgwBucket
- /api/rgw/bucket/setEncryptionConfig:
+ - RgwDaemon
+ /api/rgw/multisite/sync-flow:
put:
parameters: []
requestBody:
application/json:
schema:
properties:
- config:
+ bucket_name:
+ default: ''
type: string
- daemon_name:
+ destination_zone:
type: string
- encryption_type:
+ flow_id:
type: string
- kms_provider:
+ flow_type:
+ type: string
+ group_id:
+ type: string
+ source_zone:
+ type: string
+ zones:
type: string
+ required:
+ - flow_id
+ - flow_type
+ - group_id
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Create or update the sync flow
tags:
- - RgwBucket
- /api/rgw/bucket/{bucket}:
+ - RgwMultisite
+ /api/rgw/multisite/sync-flow/{flow_id}/{flow_type}/{group_id}:
delete:
parameters:
- in: path
- name: bucket
+ name: flow_id
required: true
schema:
type: string
- - allowEmptyValue: true
- in: query
- name: daemon_name
+ - in: path
+ name: flow_type
+ required: true
schema:
type: string
- responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwBucket
- get:
- parameters:
- in: path
- name: bucket
+ name: group_id
required: true
schema:
type: string
+ - default: ''
+ in: query
+ name: source_zone
+ schema:
+ type: string
+ - default: ''
+ in: query
+ name: destination_zone
+ schema:
+ type: string
- allowEmptyValue: true
in: query
- name: daemon_name
+ name: zones
+ schema:
+ type: string
+ - default: ''
+ in: query
+ name: bucket_name
schema:
type: string
responses:
- '200':
+ '202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Remove the sync flow
tags:
- - RgwBucket
+ - RgwMultisite
+ /api/rgw/multisite/sync-pipe:
put:
- parameters:
- - in: path
- name: bucket
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- bucket_id:
- type: string
- bucket_policy:
- type: string
- canned_acl:
- type: string
- daemon_name:
- type: string
- encryption_state:
- default: 'false'
- type: string
- encryption_type:
- type: string
- key_id:
- type: string
- lifecycle:
- type: string
- lock_mode:
- type: string
- lock_retention_period_days:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ bucket_name:
+ default: ''
type: string
- lock_retention_period_years:
+ destination_bucket:
+ default: ''
type: string
- mfa_delete:
+ destination_zones:
type: string
- mfa_token_pin:
+ group_id:
type: string
- mfa_token_serial:
+ mode:
+ default: ''
type: string
- replication:
+ pipe_id:
type: string
- tags:
+ source_bucket:
+ default: ''
type: string
- uid:
+ source_zones:
type: string
- versioning_state:
+ user:
+ default: ''
type: string
required:
- - bucket_id
+ - group_id
+ - pipe_id
+ - source_zones
+ - destination_zones
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Create or update the sync pipe
tags:
- - RgwBucket
- /api/rgw/bucket/{uid}/ratelimit:
- get:
+ - RgwMultisite
+ /api/rgw/multisite/sync-pipe/{group_id}/{pipe_id}:
+ delete:
parameters:
- in: path
- name: uid
+ name: group_id
required: true
schema:
type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get the bucket rate limit
- tags:
- - RgwBucket
- put:
- parameters:
- in: path
- name: uid
+ name: pipe_id
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- enabled:
- type: string
- max_read_bytes:
- type: string
- max_read_ops:
- type: string
- max_write_bytes:
- type: string
- max_write_ops:
- type: string
- required:
- - enabled
- - max_read_ops
- - max_write_ops
- - max_read_bytes
- - max_write_bytes
- type: object
+ - allowEmptyValue: true
+ in: query
+ name: source_zones
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: destination_zones
+ schema:
+ type: string
+ - default: ''
+ in: query
+ name: bucket_name
+ schema:
+ type: string
responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Update the bucket rate limit
+ summary: Remove the sync pipe
tags:
- - RgwBucket
- /api/rgw/daemon:
+ - RgwMultisite
+ /api/rgw/multisite/sync-policy:
get:
- parameters: []
+ parameters:
+ - default: ''
+ in: query
+ name: bucket_name
+ schema:
+ type: string
+ - default: ''
+ in: query
+ name: zonegroup_name
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: all_policy
+ schema:
+ type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
- items:
- properties:
- id:
- description: Daemon ID
- type: string
- port:
- description: Port
- type: integer
- server_hostname:
- description: ''
- type: string
- version:
- description: Ceph Version
- type: string
- zone_name:
- description: Zone
- type: string
- zonegroup_name:
- description: Zone Group
- type: string
- type: object
- required:
- - id
- - version
- - server_hostname
- - zonegroup_name
- - zone_name
- - port
- type: array
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Display RGW Daemons
+ summary: Get the sync policy
tags:
- - RgwDaemon
- /api/rgw/daemon/set_multisite_config:
- put:
+ - RgwMultisite
+ /api/rgw/multisite/sync-policy-group:
+ post:
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- daemon_name:
- type: string
- realm_name:
+ bucket_name:
+ default: ''
type: string
- zone_name:
+ group_id:
type: string
- zonegroup_name:
+ status:
type: string
+ required:
+ - group_id
+ - status
type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Create the sync policy group
tags:
- - RgwDaemon
- /api/rgw/daemon/{svc_id}:
- get:
- parameters:
- - in: path
- name: svc_id
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwDaemon
- /api/rgw/multisite/sync-flow:
+ - RgwMultisite
put:
parameters: []
requestBody:
schema:
properties:
bucket_name:
- default: ''
- type: string
- destination_zone:
- type: string
- flow_id:
- type: string
- flow_type:
+ default: ''
type: string
group_id:
type: string
- source_zone:
- type: string
- zones:
+ status:
type: string
required:
- - flow_id
- - flow_type
- group_id
+ - status
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Create or update the sync flow
+ summary: Update the sync policy group
tags:
- RgwMultisite
- /api/rgw/multisite/sync-flow/{flow_id}/{flow_type}/{group_id}:
+ /api/rgw/multisite/sync-policy-group/{group_id}:
delete:
parameters:
- - in: path
- name: flow_id
- required: true
- schema:
- type: string
- - in: path
- name: flow_type
- required: true
- schema:
- type: string
- in: path
name: group_id
required: true
schema:
type: string
- - default: ''
- in: query
- name: source_zone
- schema:
- type: string
- - default: ''
- in: query
- name: destination_zone
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: zones
- schema:
- type: string
- default: ''
in: query
name: bucket_name
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Remove the sync flow
+ summary: Remove the sync policy group
tags:
- RgwMultisite
- /api/rgw/multisite/sync-pipe:
- put:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- bucket_name:
- default: ''
- type: string
- destination_bucket:
- default: ''
- type: string
- destination_zones:
- type: string
- group_id:
- type: string
- mode:
- default: ''
- type: string
- pipe_id:
- type: string
- source_bucket:
- default: ''
- type: string
- source_zones:
- type: string
- user:
- default: ''
- type: string
- required:
- - group_id
- - pipe_id
- - source_zones
- - destination_zones
- type: object
+ get:
+ parameters:
+ - in: path
+ name: group_id
+ required: true
+ schema:
+ type: string
+ - default: ''
+ in: query
+ name: bucket_name
+ schema:
+ type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Create or update the sync pipe
+ summary: Get the sync policy group
tags:
- RgwMultisite
- /api/rgw/multisite/sync-pipe/{group_id}/{pipe_id}:
- delete:
+ /api/rgw/multisite/sync_status:
+ get:
parameters:
- - in: path
- name: group_id
- required: true
- schema:
- type: string
- - in: path
- name: pipe_id
- required: true
- schema:
- type: string
- allowEmptyValue: true
in: query
- name: source_zones
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: destination_zones
- schema:
- type: string
- - default: ''
- in: query
- name: bucket_name
+ name: daemon_name
schema:
type: string
responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Remove the sync pipe
+ summary: Get the sync status
tags:
- RgwMultisite
- /api/rgw/multisite/sync-policy:
+ /api/rgw/realm:
get:
parameters:
- - default: ''
- in: query
- name: bucket_name
- schema:
- type: string
- - default: ''
- in: query
- name: zonegroup_name
- schema:
- type: string
- allowEmptyValue: true
in: query
- name: all_policy
+ name: replicable
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get the sync policy
tags:
- - RgwMultisite
- /api/rgw/multisite/sync-policy-group:
+ - RgwRealm
post:
parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- bucket_name:
- default: ''
- type: string
- group_id:
- type: string
- status:
- type: string
- required:
- - group_id
- - status
- type: object
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ default:
+ type: string
+ realm_name:
+ type: string
+ required:
+ - realm_name
+ - default
+ type: object
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource created.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - RgwRealm
+ /api/rgw/realm/get_all_realms_info:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - RgwRealm
+ /api/rgw/realm/get_realm_tokens:
+ get:
+ parameters: []
responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Create the sync policy group
tags:
- - RgwMultisite
- put:
+ - RgwRealm
+ /api/rgw/realm/import_realm_token:
+ post:
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- bucket_name:
- default: ''
+ placement_spec:
type: string
- group_id:
+ port:
type: string
- status:
+ realm_token:
+ type: string
+ zone_name:
type: string
required:
- - group_id
- - status
+ - realm_token
+ - zone_name
+ - port
type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Update the sync policy group
tags:
- - RgwMultisite
- /api/rgw/multisite/sync-policy-group/{group_id}:
+ - RgwRealm
+ /api/rgw/realm/{realm_name}:
delete:
parameters:
- in: path
- name: group_id
+ name: realm_name
required: true
schema:
type: string
- - default: ''
- in: query
- name: bucket_name
- schema:
- type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Remove the sync policy group
tags:
- - RgwMultisite
+ - RgwRealm
get:
parameters:
- in: path
- name: group_id
+ name: realm_name
required: true
schema:
type: string
- - default: ''
- in: query
- name: bucket_name
- schema:
- type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get the sync policy group
tags:
- - RgwMultisite
- /api/rgw/multisite/sync_status:
- get:
+ - RgwRealm
+ put:
parameters:
- - allowEmptyValue: true
- in: query
- name: daemon_name
+ - in: path
+ name: realm_name
+ required: true
schema:
type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ default:
+ default: ''
+ type: string
+ new_realm_name:
+ type: string
+ required:
+ - new_realm_name
+ type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Get the sync status
tags:
- - RgwMultisite
- /api/rgw/realm:
+ - RgwRealm
+ /api/rgw/roles:
get:
- parameters:
- - allowEmptyValue: true
- in: query
- name: replicable
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: List RGW roles
tags:
- - RgwRealm
+ - RGW
post:
parameters: []
requestBody:
application/json:
schema:
properties:
- default:
+ role_assume_policy_doc:
+ default: ''
type: string
- realm_name:
+ role_name:
+ default: ''
+ type: string
+ role_path:
+ default: ''
type: string
- required:
- - realm_name
- - default
type: object
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Create RGW role
+ tags:
+ - RGW
+ put:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ max_session_duration:
+ type: string
+ role_name:
+ type: string
+ required:
+ - role_name
+ - max_session_duration
+ type: object
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Edit RGW role
+ tags:
+ - RGW
+ /api/rgw/roles/{role_name}:
+ delete:
+ parameters:
+ - in: path
+ name: role_name
+ required: true
+ schema:
+ type: string
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Delete RGW role
tags:
- - RgwRealm
- /api/rgw/realm/get_all_realms_info:
+ - RGW
+ /api/rgw/site:
get:
- parameters: []
+ parameters:
+ - allowEmptyValue: true
+ in: query
+ name: query
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwRealm
- /api/rgw/realm/get_realm_tokens:
+ - RgwSite
+ /api/rgw/topic:
get:
parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Get RGW Topic List
tags:
- - RgwRealm
- /api/rgw/realm/import_realm_token:
+ - RGW Topic Management
post:
parameters: []
requestBody:
application/json:
schema:
properties:
- placement_spec:
+ ack_level:
+ description: Amqp ack level
type: string
- port:
+ amqp_exchange:
+ description: Amqp exchange
type: string
- realm_token:
+ ca_location:
+ description: Ca location
type: string
- zone_name:
+ cloud_events:
+ default: false
+ description: Cloud events
+ type: string
+ daemon_name:
+ description: Name of the daemon
+ type: string
+ kafka_brokers:
+ description: Kafka brokers
+ type: string
+ max_retries:
+ description: Max retries
+ type: string
+ mechanism:
+ description: Mechanism
+ type: string
+ name:
+ description: Name of the topic
+ type: string
+ opaque_data:
+ description: OpaqueData
+ type: string
+ owner:
+ description: Name of the owner
+ type: string
+ persistent:
+ default: false
+ description: Persistent
+ type: boolean
+ policy:
+ description: Policy
+ type: string
+ push_endpoint:
+ description: Push Endpoint
+ type: string
+ retry_sleep_duration:
+ description: Retry sleep duration
type: string
+ time_to_live:
+ description: Time to live
+ type: string
+ use_ssl:
+ default: false
+ description: Use ssl
+ type: boolean
+ verify_ssl:
+ default: false
+ description: Verify ssl
+ type: boolean
required:
- - realm_token
- - zone_name
- - port
+ - name
type: object
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Create a new RGW Topic
tags:
- - RgwRealm
- /api/rgw/realm/{realm_name}:
+ - RGW Topic Management
+ /api/rgw/topic/{key}:
delete:
parameters:
- - in: path
- name: realm_name
+ - description: The metadata object key to retrieve the topic e.g topic:topic_name
+ in: path
+ name: key
required: true
schema:
type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Delete RGW Topic
tags:
- - RgwRealm
+ - RGW Topic Management
get:
parameters:
- - in: path
- name: realm_name
+ - description: The metadata object key to retrieve the topic e.g owner:topic_name
+ in: path
+ name: key
required: true
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Get RGW Topic
tags:
- - RgwRealm
- put:
+ - RGW Topic Management
+ /api/rgw/user:
+ get:
parameters:
- - in: path
- name: realm_name
- required: true
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
schema:
type: string
+ - default: false
+ description: If true, returns complete user details for each user. If false,
+ returns only the list of usernames.
+ in: query
+ name: detailed
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ list_of_users:
+ description: list of rgw users
+ items:
+ type: string
+ type: array
+ required: &id123
+ - list_of_users
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ list_of_users:
+ description: list of rgw users
+ items:
+ type: string
+ type: array
+ required: *id123
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Display RGW Users
+ tags:
+ - RgwUser
+ post:
+ description: Create a new RGW user.
+ parameters: []
requestBody:
content:
application/json:
schema:
properties:
- default:
- default: ''
+ access_key:
type: string
- new_realm_name:
+ account_id:
+ type: integer
+ account_policies:
+ type: integer
+ account_root_user:
+ default: false
+ type: integer
+ daemon_name:
+ type: string
+ display_name:
+ type: string
+ email:
+ type: string
+ generate_key:
+ type: string
+ max_buckets:
+ type: string
+ secret_key:
+ type: string
+ suspended:
+ type: string
+ system:
+ type: string
+ uid:
type: string
required:
- - new_realm_name
+ - uid
+ - display_name
type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwRealm
- /api/rgw/roles:
+ - RgwUser
+ /api/rgw/user/get_emails:
get:
- parameters: []
+ parameters:
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: List RGW roles
- tags:
- - RGW
- post:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- role_assume_policy_doc:
- default: ''
- type: string
- role_name:
- default: ''
- type: string
- role_path:
- default: ''
- type: string
- type: object
- responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Create RGW role
tags:
- - RGW
- put:
+ - RgwUser
+ /api/rgw/user/ratelimit:
+ get:
parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- max_session_duration:
- type: string
- role_name:
- type: string
- required:
- - role_name
- - max_session_duration
- type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Edit RGW role
+ summary: Get the user global rate limit
tags:
- - RGW
- /api/rgw/roles/{role_name}:
+ - RgwUser
+ /api/rgw/user/{uid}:
delete:
parameters:
- in: path
- name: role_name
+ name: uid
required: true
schema:
type: string
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Delete RGW role
tags:
- - RGW
- /api/rgw/site:
+ - RgwUser
get:
parameters:
- - allowEmptyValue: true
- in: query
- name: query
+ - in: path
+ name: uid
+ required: true
schema:
type: string
- allowEmptyValue: true
name: daemon_name
schema:
type: string
+ - default: true
+ in: query
+ name: stats
+ schema:
+ type: boolean
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwSite
- /api/rgw/topic:
- get:
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get RGW Topic List
tags:
- - RGW Topic Management
- post:
- parameters: []
+ - RgwUser
+ put:
+ description: Update an existing RGW user.
+ parameters:
+ - in: path
+ name: uid
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- ack_level:
- description: Amqp ack level
- type: string
- amqp_exchange:
- description: Amqp exchange
- type: string
- ca_location:
- description: Ca location
- type: string
- cloud_events:
+ account_id:
+ type: integer
+ account_policies:
+ type: integer
+ account_root_user:
default: false
- description: Cloud events
- type: string
+ type: integer
daemon_name:
- description: Name of the daemon
- type: string
- kafka_brokers:
- description: Kafka brokers
- type: string
- max_retries:
- description: Max retries
- type: string
- mechanism:
- description: Mechanism
- type: string
- name:
- description: Name of the topic
- type: string
- opaque_data:
- description: OpaqueData
type: string
- owner:
- description: Name of the owner
+ display_name:
type: string
- persistent:
- default: false
- description: Persistent
- type: boolean
- policy:
- description: Policy
+ email:
type: string
- push_endpoint:
- description: Push Endpoint
+ max_buckets:
type: string
- retry_sleep_duration:
- description: Retry sleep duration
+ suspended:
type: string
- time_to_live:
- description: Time to live
+ system:
type: string
- use_ssl:
- default: false
- description: Use ssl
- type: boolean
- verify_ssl:
- default: false
- description: Verify ssl
- type: boolean
- required:
- - name
type: object
responses:
- '201':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
+ schema:
+ type: object
+ description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Create a new RGW Topic
tags:
- - RGW Topic Management
- /api/rgw/topic/{key}:
+ - RgwUser
+ /api/rgw/user/{uid}/capability:
delete:
parameters:
- - description: The metadata object key to retrieve the topic e.g topic:topic_name
- in: path
- name: key
+ - in: path
+ name: uid
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: type
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: perm
required: true
schema:
type: string
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Delete RGW Topic
tags:
- - RGW Topic Management
- get:
+ - RgwUser
+ post:
parameters:
- - description: The metadata object key to retrieve the topic e.g owner:topic_name
- in: path
- name: key
+ - in: path
+ name: uid
required: true
schema:
type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ daemon_name:
+ type: string
+ perm:
+ type: string
+ type:
+ type: string
+ required:
+ - type
+ - perm
+ type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Resource created.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Get RGW Topic
tags:
- - RGW Topic Management
- /api/rgw/user:
- get:
+ - RgwUser
+ /api/rgw/user/{uid}/key:
+ delete:
parameters:
+ - in: path
+ name: uid
+ required: true
+ schema:
+ type: string
+ - default: s3
+ in: query
+ name: key_type
+ schema:
+ type: string
- allowEmptyValue: true
in: query
- name: daemon_name
+ name: subuser
schema:
type: string
- - default: false
- description: If true, returns complete user details for each user. If false,
- returns only the list of usernames.
+ - allowEmptyValue: true
in: query
- name: detailed
+ name: access_key
schema:
- type: boolean
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
responses:
- '200':
+ '202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
- properties:
- list_of_users:
- description: list of rgw users
- items:
- type: string
- type: array
- required:
- - list_of_users
type: object
- description: OK
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Display RGW Users
tags:
- RgwUser
post:
- description: Create a new RGW user.
- parameters: []
+ parameters:
+ - in: path
+ name: uid
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
properties:
access_key:
type: string
- account_id:
- type: integer
- account_policies:
- type: integer
- account_root_user:
- default: false
- type: integer
daemon_name:
type: string
- display_name:
- type: string
- email:
- type: string
generate_key:
+ default: 'true'
type: string
- max_buckets:
+ key_type:
+ default: s3
type: string
secret_key:
type: string
- suspended:
- type: string
- system:
- type: string
- uid:
+ subuser:
type: string
- required:
- - uid
- - display_name
type: object
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- RgwUser
- /api/rgw/user/get_emails:
+ /api/rgw/user/{uid}/quota:
get:
parameters:
+ - in: path
+ name: uid
+ required: true
+ schema:
+ type: string
- allowEmptyValue: true
in: query
name: daemon_name
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwUser
- /api/rgw/user/ratelimit:
- get:
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get the user global rate limit
tags:
- RgwUser
- /api/rgw/user/{uid}:
- delete:
+ put:
parameters:
- in: path
name: uid
required: true
schema:
type: string
- - allowEmptyValue: true
- in: query
- name: daemon_name
- schema:
- type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ daemon_name:
+ type: string
+ enabled:
+ type: string
+ max_objects:
+ type: string
+ max_size_kb:
+ type: integer
+ quota_type:
+ type: string
+ required:
+ - quota_type
+ - enabled
+ - max_size_kb
+ - max_objects
+ type: object
responses:
- '202':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
- jwt: []
tags:
- RgwUser
+ /api/rgw/user/{uid}/ratelimit:
get:
parameters:
- in: path
name: uid
required: true
schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: daemon_name
- schema:
- type: string
- - default: true
- in: query
- name: stats
- schema:
- type: boolean
+ type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Get the user rate limit
tags:
- RgwUser
put:
- description: Update an existing RGW user.
parameters:
- in: path
name: uid
application/json:
schema:
properties:
- account_id:
+ enabled:
+ default: false
+ type: boolean
+ max_read_bytes:
+ default: 0
type: integer
- account_policies:
+ max_read_ops:
+ default: 0
type: integer
- account_root_user:
- default: false
+ max_write_bytes:
+ default: 0
+ type: integer
+ max_write_ops:
+ default: 0
type: integer
- daemon_name:
- type: string
- display_name:
- type: string
- email:
- type: string
- max_buckets:
- type: string
- suspended:
- type: string
- system:
- type: string
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwUser
- /api/rgw/user/{uid}/capability:
- delete:
- parameters:
- - in: path
- name: uid
- required: true
- schema:
- type: string
- - in: query
- name: type
- required: true
- schema:
- type: string
- - in: query
- name: perm
- required: true
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: daemon_name
- schema:
- type: string
- responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
- '204':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Update the user rate limit
tags:
- RgwUser
+ /api/rgw/user/{uid}/subuser:
post:
parameters:
- in: path
application/json:
schema:
properties:
+ access:
+ type: string
+ access_key:
+ type: string
daemon_name:
type: string
- perm:
+ generate_secret:
+ default: 'true'
type: string
- type:
+ key_type:
+ default: s3
+ type: string
+ secret_key:
+ type: string
+ subuser:
type: string
required:
- - type
- - perm
+ - subuser
+ - access
type: object
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- RgwUser
- /api/rgw/user/{uid}/key:
+ /api/rgw/user/{uid}/subuser/{subuser}:
delete:
+ description: "\n :param purge_keys: Set to False to do not purge the\
+ \ keys.\n Note, this only works for s3 subusers.\n\
+ \ "
parameters:
- in: path
name: uid
required: true
schema:
type: string
- - default: s3
- in: query
- name: key_type
- schema:
- type: string
- - allowEmptyValue: true
- in: query
+ - in: path
name: subuser
+ required: true
schema:
type: string
- - allowEmptyValue: true
+ - default: 'true'
in: query
- name: access_key
+ name: purge_keys
schema:
type: string
- allowEmptyValue: true
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- RgwUser
+ /api/rgw/zone:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - RgwZone
post:
- parameters:
- - in: path
- name: uid
- required: true
- schema:
- type: string
+ parameters: []
requestBody:
content:
application/json:
properties:
access_key:
type: string
- daemon_name:
+ default:
+ default: false
+ type: boolean
+ master:
+ default: false
+ type: boolean
+ secret_key:
type: string
- generate_key:
- default: 'true'
+ tier_type:
+ default: ''
type: string
- key_type:
- default: s3
+ zone_endpoints:
type: string
- secret_key:
+ zone_name:
type: string
- subuser:
+ zonegroup_name:
type: string
+ required:
+ - zone_name
type: object
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - RgwZone
+ /api/rgw/zone/create_system_user:
+ put:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ userName:
+ type: string
+ zoneName:
+ type: string
+ required:
+ - userName
+ - zoneName
+ type: object
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwUser
- /api/rgw/user/{uid}/quota:
+ - RgwZone
+ /api/rgw/zone/get_all_zones_info:
get:
- parameters:
- - in: path
- name: uid
- required: true
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: daemon_name
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwUser
- put:
- parameters:
- - in: path
- name: uid
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- daemon_name:
- type: string
- enabled:
- type: string
- max_objects:
- type: string
- max_size_kb:
- type: integer
- quota_type:
- type: string
- required:
- - quota_type
- - enabled
- - max_size_kb
- - max_objects
- type: object
+ - RgwZone
+ /api/rgw/zone/get_pool_names:
+ get:
+ parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - RgwUser
- /api/rgw/user/{uid}/ratelimit:
+ - RgwZone
+ /api/rgw/zone/get_user_list:
get:
parameters:
- - in: path
- name: uid
- required: true
+ - allowEmptyValue: true
+ in: query
+ name: zoneName
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: realmName
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get the user rate limit
tags:
- - RgwUser
- put:
- parameters:
- - in: path
- name: uid
- required: true
- schema:
- type: string
+ - RgwZone
+ /api/rgw/zone/storage-class:
+ post:
+ parameters: []
requestBody:
content:
application/json:
schema:
properties:
- enabled:
- default: false
- type: boolean
- max_read_bytes:
- default: 0
- type: integer
- max_read_ops:
- default: 0
- type: integer
- max_write_bytes:
- default: 0
- type: integer
- max_write_ops:
- default: 0
- type: integer
+ compression:
+ default: ''
+ type: string
+ data_pool:
+ type: string
+ placement_target:
+ type: string
+ storage_class:
+ type: string
+ zone_name:
+ type: string
+ required:
+ - zone_name
+ - placement_target
+ - storage_class
+ - data_pool
type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Update the user rate limit
tags:
- - RgwUser
- /api/rgw/user/{uid}/subuser:
- post:
- parameters:
- - in: path
- name: uid
- required: true
- schema:
- type: string
+ - RgwZone
+ put:
+ parameters: []
requestBody:
content:
application/json:
schema:
properties:
- access:
- type: string
- access_key:
- type: string
- daemon_name:
+ compression:
+ default: ''
type: string
- generate_secret:
- default: 'true'
+ data_pool:
type: string
- key_type:
- default: s3
+ placement_target:
type: string
- secret_key:
+ storage_class:
type: string
- subuser:
+ zone_name:
type: string
required:
- - subuser
- - access
+ - zone_name
+ - placement_target
+ - storage_class
+ - data_pool
type: object
responses:
- '201':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
+ schema:
+ type: object
+ description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwUser
- /api/rgw/user/{uid}/subuser/{subuser}:
+ - RgwZone
+ /api/rgw/zone/{zone_name}:
delete:
- description: "\n :param purge_keys: Set to False to do not purge the\
- \ keys.\n Note, this only works for s3 subusers.\n\
- \ "
parameters:
- in: path
- name: uid
+ name: zone_name
required: true
schema:
type: string
- - in: path
- name: subuser
+ - in: query
+ name: delete_pools
required: true
schema:
type: string
- - default: 'true'
+ - allowEmptyValue: true
in: query
- name: purge_keys
+ name: pools
schema:
type: string
- allowEmptyValue: true
in: query
- name: daemon_name
+ name: zonegroup_name
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: realm_name
schema:
type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwUser
- /api/rgw/zone:
+ - RgwZone
get:
- parameters: []
+ parameters:
+ - in: path
+ name: zone_name
+ required: true
+ schema:
+ type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- RgwZone
- post:
- parameters: []
+ put:
+ parameters:
+ - in: path
+ name: zone_name
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
access_key:
+ default: ''
+ type: string
+ compression:
+ default: ''
+ type: string
+ data_extra_pool:
+ default: ''
+ type: string
+ data_pool:
+ default: ''
+ type: string
+ data_pool_class:
+ default: ''
type: string
default:
- default: false
- type: boolean
+ default: ''
+ type: string
+ index_pool:
+ default: ''
+ type: string
master:
- default: false
- type: boolean
+ default: ''
+ type: string
+ new_zone_name:
+ type: string
+ placement_target:
+ default: ''
+ type: string
secret_key:
+ default: ''
+ type: string
+ storage_class:
+ default: ''
type: string
tier_type:
default: ''
type: string
zone_endpoints:
- type: string
- zone_name:
+ default: ''
type: string
zonegroup_name:
type: string
required:
- - zone_name
+ - new_zone_name
+ - zonegroup_name
type: object
responses:
- '201':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
+ schema:
+ type: object
+ description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- RgwZone
- /api/rgw/zone/create_system_user:
- put:
+ /api/rgw/zonegroup:
+ get:
parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- userName:
- type: string
- zoneName:
- type: string
- required:
- - userName
- - zoneName
- type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - RgwZone
- /api/rgw/zone/get_all_zones_info:
- get:
+ - RgwZonegroup
+ post:
parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ default:
+ type: string
+ master:
+ type: string
+ realm_name:
+ type: string
+ zonegroup_endpoints:
+ type: string
+ zonegroup_name:
+ type: string
+ required:
+ - realm_name
+ - zonegroup_name
+ type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Resource created.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - RgwZone
- /api/rgw/zone/get_pool_names:
+ - RgwZonegroup
+ /api/rgw/zonegroup/get_all_zonegroups_info:
get:
parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwZone
- /api/rgw/zone/get_user_list:
+ - RgwZonegroup
+ /api/rgw/zonegroup/get_placement_target_by_placement_id/{placement_id}:
get:
parameters:
- - allowEmptyValue: true
- in: query
- name: zoneName
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: realmName
+ - in: path
+ name: placement_id
+ required: true
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwZone
- /api/rgw/zone/storage-class:
+ - RgwZonegroup
+ /api/rgw/zonegroup/storage-class:
post:
parameters: []
requestBody:
application/json:
schema:
properties:
- compression:
- default: ''
- type: string
- data_pool:
- type: string
- placement_target:
- type: string
- storage_class:
+ placement_targets:
+ default: []
type: string
- zone_name:
+ zone_group:
type: string
required:
- - zone_name
- - placement_target
- - storage_class
- - data_pool
+ - zone_group
type: object
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwZone
+ - RgwZonegroup
put:
parameters: []
requestBody:
application/json:
schema:
properties:
- compression:
- default: ''
- type: string
- data_pool:
- type: string
- placement_target:
- type: string
- storage_class:
+ placement_targets:
+ default: []
type: string
- zone_name:
+ zone_group:
type: string
required:
- - zone_name
- - placement_target
- - storage_class
- - data_pool
+ - zone_group
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwZone
- /api/rgw/zone/{zone_name}:
+ - RgwZonegroup
+ /api/rgw/zonegroup/storage-class/{placement_id}/{storage_class}:
+ delete:
+ parameters:
+ - in: path
+ name: placement_id
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: storage_class
+ required: true
+ schema:
+ type: string
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - RgwZonegroup
+ /api/rgw/zonegroup/{zonegroup_name}:
delete:
parameters:
- in: path
- name: zone_name
+ name: zonegroup_name
required: true
schema:
type: string
name: pools
schema:
type: string
- - allowEmptyValue: true
- in: query
- name: zonegroup_name
- schema:
- type: string
- allowEmptyValue: true
in: query
name: realm_name
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwZone
+ - RgwZonegroup
get:
parameters:
- in: path
- name: zone_name
+ name: zonegroup_name
required: true
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwZone
+ - RgwZonegroup
put:
parameters:
- in: path
- name: zone_name
+ name: zonegroup_name
required: true
schema:
type: string
application/json:
schema:
properties:
- access_key:
- default: ''
- type: string
- compression:
- default: ''
- type: string
- data_extra_pool:
- default: ''
- type: string
- data_pool:
- default: ''
- type: string
- data_pool_class:
- default: ''
+ add_zones:
+ default: []
type: string
default:
default: ''
type: string
- index_pool:
- default: ''
- type: string
master:
default: ''
type: string
- new_zone_name:
- type: string
- placement_target:
- default: ''
+ new_zonegroup_name:
type: string
- secret_key:
- default: ''
+ placement_targets:
+ default: []
type: string
- storage_class:
- default: ''
+ realm_name:
type: string
- tier_type:
- default: ''
+ remove_zones:
+ default: []
type: string
- zone_endpoints:
+ zonegroup_endpoints:
default: ''
type: string
- zonegroup_name:
- type: string
required:
- - new_zone_name
- - zonegroup_name
+ - realm_name
+ - new_zonegroup_name
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwZone
- /api/rgw/zonegroup:
- get:
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwZonegroup
- post:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- default:
- type: string
- master:
- type: string
- realm_name:
- type: string
- zonegroup_endpoints:
- type: string
- zonegroup_name:
- type: string
- required:
- - realm_name
- - zonegroup_name
- type: object
- responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- RgwZonegroup
- /api/rgw/zonegroup/get_all_zonegroups_info:
+ /api/role:
get:
parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ items:
+ properties:
+ description:
+ description: Role Descriptions
+ type: string
+ name:
+ description: Role Name
+ type: string
+ scopes_permissions:
+ description: ''
+ properties:
+ cephfs:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: &id124
+ - cephfs
+ type: object
+ system:
+ description: ''
+ type: boolean
+ type: object
+ required: &id125
+ - name
+ - description
+ - scopes_permissions
+ - system
+ type: array
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwZonegroup
- /api/rgw/zonegroup/get_placement_target_by_placement_id/{placement_id}:
- get:
- parameters:
- - in: path
- name: placement_id
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - RgwZonegroup
- /api/rgw/zonegroup/storage-class:
- post:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- placement_targets:
- default: []
- type: string
- zone_group:
- type: string
- required:
- - zone_group
- type: object
- responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ items:
+ properties:
+ description:
+ description: Role Descriptions
+ type: string
+ name:
+ description: Role Name
+ type: string
+ scopes_permissions:
+ description: ''
+ properties:
+ cephfs:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: *id124
+ type: object
+ system:
+ description: ''
+ type: boolean
+ type: object
+ required: *id125
+ type: array
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Display Role list
tags:
- - RgwZonegroup
- put:
+ - Role
+ post:
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- placement_targets:
- default: []
+ description:
type: string
- zone_group:
+ name:
+ type: string
+ scopes_permissions:
type: string
- required:
- - zone_group
type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwZonegroup
- /api/rgw/zonegroup/storage-class/{placement_id}/{storage_class}:
+ - Role
+ /api/role/{name}:
delete:
parameters:
- in: path
- name: placement_id
- required: true
- schema:
- type: string
- - in: path
- name: storage_class
+ name: name
required: true
schema:
type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwZonegroup
- /api/rgw/zonegroup/{zonegroup_name}:
- delete:
+ - Role
+ get:
parameters:
- in: path
- name: zonegroup_name
- required: true
- schema:
- type: string
- - in: query
- name: delete_pools
+ name: name
required: true
schema:
type: string
- - allowEmptyValue: true
- in: query
- name: pools
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: realm_name
- schema:
- type: string
responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - RgwZonegroup
- get:
+ - Role
+ put:
parameters:
- in: path
- name: zonegroup_name
+ name: name
required: true
schema:
type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ description:
+ type: string
+ scopes_permissions:
+ type: string
+ type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - RgwZonegroup
- put:
+ - Role
+ /api/role/{name}/clone:
+ post:
parameters:
- in: path
- name: zonegroup_name
+ name: name
required: true
schema:
type: string
application/json:
schema:
properties:
- add_zones:
- default: []
- type: string
- default:
- default: ''
- type: string
- master:
- default: ''
- type: string
- new_zonegroup_name:
- type: string
- placement_targets:
- default: []
- type: string
- realm_name:
- type: string
- remove_zones:
- default: []
- type: string
- zonegroup_endpoints:
- default: ''
+ new_name:
type: string
required:
- - realm_name
- - new_zonegroup_name
+ - new_name
type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - RgwZonegroup
- /api/role:
+ - Role
+ /api/service:
get:
- parameters: []
+ parameters:
+ - allowEmptyValue: true
+ in: query
+ name: service_name
+ schema:
+ type: string
+ - default: 0
+ in: query
+ name: offset
+ schema:
+ type: integer
+ - default: 5
+ in: query
+ name: limit
+ schema:
+ type: integer
+ - default: ''
+ in: query
+ name: search
+ schema:
+ type: string
+ - default: +service_name
+ in: query
+ name: sort
+ schema:
+ type: string
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
- items:
- properties:
- description:
- description: Role Descriptions
- type: string
- name:
- description: Role Name
- type: string
- scopes_permissions:
- description: ''
- properties:
- cephfs:
- description: ''
- items:
- type: string
- type: array
- required:
- - cephfs
- type: object
- system:
- description: ''
- type: boolean
- type: object
- required:
- - name
- - description
- - scopes_permissions
- - system
- type: array
+ type: object
+ application/vnd.ceph.api.v2.0+json:
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Display Role list
tags:
- - Role
+ - Service
post:
+ description: "\n :param service_spec: The service specification as JSON.\n\
+ \ :param service_name: The service name, e.g. 'alertmanager'.\n \
+ \ :return: None\n "
parameters: []
requestBody:
content:
application/json:
- schema:
- properties:
- description:
- type: string
- name:
+ schema:
+ properties:
+ service_name:
type: string
- scopes_permissions:
+ service_spec:
type: string
+ required:
+ - service_spec
+ - service_name
type: object
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Role
- /api/role/{name}:
- delete:
+ - Service
+ /api/service/certificate:
+ get:
+ description: "\n List all certificates configured in the cluster.\n\n\
+ \ This endpoint returns a list of all certificates managed by certmgr,\n\
+ \ including both user-provided and cephadm-signed certificates.\n\n\
+ \ :param status: Filter by certificate status. Valid values: 'expired',\n\
+ \ 'expiring', 'valid', 'invalid'\n :param scope: Filter\
+ \ by certificate scope. Valid values: 'SERVICE',\n 'HOST', 'GLOBAL'\n\
+ \ :param service_type: Filter by service type. Supports wildcards\n\
+ \ (e.g., 'rgw*')\n :param include_cephadm_signed: If True,\
+ \ include cephadm-signed certificates.\n If False (default), only\
+ \ user-provided certificates are returned.\n :return: List of certificate\
+ \ objects with their details\n "
parameters:
- - in: path
- name: name
- required: true
+ - allowEmptyValue: true
+ description: Filter by certificate status (e.g., "expired", "expiring", "valid",
+ "invalid")
+ in: query
+ name: status
+ schema:
+ type: string
+ - allowEmptyValue: true
+ description: Filter by certificate scope (e.g., "service", "host", "global")
+ in: query
+ name: scope
+ schema:
+ type: string
+ - allowEmptyValue: true
+ description: Filter by certificate type (e.g., "rgw*")
+ in: query
+ name: service_type
schema:
type: string
+ - default: false
+ description: 'Include cephadm-signed certificates in the list (default: False)'
+ in: query
+ name: include_cephadm_signed
+ schema:
+ type: boolean
responses:
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ '200':
content:
+ application/json:
+ schema:
+ items:
+ properties:
+ cert_name:
+ description: Certificate name
+ type: string
+ common_name:
+ description: Certificate common name (CN)
+ type: string
+ days_to_expiration:
+ description: Days remaining until expiration
+ type: integer
+ expiry_date:
+ description: Certificate expiration date
+ type: string
+ issuer:
+ description: Certificate issuer distinguished name
+ type: string
+ scope:
+ description: Certificate scope (SERVICE, HOST, or GLOBAL)
+ type: string
+ signed_by:
+ description: Certificate issuer (user or cephadm)
+ type: string
+ status:
+ description: Certificate status (valid, expiring, expired, invalid)
+ type: string
+ target:
+ description: Certificate target (service name or hostname)
+ type: string
+ type: object
+ required: &id126
+ - cert_name
+ - scope
+ - signed_by
+ - status
+ - days_to_expiration
+ - expiry_date
+ - issuer
+ - common_name
+ - target
+ type: array
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource deleted.
+ schema:
+ items:
+ properties:
+ cert_name:
+ description: Certificate name
+ type: string
+ common_name:
+ description: Certificate common name (CN)
+ type: string
+ days_to_expiration:
+ description: Days remaining until expiration
+ type: integer
+ expiry_date:
+ description: Certificate expiration date
+ type: string
+ issuer:
+ description: Certificate issuer distinguished name
+ type: string
+ scope:
+ description: Certificate scope (SERVICE, HOST, or GLOBAL)
+ type: string
+ signed_by:
+ description: Certificate issuer (user or cephadm)
+ type: string
+ status:
+ description: Certificate status (valid, expiring, expired, invalid)
+ type: string
+ target:
+ description: Certificate target (service name or hostname)
+ type: string
+ type: object
+ required: *id126
+ type: array
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: List All Certificates
tags:
- - Role
+ - Service
+ /api/service/certificate/root-ca:
get:
- parameters:
- - in: path
- name: name
- required: true
- schema:
- type: string
+ description: "\n Get the cephadm root CA certificate.\n\n This\
+ \ endpoint returns the root Certificate Authority (CA) certificate\n \
+ \ used by cephadm to sign other certificates in the cluster.\n\n \
+ \ :return: Dictionary with certificate field containing root CA certificate\
+ \ in PEM format\n "
+ parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ properties:
+ certificate:
+ description: Root CA certificate in PEM format
+ type: string
+ required: &id127
+ - certificate
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ properties:
+ certificate:
+ description: Root CA certificate in PEM format
+ type: string
+ required: *id127
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Get Root CA Certificate
tags:
- - Role
- put:
+ - Service
+ /api/service/certificate/{service_name}:
+ get:
+ description: "\n Get detailed certificate information for a service.\n\
+ \n :param service_name: The service name, e.g. 'rgw.myzone'.\n \
+ \ :return: Detailed certificate information including full certificate\
+ \ details\n "
parameters:
- in: path
- name: name
+ name: service_name
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- description:
- type: string
- scopes_permissions:
- type: string
- type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
- '202':
+ schema:
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ tags:
+ - Service
+ /api/service/known_types:
+ get:
+ description: "\n Get a list of known service types, e.g. 'alertmanager',\n\
+ \ 'node-exporter', 'osd' or 'rgw'.\n "
+ parameters: []
+ responses:
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Role
- /api/role/{name}/clone:
- post:
+ - Service
+ /api/service/{service_name}:
+ delete:
+ description: "\n :param service_name: The service name, e.g. 'mds' or\
+ \ 'crash.foo'.\n :return: None\n "
parameters:
- in: path
- name: name
+ name: service_name
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- new_name:
- type: string
- required:
- - new_name
- type: object
responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
+ '204':
+ content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Role
- /api/service:
+ - Service
get:
parameters:
- - allowEmptyValue: true
- in: query
+ - in: path
name: service_name
- schema:
- type: string
- - default: 0
- in: query
- name: offset
- schema:
- type: integer
- - default: 5
- in: query
- name: limit
- schema:
- type: integer
- - default: ''
- in: query
- name: search
- schema:
- type: string
- - default: +service_name
- in: query
- name: sort
+ required: true
schema:
type: string
responses:
'200':
content:
- application/vnd.ceph.api.v2.0+json:
- type: object
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- Service
- post:
+ put:
description: "\n :param service_spec: The service specification as JSON.\n\
\ :param service_name: The service name, e.g. 'alertmanager'.\n \
\ :return: None\n "
- parameters: []
+ parameters:
+ - in: path
+ name: service_name
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- service_name:
- type: string
service_spec:
type: string
required:
- service_spec
- - service_name
type: object
responses:
- '201':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
+ schema:
+ type: object
+ description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
- jwt: []
tags:
- Service
- /api/service/certificate:
+ /api/service/{service_name}/daemons:
get:
- description: "\n List all certificates configured in the cluster.\n\n\
- \ This endpoint returns a list of all certificates managed by certmgr,\n\
- \ including both user-provided and cephadm-signed certificates.\n\n\
- \ :param status: Filter by certificate status. Valid values: 'expired',\n\
- \ 'expiring', 'valid', 'invalid'\n :param scope: Filter\
- \ by certificate scope. Valid values: 'SERVICE',\n 'HOST', 'GLOBAL'\n\
- \ :param service_type: Filter by service type. Supports wildcards\n\
- \ (e.g., 'rgw*')\n :param include_cephadm_signed: If True,\
- \ include cephadm-signed certificates.\n If False (default), only\
- \ user-provided certificates are returned.\n :return: List of certificate\
- \ objects with their details\n "
parameters:
- - allowEmptyValue: true
- description: Filter by certificate status (e.g., "expired", "expiring", "valid",
- "invalid")
- in: query
- name: status
- schema:
- type: string
- - allowEmptyValue: true
- description: Filter by certificate scope (e.g., "service", "host", "global")
- in: query
- name: scope
- schema:
- type: string
- - allowEmptyValue: true
- description: Filter by certificate type (e.g., "rgw*")
- in: query
- name: service_type
+ - in: path
+ name: service_name
+ required: true
schema:
type: string
- - default: false
- description: 'Include cephadm-signed certificates in the list (default: False)'
- in: query
- name: include_cephadm_signed
- schema:
- type: boolean
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
- items:
- properties:
- cert_name:
- description: Certificate name
- type: string
- common_name:
- description: Certificate common name (CN)
- type: string
- days_to_expiration:
- description: Days remaining until expiration
- type: integer
- expiry_date:
- description: Certificate expiration date
- type: string
- issuer:
- description: Certificate issuer distinguished name
- type: string
- scope:
- description: Certificate scope (SERVICE, HOST, or GLOBAL)
- type: string
- signed_by:
- description: Certificate issuer (user or cephadm)
- type: string
- status:
- description: Certificate status (valid, expiring, expired, invalid)
- type: string
- target:
- description: Certificate target (service name or hostname)
- type: string
- type: object
- required:
- - cert_name
- - scope
- - signed_by
- - status
- - days_to_expiration
- - expiry_date
- - issuer
- - common_name
- - target
- type: array
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: List All Certificates
- tags:
- - Service
- /api/service/certificate/root-ca:
- get:
- description: "\n Get the cephadm root CA certificate.\n\n This\
- \ endpoint returns the root Certificate Authority (CA) certificate\n \
- \ used by cephadm to sign other certificates in the cluster.\n\n \
- \ :return: Dictionary with certificate field containing root CA certificate\
- \ in PEM format\n "
- parameters: []
- responses:
- '200':
- content:
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
- properties:
- certificate:
- description: Root CA certificate in PEM format
- type: string
- required:
- - certificate
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get Root CA Certificate
tags:
- Service
- /api/service/certificate/{service_name}:
+ /api/settings:
get:
- description: "\n Get detailed certificate information for a service.\n\
- \n :param service_name: The service name, e.g. 'rgw.myzone'.\n \
- \ :return: Detailed certificate information including full certificate\
- \ details\n "
+ description: "\n Get the list of available options.\n :param names:\
+ \ A comma separated list of option names that should\n be processed.\
+ \ Defaults to ``None``.\n :type names: None|str\n :return: A\
+ \ list of available options.\n :rtype: list[dict]\n "
parameters:
- - in: path
- name: service_name
- required: true
+ - allowEmptyValue: true
+ description: Name of Settings
+ in: query
+ name: names
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ items:
+ properties:
+ default:
+ description: Default Settings
+ type: boolean
+ name:
+ description: Settings Name
+ type: string
+ type:
+ description: Type of Settings
+ type: string
+ value:
+ description: Settings Value
+ type: boolean
+ type: object
+ required: &id128
+ - name
+ - default
+ - type
+ - value
+ type: array
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ items:
+ properties:
+ default:
+ description: Default Settings
+ type: boolean
+ name:
+ description: Settings Name
+ type: string
+ type:
+ description: Type of Settings
+ type: string
+ value:
+ description: Settings Value
+ type: boolean
+ type: object
+ required: *id128
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Display Settings Information
tags:
- - Service
- /api/service/known_types:
- get:
- description: "\n Get a list of known service types, e.g. 'alertmanager',\n\
- \ 'node-exporter', 'osd' or 'rgw'.\n "
+ - Settings
+ put:
parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
+ content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
+ schema:
+ type: object
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Service
- /api/service/{service_name}:
+ - Settings
+ /api/settings/{name}:
delete:
- description: "\n :param service_name: The service name, e.g. 'mds' or\
- \ 'crash.foo'.\n :return: None\n "
parameters:
- in: path
- name: service_name
+ name: name
required: true
schema:
type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Service
+ - Settings
get:
+ description: "\n Get the given option.\n :param name: The name\
+ \ of the option.\n :return: Returns a dict containing the name, type,\n\
+ \ default value and current value of the given option.\n :rtype:\
+ \ dict\n "
parameters:
- in: path
- name: service_name
+ name: name
required: true
schema:
type: string
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Service
+ - Settings
put:
- description: "\n :param service_spec: The service specification as JSON.\n\
- \ :param service_name: The service name, e.g. 'alertmanager'.\n \
- \ :return: None\n "
parameters:
- in: path
- name: service_name
+ name: name
required: true
schema:
type: string
application/json:
schema:
properties:
- service_spec:
+ value:
type: string
required:
- - service_spec
+ - value
type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
security:
- jwt: []
tags:
- - Service
- /api/service/{service_name}/daemons:
- get:
- parameters:
- - in: path
- name: service_name
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Service
- /api/settings:
+ - Settings
+ /api/smb/cluster:
get:
- description: "\n Get the list of available options.\n :param names:\
- \ A comma separated list of option names that should\n be processed.\
- \ Defaults to ``None``.\n :type names: None|str\n :return: A\
- \ list of available options.\n :rtype: list[dict]\n "
- parameters:
- - allowEmptyValue: true
- description: Name of Settings
- in: query
- name: names
- schema:
- type: string
+ description: "\n List smb clusters\n "
+ parameters: []
responses:
'200':
content:
+ application/json:
+ schema:
+ items:
+ properties:
+ auth_mode:
+ description: Either 'active-directory' or 'user'
+ type: string
+ cluster_id:
+ description: Unique identifier for the cluster
+ type: string
+ custom_dns:
+ description: List of custom DNS server addresses
+ items:
+ type: string
+ type: array
+ domain_settings:
+ description: Domain-specific settings for active-directory auth
+ mode
+ properties:
+ join_sources:
+ description: List of join auth sources for domain settings
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the join auth
+ resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: &id129
+ - source_type
+ - ref
+ type: object
+ type: array
+ realm:
+ description: Domain realm, e.g., 'DOMAIN1.SINK.TEST'
+ type: string
+ required: &id130
+ - realm
+ - join_sources
+ type: object
+ intent:
+ description: Desired state of the resource, e.g., 'present'
+ or 'removed'
+ type: string
+ placement:
+ description: Placement configuration for the resource
+ properties:
+ count:
+ description: Number of instances to place
+ type: integer
+ required: &id131
+ - count
+ type: object
+ public_addrs:
+ description: Public Address
+ items:
+ properties:
+ address:
+ description: This address will be assigned to one of the
+ host's network devices
+ type: string
+ destination:
+ description: Defines where the system will assign the
+ managed IPs.
+ type: string
+ required: &id132
+ - address
+ - destination
+ type: object
+ type: array
+ resource_type:
+ description: ceph.smb.cluster
+ type: string
+ user_group_settings:
+ description: User group settings for user auth mode
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the user group resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: &id133
+ - source_type
+ - ref
+ type: object
+ type: array
+ type: object
+ required: &id134
+ - resource_type
+ - cluster_id
+ - auth_mode
+ - intent
+ - domain_settings
+ - user_group_settings
+ - custom_dns
+ - public_addrs
+ - placement
+ type: array
application/vnd.ceph.api.v1.0+json:
schema:
items:
properties:
- default:
- description: Default Settings
- type: boolean
- name:
- description: Settings Name
+ auth_mode:
+ description: Either 'active-directory' or 'user'
type: string
- type:
- description: Type of Settings
+ cluster_id:
+ description: Unique identifier for the cluster
+ type: string
+ custom_dns:
+ description: List of custom DNS server addresses
+ items:
+ type: string
+ type: array
+ domain_settings:
+ description: Domain-specific settings for active-directory auth
+ mode
+ properties:
+ join_sources:
+ description: List of join auth sources for domain settings
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the join auth
+ resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: *id129
+ type: object
+ type: array
+ realm:
+ description: Domain realm, e.g., 'DOMAIN1.SINK.TEST'
+ type: string
+ required: *id130
+ type: object
+ intent:
+ description: Desired state of the resource, e.g., 'present'
+ or 'removed'
+ type: string
+ placement:
+ description: Placement configuration for the resource
+ properties:
+ count:
+ description: Number of instances to place
+ type: integer
+ required: *id131
+ type: object
+ public_addrs:
+ description: Public Address
+ items:
+ properties:
+ address:
+ description: This address will be assigned to one of the
+ host's network devices
+ type: string
+ destination:
+ description: Defines where the system will assign the
+ managed IPs.
+ type: string
+ required: *id132
+ type: object
+ type: array
+ resource_type:
+ description: ceph.smb.cluster
type: string
- value:
- description: Settings Value
- type: boolean
+ user_group_settings:
+ description: User group settings for user auth mode
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the user group resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: *id133
+ type: object
+ type: array
type: object
- required:
- - name
- - default
- - type
- - value
+ required: *id134
type: array
description: OK
'400':
trace.
security:
- jwt: []
- summary: Display Settings Information
+ summary: List smb clusters
tags:
- - Settings
- put:
+ - SMB
+ post:
+ description: "\n Create an smb cluster\n\n :param cluster_resource:\
+ \ Dict cluster data\n :return: Returns cluster resource.\n :rtype:\
+ \ Dict[str, Any]\n "
parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ cluster_resource:
+ description: cluster_resource
+ type: string
+ required:
+ - cluster_resource
+ type: object
responses:
- '200':
+ '201':
content:
+ application/json:
+ schema:
+ properties:
+ results:
+ description: List of operation results
+ items:
+ properties:
+ resource:
+ description: Resource
+ properties:
+ auth_mode:
+ description: Either 'active-directory' or 'user'
+ type: string
+ cluster_id:
+ description: Unique identifier for the cluster
+ type: string
+ custom_dns:
+ description: List of custom DNS server addresses
+ items:
+ type: string
+ type: array
+ domain_settings:
+ description: Domain-specific settings for active-directory
+ auth mode
+ properties:
+ join_sources:
+ description: List of join auth sources for domain
+ settings
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the
+ join auth resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: &id135
+ - source_type
+ - ref
+ type: object
+ type: array
+ realm:
+ description: Domain realm, e.g., 'DOMAIN1.SINK.TEST'
+ type: string
+ required: &id136
+ - realm
+ - join_sources
+ type: object
+ intent:
+ description: Desired state of the resource, e.g., 'present'
+ or 'removed'
+ type: string
+ placement:
+ description: Placement configuration for the resource
+ properties:
+ count:
+ description: Number of instances to place
+ type: integer
+ required: &id137
+ - count
+ type: object
+ public_addrs:
+ description: Public Address
+ items:
+ properties:
+ address:
+ description: This address will be assigned to
+ one of the host's network devices
+ type: string
+ destination:
+ description: Defines where the system will assign
+ the managed IPs.
+ type: string
+ required: &id138
+ - address
+ - destination
+ type: object
+ type: array
+ resource_type:
+ description: ceph.smb.cluster
+ type: string
+ user_group_settings:
+ description: User group settings for user auth mode
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the user
+ group resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: &id139
+ - source_type
+ - ref
+ type: object
+ type: array
+ required: &id140
+ - resource_type
+ - cluster_id
+ - auth_mode
+ - intent
+ - domain_settings
+ - user_group_settings
+ - custom_dns
+ - public_addrs
+ - placement
+ type: object
+ state:
+ description: The current state of the resource, e.g.,
+ 'created', 'updated', 'deleted'
+ type: string
+ success:
+ description: Indicates if the operation was successful
+ type: boolean
+ required: &id141
+ - resource
+ - state
+ - success
+ type: object
+ type: array
+ success:
+ description: Indicates if the overall operation was successful
+ type: boolean
+ required: &id142
+ - results
+ - success
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
+ schema:
+ properties:
+ results:
+ description: List of operation results
+ items:
+ properties:
+ resource:
+ description: Resource
+ properties:
+ auth_mode:
+ description: Either 'active-directory' or 'user'
+ type: string
+ cluster_id:
+ description: Unique identifier for the cluster
+ type: string
+ custom_dns:
+ description: List of custom DNS server addresses
+ items:
+ type: string
+ type: array
+ domain_settings:
+ description: Domain-specific settings for active-directory
+ auth mode
+ properties:
+ join_sources:
+ description: List of join auth sources for domain
+ settings
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the
+ join auth resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: *id135
+ type: object
+ type: array
+ realm:
+ description: Domain realm, e.g., 'DOMAIN1.SINK.TEST'
+ type: string
+ required: *id136
+ type: object
+ intent:
+ description: Desired state of the resource, e.g., 'present'
+ or 'removed'
+ type: string
+ placement:
+ description: Placement configuration for the resource
+ properties:
+ count:
+ description: Number of instances to place
+ type: integer
+ required: *id137
+ type: object
+ public_addrs:
+ description: Public Address
+ items:
+ properties:
+ address:
+ description: This address will be assigned to
+ one of the host's network devices
+ type: string
+ destination:
+ description: Defines where the system will assign
+ the managed IPs.
+ type: string
+ required: *id138
+ type: object
+ type: array
+ resource_type:
+ description: ceph.smb.cluster
+ type: string
+ user_group_settings:
+ description: User group settings for user auth mode
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the user
+ group resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: *id139
+ type: object
+ type: array
+ required: *id140
+ type: object
+ state:
+ description: The current state of the resource, e.g.,
+ 'created', 'updated', 'deleted'
+ type: string
+ success:
+ description: Indicates if the operation was successful
+ type: boolean
+ required: *id141
+ type: object
+ type: array
+ success:
+ description: Indicates if the overall operation was successful
+ type: boolean
+ required: *id142
+ type: object
+ description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Create smb cluster
tags:
- - Settings
- /api/settings/{name}:
+ - SMB
+ /api/smb/cluster/{cluster_id}:
delete:
+ description: "\n Remove an smb cluster\n\n :param cluster_id:\
+ \ Cluster identifier\n :return: None.\n "
parameters:
- - in: path
- name: name
+ - description: Unique identifier for the cluster
+ in: path
+ name: cluster_id
required: true
schema:
type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ properties: {}
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ properties: {}
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Remove an smb cluster
tags:
- - Settings
+ - SMB
get:
- description: "\n Get the given option.\n :param name: The name\
- \ of the option.\n :return: Returns a dict containing the name, type,\n\
- \ default value and current value of the given option.\n :rtype:\
- \ dict\n "
- parameters:
- - in: path
- name: name
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Settings
- put:
+ description: "\n Get an smb cluster by cluster id\n "
parameters:
- - in: path
- name: name
+ - description: Unique identifier for the cluster
+ in: path
+ name: cluster_id
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- value:
- type: string
- required:
- - value
- type: object
responses:
'200':
content:
+ application/json:
+ schema:
+ properties:
+ auth_mode:
+ description: Either 'active-directory' or 'user'
+ type: string
+ cluster_id:
+ description: Unique identifier for the cluster
+ type: string
+ custom_dns:
+ description: List of custom DNS server addresses
+ items:
+ type: string
+ type: array
+ domain_settings:
+ description: Domain-specific settings for active-directory auth
+ mode
+ properties:
+ join_sources:
+ description: List of join auth sources for domain settings
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the join auth
+ resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: &id143
+ - source_type
+ - ref
+ type: object
+ type: array
+ realm:
+ description: Domain realm, e.g., 'DOMAIN1.SINK.TEST'
+ type: string
+ required: &id144
+ - realm
+ - join_sources
+ type: object
+ intent:
+ description: Desired state of the resource, e.g., 'present' or
+ 'removed'
+ type: string
+ placement:
+ description: Placement configuration for the resource
+ properties:
+ count:
+ description: Number of instances to place
+ type: integer
+ required: &id145
+ - count
+ type: object
+ public_addrs:
+ description: Public Address
+ items:
+ properties:
+ address:
+ description: This address will be assigned to one of the
+ host's network devices
+ type: string
+ destination:
+ description: Defines where the system will assign the managed
+ IPs.
+ type: string
+ required: &id146
+ - address
+ - destination
+ type: object
+ type: array
+ resource_type:
+ description: ceph.smb.cluster
+ type: string
+ user_group_settings:
+ description: User group settings for user auth mode
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the user group resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: &id147
+ - source_type
+ - ref
+ type: object
+ type: array
+ required: &id148
+ - resource_type
+ - cluster_id
+ - auth_mode
+ - intent
+ - domain_settings
+ - user_group_settings
+ - custom_dns
+ - public_addrs
+ - placement
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ properties:
+ auth_mode:
+ description: Either 'active-directory' or 'user'
+ type: string
+ cluster_id:
+ description: Unique identifier for the cluster
+ type: string
+ custom_dns:
+ description: List of custom DNS server addresses
+ items:
+ type: string
+ type: array
+ domain_settings:
+ description: Domain-specific settings for active-directory auth
+ mode
+ properties:
+ join_sources:
+ description: List of join auth sources for domain settings
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the join auth
+ resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: *id143
+ type: object
+ type: array
+ realm:
+ description: Domain realm, e.g., 'DOMAIN1.SINK.TEST'
+ type: string
+ required: *id144
+ type: object
+ intent:
+ description: Desired state of the resource, e.g., 'present' or
+ 'removed'
+ type: string
+ placement:
+ description: Placement configuration for the resource
+ properties:
+ count:
+ description: Number of instances to place
+ type: integer
+ required: *id145
+ type: object
+ public_addrs:
+ description: Public Address
+ items:
+ properties:
+ address:
+ description: This address will be assigned to one of the
+ host's network devices
+ type: string
+ destination:
+ description: Defines where the system will assign the managed
+ IPs.
+ type: string
+ required: *id146
+ type: object
+ type: array
+ resource_type:
+ description: ceph.smb.cluster
+ type: string
+ user_group_settings:
+ description: User group settings for user auth mode
+ items:
+ properties:
+ ref:
+ description: Reference identifier for the user group resource
+ type: string
+ source_type:
+ description: resource
+ type: string
+ required: *id147
+ type: object
+ type: array
+ required: *id148
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Get an smb cluster
tags:
- - Settings
- /api/smb/cluster:
+ - SMB
+ /api/smb/joinauth:
get:
- description: "\n List smb clusters\n "
+ description: "\n List all smb join auth resources\n\n :return:\
+ \ Returns list of join auth.\n :rtype: List[Dict]\n "
parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
items:
properties:
- auth_mode:
- description: Either 'active-directory' or 'user'
- type: string
- cluster_id:
- description: Unique identifier for the cluster
- type: string
- custom_dns:
- description: List of custom DNS server addresses
- items:
- type: string
- type: array
- domain_settings:
- description: Domain-specific settings for active-directory auth
- mode
+ auth:
+ description: Authentication credentials
properties:
- join_sources:
- description: List of join auth sources for domain settings
- items:
- properties:
- ref:
- description: Reference identifier for the join auth
- resource
- type: string
- source_type:
- description: resource
- type: string
- required:
- - source_type
- - ref
- type: object
- type: array
- realm:
- description: Domain realm, e.g., 'DOMAIN1.SINK.TEST'
+ password:
+ description: Password for authentication
type: string
- required:
- - realm
- - join_sources
+ username:
+ description: Username for authentication
+ type: string
+ required: &id149
+ - username
+ - password
type: object
+ auth_id:
+ description: Unique identifier for the join auth resource
+ type: string
intent:
description: Desired state of the resource, e.g., 'present'
or 'removed'
type: string
- placement:
- description: Placement configuration for the resource
- properties:
- count:
- description: Number of instances to place
- type: integer
- required:
- - count
- type: object
- public_addrs:
- description: Public Address
- items:
- properties:
- address:
- description: This address will be assigned to one of the
- host's network devices
- type: string
- destination:
- description: Defines where the system will assign the
- managed IPs.
- type: string
- required:
- - address
- - destination
- type: object
- type: array
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If
+ set, the resource is linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
resource_type:
- description: ceph.smb.cluster
+ description: ceph.smb.join.auth
type: string
- user_group_settings:
- description: User group settings for user auth mode
- items:
- properties:
- ref:
- description: Reference identifier for the user group resource
- type: string
- source_type:
- description: resource
- type: string
- required:
- - source_type
- - ref
- type: object
- type: array
type: object
- required:
+ required: &id150
- resource_type
- - cluster_id
- - auth_mode
+ - auth_id
- intent
- - domain_settings
- - user_group_settings
- - custom_dns
- - public_addrs
- - placement
+ - auth
+ - linked_to_cluster
+ type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ auth:
+ description: Authentication credentials
+ properties:
+ password:
+ description: Password for authentication
+ type: string
+ username:
+ description: Username for authentication
+ type: string
+ required: *id149
+ type: object
+ auth_id:
+ description: Unique identifier for the join auth resource
+ type: string
+ intent:
+ description: Desired state of the resource, e.g., 'present'
+ or 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If
+ set, the resource is linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.join.auth
+ type: string
+ type: object
+ required: *id150
type: array
description: OK
'400':
trace.
security:
- jwt: []
- summary: List smb clusters
+ summary: List smb join authorization resources
tags:
- SMB
post:
- description: "\n Create an smb cluster\n\n :param cluster_resource:\
- \ Dict cluster data\n :return: Returns cluster resource.\n :rtype:\
- \ Dict[str, Any]\n "
+ description: "\n Create smb join auth resource\n\n :return: Returns\
+ \ join auth resource.\n :rtype: Dict\n "
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- cluster_resource:
- description: cluster_resource
+ join_auth:
type: string
required:
- - cluster_resource
+ - join_auth
type: object
responses:
'201':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
results:
resource:
description: Resource
properties:
- auth_mode:
- description: Either 'active-directory' or 'user'
- type: string
- cluster_id:
- description: Unique identifier for the cluster
- type: string
- custom_dns:
- description: List of custom DNS server addresses
- items:
- type: string
- type: array
- domain_settings:
- description: Domain-specific settings for active-directory
- auth mode
+ auth:
+ description: Authentication credentials
properties:
- join_sources:
- description: List of join auth sources for domain
- settings
- items:
- properties:
- ref:
- description: Reference identifier for the
- join auth resource
- type: string
- source_type:
- description: resource
- type: string
- required:
- - source_type
- - ref
- type: object
- type: array
- realm:
- description: Domain realm, e.g., 'DOMAIN1.SINK.TEST'
+ password:
+ description: Password for authentication
type: string
- required:
- - realm
- - join_sources
+ username:
+ description: Username for authentication
+ type: string
+ required: &id151
+ - username
+ - password
type: object
+ auth_id:
+ description: Unique identifier for the join auth resource
+ type: string
intent:
description: Desired state of the resource, e.g., 'present'
or 'removed'
type: string
- placement:
- description: Placement configuration for the resource
- properties:
- count:
- description: Number of instances to place
- type: integer
- required:
- - count
- type: object
- public_addrs:
- description: Public Address
- items:
- properties:
- address:
- description: This address will be assigned to
- one of the host's network devices
- type: string
- destination:
- description: Defines where the system will assign
- the managed IPs.
- type: string
- required:
- - address
- - destination
- type: object
- type: array
- resource_type:
- description: ceph.smb.cluster
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If
+ set, the resource is linked to the cluster and will
+ be automatically removed when the cluster is removed
type: string
- user_group_settings:
- description: User group settings for user auth mode
- items:
- properties:
- ref:
- description: Reference identifier for the user
- group resource
- type: string
- source_type:
- description: resource
- type: string
- required:
- - source_type
- - ref
- type: object
- type: array
- required:
+ resource_type:
+ description: ceph.smb.join.auth
+ type: string
+ required: &id152
- resource_type
- - cluster_id
- - auth_mode
+ - auth_id
- intent
- - domain_settings
- - user_group_settings
- - custom_dns
- - public_addrs
- - placement
+ - auth
+ - linked_to_cluster
type: object
state:
description: The current state of the resource, e.g.,
success:
description: Indicates if the operation was successful
type: boolean
- required:
+ required: &id153
- resource
- state
- success
success:
description: Indicates if the overall operation was successful
type: boolean
- required:
+ required: &id154
- results
- success
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ results:
+ description: List of operation results
+ items:
+ properties:
+ resource:
+ description: Resource
+ properties:
+ auth:
+ description: Authentication credentials
+ properties:
+ password:
+ description: Password for authentication
+ type: string
+ username:
+ description: Username for authentication
+ type: string
+ required: *id151
+ type: object
+ auth_id:
+ description: Unique identifier for the join auth resource
+ type: string
+ intent:
+ description: Desired state of the resource, e.g., 'present'
+ or 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If
+ set, the resource is linked to the cluster and will
+ be automatically removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.join.auth
+ type: string
+ required: *id152
+ type: object
+ state:
+ description: The current state of the resource, e.g.,
+ 'created', 'updated', 'deleted'
+ type: string
+ success:
+ description: Indicates if the operation was successful
+ type: boolean
+ required: *id153
+ type: object
+ type: array
+ success:
+ description: Indicates if the overall operation was successful
+ type: boolean
+ required: *id154
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Create smb cluster
+ summary: Create smb join auth
tags:
- SMB
- /api/smb/cluster/{cluster_id}:
+ /api/smb/joinauth/{auth_id}:
delete:
- description: "\n Remove an smb cluster\n\n :param cluster_id:\
- \ Cluster identifier\n :return: None.\n "
+ description: "\n Delete smb join auth resource\n\n :param auth_id:\
+ \ Join Auth identifier\n :return: None.\n "
parameters:
- - description: Unique identifier for the cluster
+ - description: auth_id
in: path
- name: cluster_id
+ name: auth_id
required: true
schema:
type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ properties: {}
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties: {}
type: object
- description: Resource deleted.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Remove an smb cluster
- tags:
- - SMB
- get:
- description: "\n Get an smb cluster by cluster id\n "
- parameters:
- - description: Unique identifier for the cluster
- in: path
- name: cluster_id
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
+ description: Resource deleted.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Delete smb join auth
+ tags:
+ - SMB
+ get:
+ description: "\n Get Join auth resource\n\n :return: Returns join\
+ \ auth.\n :rtype: Dict\n "
+ parameters:
+ - in: path
+ name: auth_id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ auth:
+ description: Authentication credentials
+ properties:
+ password:
+ description: Password for authentication
+ type: string
+ username:
+ description: Username for authentication
+ type: string
+ required: &id155
+ - username
+ - password
+ type: object
+ auth_id:
+ description: Unique identifier for the join auth resource
+ type: string
+ intent:
+ description: Desired state of the resource, e.g., 'present' or
+ 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If set,
+ the resource is linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.join.auth
+ type: string
+ required: &id156
+ - resource_type
+ - auth_id
+ - intent
+ - auth
+ - linked_to_cluster
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ auth:
+ description: Authentication credentials
+ properties:
+ password:
+ description: Password for authentication
+ type: string
+ username:
+ description: Username for authentication
+ type: string
+ required: *id155
+ type: object
+ auth_id:
+ description: Unique identifier for the join auth resource
+ type: string
+ intent:
+ description: Desired state of the resource, e.g., 'present' or
+ 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If set,
+ the resource is linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.join.auth
+ type: string
+ required: *id156
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get smb join authorization resource
+ tags:
+ - SMB
+ /api/smb/share:
+ get:
+ description: "\n List all smb shares or all shares for a given cluster\n\
+ \n :param cluster_id: Dict containing cluster information\n \
+ \ :return: Returns list of shares.\n :rtype: List[Dict]\n "
+ parameters:
+ - default: ''
+ description: Unique identifier for the cluster
+ in: query
+ name: cluster_id
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ browseable:
+ description: Indicates if the share is browseable
+ type: boolean
+ cephfs:
+ description: Configuration for the CephFS share
+ properties:
+ path:
+ description: Path within the CephFS file system
+ type: string
+ provider:
+ description: Provider of the CephFS share, e.g., 'samba-vfs'
+ type: string
+ subvolume:
+ description: Subvolume within the CephFS file system
+ type: string
+ subvolumegroup:
+ description: Subvolume Group in CephFS file system
+ type: string
+ volume:
+ description: Name of the CephFS file system
+ type: string
+ required: &id157
+ - volume
+ - path
+ - provider
+ - subvolumegroup
+ - subvolume
+ type: object
+ cluster_id:
+ description: Unique identifier for the cluster
+ type: string
+ intent:
+ description: Desired state of the resource, e.g., 'present' or
+ 'removed'
+ type: string
+ name:
+ description: Name of the share
+ type: string
+ readonly:
+ description: Indicates if the share is read-only
+ type: boolean
+ resource_type:
+ description: ceph.smb.share
+ type: string
+ share_id:
+ description: Unique identifier for the share
+ type: string
+ required: &id158
+ - resource_type
+ - cluster_id
+ - share_id
+ - intent
+ - name
+ - readonly
+ - browseable
+ - cephfs
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties:
- auth_mode:
- description: Either 'active-directory' or 'user'
- type: string
- cluster_id:
- description: Unique identifier for the cluster
- type: string
- custom_dns:
- description: List of custom DNS server addresses
- items:
- type: string
- type: array
- domain_settings:
- description: Domain-specific settings for active-directory auth
- mode
+ browseable:
+ description: Indicates if the share is browseable
+ type: boolean
+ cephfs:
+ description: Configuration for the CephFS share
properties:
- join_sources:
- description: List of join auth sources for domain settings
- items:
- properties:
- ref:
- description: Reference identifier for the join auth
- resource
- type: string
- source_type:
- description: resource
- type: string
- required:
- - source_type
- - ref
- type: object
- type: array
- realm:
- description: Domain realm, e.g., 'DOMAIN1.SINK.TEST'
+ path:
+ description: Path within the CephFS file system
type: string
- required:
- - realm
- - join_sources
+ provider:
+ description: Provider of the CephFS share, e.g., 'samba-vfs'
+ type: string
+ subvolume:
+ description: Subvolume within the CephFS file system
+ type: string
+ subvolumegroup:
+ description: Subvolume Group in CephFS file system
+ type: string
+ volume:
+ description: Name of the CephFS file system
+ type: string
+ required: *id157
type: object
+ cluster_id:
+ description: Unique identifier for the cluster
+ type: string
intent:
description: Desired state of the resource, e.g., 'present' or
'removed'
type: string
- placement:
- description: Placement configuration for the resource
- properties:
- count:
- description: Number of instances to place
- type: integer
- required:
- - count
- type: object
- public_addrs:
- description: Public Address
- items:
- properties:
- address:
- description: This address will be assigned to one of the
- host's network devices
- type: string
- destination:
- description: Defines where the system will assign the managed
- IPs.
- type: string
- required:
- - address
- - destination
- type: object
- type: array
+ name:
+ description: Name of the share
+ type: string
+ readonly:
+ description: Indicates if the share is read-only
+ type: boolean
resource_type:
- description: ceph.smb.cluster
+ description: ceph.smb.share
type: string
- user_group_settings:
- description: User group settings for user auth mode
- items:
- properties:
- ref:
- description: Reference identifier for the user group resource
- type: string
- source_type:
- description: resource
- type: string
- required:
- - source_type
- - ref
- type: object
- type: array
- required:
- - resource_type
- - cluster_id
- - auth_mode
- - intent
- - domain_settings
- - user_group_settings
- - custom_dns
- - public_addrs
- - placement
+ share_id:
+ description: Unique identifier for the share
+ type: string
+ required: *id158
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get an smb cluster
+ summary: List smb shares
tags:
- SMB
- /api/smb/joinauth:
- get:
- description: "\n List all smb join auth resources\n\n :return:\
- \ Returns list of join auth.\n :rtype: List[Dict]\n "
+ post:
+ description: "\n Create an smb share\n\n :param share_resource:\
+ \ Dict share data\n :return: Returns share resource.\n :rtype:\
+ \ Dict[str, Any]\n "
parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ share_resource:
+ description: share_resource
+ type: string
+ required:
+ - share_resource
+ type: object
responses:
- '200':
+ '201':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
- items:
- properties:
- auth:
- description: Authentication credentials
+ properties:
+ results:
+ description: List of operation results
+ items:
properties:
- password:
- description: Password for authentication
- type: string
- username:
- description: Username for authentication
+ resource:
+ description: Resource
+ properties:
+ browseable:
+ description: Indicates if the share is browseable
+ type: boolean
+ cephfs:
+ description: Configuration for the CephFS share
+ properties:
+ path:
+ description: Path within the CephFS file system
+ type: string
+ provider:
+ description: Provider of the CephFS share, e.g.,
+ 'samba-vfs'
+ type: string
+ subvolume:
+ description: Subvolume within the CephFS file system
+ type: string
+ subvolumegroup:
+ description: Subvolume Group in CephFS file system
+ type: string
+ volume:
+ description: Name of the CephFS file system
+ type: string
+ required: &id159
+ - volume
+ - path
+ - provider
+ - subvolumegroup
+ - subvolume
+ type: object
+ cluster_id:
+ description: Unique identifier for the cluster
+ type: string
+ intent:
+ description: Desired state of the resource, e.g., 'present'
+ or 'removed'
+ type: string
+ name:
+ description: Name of the share
+ type: string
+ readonly:
+ description: Indicates if the share is read-only
+ type: boolean
+ resource_type:
+ description: ceph.smb.share
+ type: string
+ share_id:
+ description: Unique identifier for the share
+ type: string
+ required: &id160
+ - resource_type
+ - cluster_id
+ - share_id
+ - intent
+ - name
+ - readonly
+ - browseable
+ - cephfs
+ type: object
+ state:
+ description: The current state of the resource, e.g.,
+ 'created', 'updated', 'deleted'
type: string
- required:
- - username
- - password
+ success:
+ description: Indicates if the operation was successful
+ type: boolean
+ required: &id161
+ - resource
+ - state
+ - success
type: object
- auth_id:
- description: Unique identifier for the join auth resource
- type: string
- intent:
- description: Desired state of the resource, e.g., 'present'
- or 'removed'
- type: string
- linked_to_cluster:
- description: Optional string containing a cluster ID. If
- set, the resource is linked to the cluster and will be automatically
- removed when the cluster is removed
- type: string
- resource_type:
- description: ceph.smb.join.auth
- type: string
- type: object
- required:
- - resource_type
- - auth_id
- - intent
- - auth
- - linked_to_cluster
- type: array
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: List smb join authorization resources
- tags:
- - SMB
- post:
- description: "\n Create smb join auth resource\n\n :return: Returns\
- \ join auth resource.\n :rtype: Dict\n "
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- join_auth:
- type: string
- required:
- - join_auth
- type: object
- responses:
- '201':
- content:
+ type: array
+ success:
+ description: Indicates if the overall operation was successful
+ type: boolean
+ required: &id162
+ - results
+ - success
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties:
resource:
description: Resource
properties:
- auth:
- description: Authentication credentials
+ browseable:
+ description: Indicates if the share is browseable
+ type: boolean
+ cephfs:
+ description: Configuration for the CephFS share
properties:
- password:
- description: Password for authentication
+ path:
+ description: Path within the CephFS file system
type: string
- username:
- description: Username for authentication
+ provider:
+ description: Provider of the CephFS share, e.g.,
+ 'samba-vfs'
type: string
- required:
- - username
- - password
+ subvolume:
+ description: Subvolume within the CephFS file system
+ type: string
+ subvolumegroup:
+ description: Subvolume Group in CephFS file system
+ type: string
+ volume:
+ description: Name of the CephFS file system
+ type: string
+ required: *id159
type: object
- auth_id:
- description: Unique identifier for the join auth resource
+ cluster_id:
+ description: Unique identifier for the cluster
type: string
intent:
description: Desired state of the resource, e.g., 'present'
or 'removed'
type: string
- linked_to_cluster:
- description: Optional string containing a cluster ID. If
- set, the resource is linked to the cluster and will
- be automatically removed when the cluster is removed
+ name:
+ description: Name of the share
type: string
+ readonly:
+ description: Indicates if the share is read-only
+ type: boolean
resource_type:
- description: ceph.smb.join.auth
+ description: ceph.smb.share
type: string
- required:
- - resource_type
- - auth_id
- - intent
- - auth
- - linked_to_cluster
+ share_id:
+ description: Unique identifier for the share
+ type: string
+ required: *id160
type: object
state:
description: The current state of the resource, e.g.,
success:
description: Indicates if the operation was successful
type: boolean
- required:
- - resource
- - state
- - success
+ required: *id161
type: object
type: array
success:
description: Indicates if the overall operation was successful
type: boolean
- required:
- - results
- - success
+ required: *id162
type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Create smb join auth
+ summary: Create smb share
tags:
- SMB
- /api/smb/joinauth/{auth_id}:
+ /api/smb/share/{cluster_id}/{share_id}:
delete:
- description: "\n Delete smb join auth resource\n\n :param auth_id:\
- \ Join Auth identifier\n :return: None.\n "
+ description: "\n Remove an smb share from a given cluster\n\n \
+ \ :param cluster_id: Cluster identifier\n :param share_id: Share identifier\n\
+ \ :return: None.\n "
parameters:
- - description: auth_id
+ - description: Unique identifier for the cluster
in: path
- name: auth_id
+ name: cluster_id
+ required: true
+ schema:
+ type: string
+ - description: Unique identifier for the share
+ in: path
+ name: share_id
required: true
schema:
type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ properties: {}
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties: {}
trace.
security:
- jwt: []
- summary: Delete smb join auth
+ summary: Remove an smb share
tags:
- SMB
get:
- description: "\n Get Join auth resource\n\n :return: Returns join\
- \ auth.\n :rtype: Dict\n "
+ description: "\n Get an smb share by cluster and share id\n "
parameters:
- - in: path
- name: auth_id
+ - description: Unique identifier for the cluster
+ in: path
+ name: cluster_id
+ required: true
+ schema:
+ type: string
+ - description: Unique identifier for the share
+ in: path
+ name: share_id
required: true
schema:
type: string
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
- auth:
- description: Authentication credentials
+ browseable:
+ description: Indicates if the share is browseable
+ type: boolean
+ cephfs:
+ description: Configuration for the CephFS share
properties:
- password:
- description: Password for authentication
+ path:
+ description: Path within the CephFS file system
type: string
- username:
- description: Username for authentication
+ provider:
+ description: Provider of the CephFS share, e.g., 'samba-vfs'
type: string
- required:
- - username
- - password
+ subvolume:
+ description: Subvolume within the CephFS file system
+ type: string
+ subvolumegroup:
+ description: Subvolume Group in CephFS file system
+ type: string
+ volume:
+ description: Name of the CephFS file system
+ type: string
+ required: &id163
+ - volume
+ - path
+ - provider
+ - subvolumegroup
+ - subvolume
type: object
- auth_id:
- description: Unique identifier for the join auth resource
+ cluster_id:
+ description: Unique identifier for the cluster
type: string
intent:
description: Desired state of the resource, e.g., 'present' or
'removed'
type: string
- linked_to_cluster:
- description: Optional string containing a cluster ID. If set,
- the resource is linked to the cluster and will be automatically
- removed when the cluster is removed
+ name:
+ description: Name of the share
type: string
+ readonly:
+ description: Indicates if the share is read-only
+ type: boolean
resource_type:
- description: ceph.smb.join.auth
+ description: ceph.smb.share
+ type: string
+ share_id:
+ description: Unique identifier for the share
type: string
- required:
+ required: &id164
- resource_type
- - auth_id
+ - cluster_id
+ - share_id
- intent
- - auth
- - linked_to_cluster
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get smb join authorization resource
- tags:
- - SMB
- /api/smb/share:
- get:
- description: "\n List all smb shares or all shares for a given cluster\n\
- \n :param cluster_id: Dict containing cluster information\n \
- \ :return: Returns list of shares.\n :rtype: List[Dict]\n "
- parameters:
- - default: ''
- description: Unique identifier for the cluster
- in: query
- name: cluster_id
- schema:
- type: string
- responses:
- '200':
- content:
+ - name
+ - readonly
+ - browseable
+ - cephfs
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties:
volume:
description: Name of the CephFS file system
type: string
- required:
- - volume
- - path
- - provider
- - subvolumegroup
- - subvolume
+ required: *id163
type: object
cluster_id:
description: Unique identifier for the cluster
share_id:
description: Unique identifier for the share
type: string
- required:
+ required: *id164
+ type: object
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Get an smb share
+ tags:
+ - SMB
+ /api/smb/usersgroups:
+ get:
+ description: "\n List all smb usersgroups resources\n\n :return:\
+ \ Returns list of usersgroups\n :rtype: List[Dict]\n "
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ items:
+ properties:
+ intent:
+ description: Desired state of the resource, e.g., 'present'
+ or 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If
+ set, the resource is linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.usersgroups
+ type: string
+ users_groups_id:
+ description: A short string identifying the usersgroups resource
+ type: string
+ values:
+ description: Required object containing users and groups information
+ properties:
+ groups:
+ description: List of group objects, each containing a name
+ items:
+ properties:
+ name:
+ description: The name of the group
+ type: string
+ required: &id165
+ - name
+ type: object
+ type: array
+ users:
+ description: List of user objects, each containing a name
+ and password
+ items:
+ properties:
+ name:
+ description: The user name
+ type: string
+ password:
+ description: The password for the user
+ type: string
+ required: &id166
+ - name
+ - password
+ type: object
+ type: array
+ required: &id167
+ - users
+ - groups
+ type: object
+ type: object
+ required: &id168
- resource_type
- - cluster_id
- - share_id
+ - users_groups_id
- intent
- - name
- - readonly
- - browseable
- - cephfs
+ - values
+ - linked_to_cluster
+ type: array
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ items:
+ properties:
+ intent:
+ description: Desired state of the resource, e.g., 'present'
+ or 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If
+ set, the resource is linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.usersgroups
+ type: string
+ users_groups_id:
+ description: A short string identifying the usersgroups resource
+ type: string
+ values:
+ description: Required object containing users and groups information
+ properties:
+ groups:
+ description: List of group objects, each containing a name
+ items:
+ properties:
+ name:
+ description: The name of the group
+ type: string
+ required: *id165
+ type: object
+ type: array
+ users:
+ description: List of user objects, each containing a name
+ and password
+ items:
+ properties:
+ name:
+ description: The user name
+ type: string
+ password:
+ description: The password for the user
+ type: string
+ required: *id166
+ type: object
+ type: array
+ required: *id167
+ type: object
+ type: object
+ required: *id168
+ type: array
+ description: OK
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: List smb user resources
+ tags:
+ - SMB
+ post:
+ description: "\n Create smb usersgroups resource\n\n :return:\
+ \ Returns usersgroups resource.\n :rtype: Dict\n "
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ usersgroups:
+ type: string
+ required:
+ - usersgroups
+ type: object
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ properties:
+ results:
+ description: List of operation results
+ items:
+ properties:
+ resource:
+ description: Resource
+ properties:
+ results:
+ description: List of operation results
+ items:
+ properties:
+ resource:
+ description: Resource
+ properties:
+ auth:
+ description: Authentication credentials
+ properties:
+ password:
+ description: Password for authentication
+ type: string
+ username:
+ description: Username for authentication
+ type: string
+ required: &id169
+ - username
+ - password
+ type: object
+ auth_id:
+ description: Unique identifier for the join
+ auth resource
+ type: string
+ intent:
+ description: Desired state of the resource,
+ e.g., 'present' or 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a
+ cluster ID. If set, the resource is
+ linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.join.auth
+ type: string
+ required: &id170
+ - resource_type
+ - auth_id
+ - intent
+ - auth
+ - linked_to_cluster
+ type: object
+ state:
+ description: The current state of the resource, e.g.,
+ 'created', 'updated', 'deleted'
+ type: string
+ success:
+ description: Indicates if the operation was successful
+ type: boolean
+ required: &id171
+ - resource
+ - state
+ - success
+ type: object
+ type: array
+ success:
+ description: Indicates if the overall operation was
+ successful
+ type: boolean
+ required: &id172
+ - results
+ - success
+ type: object
+ state:
+ description: The current state of the resource, e.g.,
+ 'created', 'updated', 'deleted'
+ type: string
+ success:
+ description: Indicates if the operation was successful
+ type: boolean
+ required: &id173
+ - resource
+ - state
+ - success
+ type: object
+ type: array
+ success:
+ description: Indicates if the overall operation was successful
+ type: boolean
+ required: &id174
+ - results
+ - success
type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: List smb shares
- tags:
- - SMB
- post:
- description: "\n Create an smb share\n\n :param share_resource:\
- \ Dict share data\n :return: Returns share resource.\n :rtype:\
- \ Dict[str, Any]\n "
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- share_resource:
- description: share_resource
- type: string
- required:
- - share_resource
- type: object
- responses:
- '201':
- content:
application/vnd.ceph.api.v1.0+json:
schema:
properties:
resource:
description: Resource
properties:
- browseable:
- description: Indicates if the share is browseable
- type: boolean
- cephfs:
- description: Configuration for the CephFS share
- properties:
- path:
- description: Path within the CephFS file system
- type: string
- provider:
- description: Provider of the CephFS share, e.g.,
- 'samba-vfs'
- type: string
- subvolume:
- description: Subvolume within the CephFS file system
- type: string
- subvolumegroup:
- description: Subvolume Group in CephFS file system
- type: string
- volume:
- description: Name of the CephFS file system
- type: string
- required:
- - volume
- - path
- - provider
- - subvolumegroup
- - subvolume
- type: object
- cluster_id:
- description: Unique identifier for the cluster
- type: string
- intent:
- description: Desired state of the resource, e.g., 'present'
- or 'removed'
- type: string
- name:
- description: Name of the share
- type: string
- readonly:
- description: Indicates if the share is read-only
+ results:
+ description: List of operation results
+ items:
+ properties:
+ resource:
+ description: Resource
+ properties:
+ auth:
+ description: Authentication credentials
+ properties:
+ password:
+ description: Password for authentication
+ type: string
+ username:
+ description: Username for authentication
+ type: string
+ required: *id169
+ type: object
+ auth_id:
+ description: Unique identifier for the join
+ auth resource
+ type: string
+ intent:
+ description: Desired state of the resource,
+ e.g., 'present' or 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a
+ cluster ID. If set, the resource is
+ linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.join.auth
+ type: string
+ required: *id170
+ type: object
+ state:
+ description: The current state of the resource, e.g.,
+ 'created', 'updated', 'deleted'
+ type: string
+ success:
+ description: Indicates if the operation was successful
+ type: boolean
+ required: *id171
+ type: object
+ type: array
+ success:
+ description: Indicates if the overall operation was
+ successful
type: boolean
- resource_type:
- description: ceph.smb.share
- type: string
- share_id:
- description: Unique identifier for the share
- type: string
- required:
- - resource_type
- - cluster_id
- - share_id
- - intent
- - name
- - readonly
- - browseable
- - cephfs
+ required: *id172
type: object
state:
description: The current state of the resource, e.g.,
success:
description: Indicates if the operation was successful
type: boolean
- required:
- - resource
- - state
- - success
+ required: *id173
type: object
type: array
success:
description: Indicates if the overall operation was successful
type: boolean
- required:
- - results
- - success
+ required: *id174
type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Create smb share
+ summary: Create smb usersgroups
tags:
- SMB
- /api/smb/share/{cluster_id}/{share_id}:
+ /api/smb/usersgroups/{users_groups_id}:
delete:
- description: "\n Remove an smb share from a given cluster\n\n \
- \ :param cluster_id: Cluster identifier\n :param share_id: Share identifier\n\
- \ :return: None.\n "
+ description: "\n Delete smb usersgroups resource\n\n :param users_group_id:\
+ \ Users identifier\n :return: None.\n "
parameters:
- - description: Unique identifier for the cluster
- in: path
- name: cluster_id
- required: true
- schema:
- type: string
- - description: Unique identifier for the share
+ - description: users_groups_id
in: path
- name: share_id
+ name: users_groups_id
required: true
schema:
type: string
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ properties: {}
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties: {}
+ type: object
+ description: Resource deleted.
+ '400':
+ description: Operation exception. Please check the response body for details.
+ '401':
+ description: Unauthenticated access. Please login first.
+ '403':
+ description: Unauthorized access. Please check your permissions.
+ '500':
+ description: Unexpected error. Please check the response body for the stack
+ trace.
+ security:
+ - jwt: []
+ summary: Delete smb join auth
+ tags:
+ - SMB
+ get:
+ description: "\n Get Users and groups resource\n\n :return: Returns\
+ \ join auth.\n :rtype: Dict\n "
+ parameters:
+ - in: path
+ name: users_groups_id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ intent:
+ description: Desired state of the resource, e.g., 'present' or
+ 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If set,
+ the resource is linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.usersgroups
+ type: string
+ users_groups_id:
+ description: A short string identifying the usersgroups resource
+ type: string
+ values:
+ description: Required object containing users and groups information
+ properties:
+ groups:
+ description: List of group objects, each containing a name
+ items:
+ properties:
+ name:
+ description: The name of the group
+ type: string
+ required: &id175
+ - name
+ type: object
+ type: array
+ users:
+ description: List of user objects, each containing a name
+ and password
+ items:
+ properties:
+ name:
+ description: The user name
+ type: string
+ password:
+ description: The password for the user
+ type: string
+ required: &id176
+ - name
+ - password
+ type: object
+ type: array
+ required: &id177
+ - users
+ - groups
+ type: object
+ required: &id178
+ - resource_type
+ - users_groups_id
+ - intent
+ - values
+ - linked_to_cluster
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
- properties: {}
+ properties:
+ intent:
+ description: Desired state of the resource, e.g., 'present' or
+ 'removed'
+ type: string
+ linked_to_cluster:
+ description: Optional string containing a cluster ID. If set,
+ the resource is linked to the cluster and will be automatically
+ removed when the cluster is removed
+ type: string
+ resource_type:
+ description: ceph.smb.usersgroups
+ type: string
+ users_groups_id:
+ description: A short string identifying the usersgroups resource
+ type: string
+ values:
+ description: Required object containing users and groups information
+ properties:
+ groups:
+ description: List of group objects, each containing a name
+ items:
+ properties:
+ name:
+ description: The name of the group
+ type: string
+ required: *id175
+ type: object
+ type: array
+ users:
+ description: List of user objects, each containing a name
+ and password
+ items:
+ properties:
+ name:
+ description: The user name
+ type: string
+ password:
+ description: The password for the user
+ type: string
+ required: *id176
+ type: object
+ type: array
+ required: *id177
+ type: object
+ required: *id178
type: object
- description: Resource deleted.
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Remove an smb share
+ summary: Get smb usersgroups authorization resource
tags:
- SMB
+ /api/summary:
get:
- description: "\n Get an smb share by cluster and share id\n "
- parameters:
- - description: Unique identifier for the cluster
- in: path
- name: cluster_id
- required: true
- schema:
- type: string
- - description: Unique identifier for the share
- in: path
- name: share_id
- required: true
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
- browseable:
- description: Indicates if the share is browseable
- type: boolean
- cephfs:
- description: Configuration for the CephFS share
+ executing_tasks:
+ description: ''
+ items:
+ type: string
+ type: array
+ finished_tasks:
+ description: ''
+ items:
+ properties:
+ begin_time:
+ description: ''
+ type: string
+ duration:
+ description: ''
+ type: integer
+ end_time:
+ description: ''
+ type: string
+ exception:
+ description: ''
+ type: string
+ metadata:
+ description: ''
+ properties:
+ pool:
+ description: ''
+ type: integer
+ required: &id179
+ - pool
+ type: object
+ name:
+ description: ''
+ type: string
+ progress:
+ description: ''
+ type: integer
+ ret_value:
+ description: ''
+ type: string
+ success:
+ description: ''
+ type: boolean
+ required: &id180
+ - name
+ - metadata
+ - begin_time
+ - end_time
+ - duration
+ - progress
+ - success
+ - ret_value
+ - exception
+ type: object
+ type: array
+ have_mon_connection:
+ description: ''
+ type: string
+ health_status:
+ description: ''
+ type: string
+ mgr_host:
+ description: ''
+ type: string
+ mgr_id:
+ description: ''
+ type: string
+ rbd_mirroring:
+ description: ''
properties:
- path:
- description: Path within the CephFS file system
- type: string
- provider:
- description: Provider of the CephFS share, e.g., 'samba-vfs'
- type: string
- subvolume:
- description: Subvolume within the CephFS file system
- type: string
- subvolumegroup:
- description: Subvolume Group in CephFS file system
- type: string
- volume:
- description: Name of the CephFS file system
- type: string
- required:
- - volume
- - path
- - provider
- - subvolumegroup
- - subvolume
+ errors:
+ description: ''
+ type: integer
+ warnings:
+ description: ''
+ type: integer
+ required: &id181
+ - warnings
+ - errors
type: object
- cluster_id:
- description: Unique identifier for the cluster
+ version:
+ description: ''
type: string
- intent:
- description: Desired state of the resource, e.g., 'present' or
- 'removed'
+ required: &id182
+ - health_status
+ - mgr_id
+ - mgr_host
+ - have_mon_connection
+ - executing_tasks
+ - finished_tasks
+ - version
+ - rbd_mirroring
+ type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ executing_tasks:
+ description: ''
+ items:
+ type: string
+ type: array
+ finished_tasks:
+ description: ''
+ items:
+ properties:
+ begin_time:
+ description: ''
+ type: string
+ duration:
+ description: ''
+ type: integer
+ end_time:
+ description: ''
+ type: string
+ exception:
+ description: ''
+ type: string
+ metadata:
+ description: ''
+ properties:
+ pool:
+ description: ''
+ type: integer
+ required: *id179
+ type: object
+ name:
+ description: ''
+ type: string
+ progress:
+ description: ''
+ type: integer
+ ret_value:
+ description: ''
+ type: string
+ success:
+ description: ''
+ type: boolean
+ required: *id180
+ type: object
+ type: array
+ have_mon_connection:
+ description: ''
type: string
- name:
- description: Name of the share
+ health_status:
+ description: ''
type: string
- readonly:
- description: Indicates if the share is read-only
- type: boolean
- resource_type:
- description: ceph.smb.share
+ mgr_host:
+ description: ''
type: string
- share_id:
- description: Unique identifier for the share
+ mgr_id:
+ description: ''
+ type: string
+ rbd_mirroring:
+ description: ''
+ properties:
+ errors:
+ description: ''
+ type: integer
+ warnings:
+ description: ''
+ type: integer
+ required: *id181
+ type: object
+ version:
+ description: ''
type: string
- required:
- - resource_type
- - cluster_id
- - share_id
- - intent
- - name
- - readonly
- - browseable
- - cephfs
+ required: *id182
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get an smb share
+ summary: Display Summary
tags:
- - SMB
- /api/smb/usersgroups:
+ - Summary
+ /api/task:
get:
- description: "\n List all smb usersgroups resources\n\n :return:\
- \ Returns list of usersgroups\n :rtype: List[Dict]\n "
- parameters: []
+ parameters:
+ - allowEmptyValue: true
+ description: Task Name
+ in: query
+ name: name
+ schema:
+ type: string
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
- items:
- properties:
- intent:
- description: Desired state of the resource, e.g., 'present'
- or 'removed'
- type: string
- linked_to_cluster:
- description: Optional string containing a cluster ID. If
- set, the resource is linked to the cluster and will be automatically
- removed when the cluster is removed
- type: string
- resource_type:
- description: ceph.smb.usersgroups
- type: string
- users_groups_id:
- description: A short string identifying the usersgroups resource
- type: string
- values:
- description: Required object containing users and groups information
+ properties:
+ executing_tasks:
+ description: ongoing executing tasks
+ type: string
+ finished_tasks:
+ description: ''
+ items:
properties:
- groups:
- description: List of group objects, each containing a name
- items:
- properties:
- name:
- description: The name of the group
- type: string
- required:
- - name
- type: object
- type: array
- users:
- description: List of user objects, each containing a name
- and password
- items:
- properties:
- name:
- description: The user name
- type: string
- password:
- description: The password for the user
- type: string
- required:
- - name
- - password
- type: object
- type: array
- required:
- - users
- - groups
+ begin_time:
+ description: Task begin time
+ type: string
+ duration:
+ description: ''
+ type: integer
+ end_time:
+ description: Task end time
+ type: string
+ exception:
+ description: ''
+ type: boolean
+ metadata:
+ description: ''
+ properties:
+ pool:
+ description: ''
+ type: integer
+ required: &id183
+ - pool
+ type: object
+ name:
+ description: finished tasks name
+ type: string
+ progress:
+ description: Progress of tasks
+ type: integer
+ ret_value:
+ description: ''
+ type: boolean
+ success:
+ description: ''
+ type: boolean
+ required: &id184
+ - name
+ - metadata
+ - begin_time
+ - end_time
+ - duration
+ - progress
+ - success
+ - ret_value
+ - exception
type: object
- type: object
- required:
- - resource_type
- - users_groups_id
- - intent
- - values
- - linked_to_cluster
- type: array
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: List smb user resources
- tags:
- - SMB
- post:
- description: "\n Create smb usersgroups resource\n\n :return:\
- \ Returns usersgroups resource.\n :rtype: Dict\n "
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- usersgroups:
- type: string
- required:
- - usersgroups
- type: object
- responses:
- '201':
- content:
+ type: array
+ required: &id185
+ - executing_tasks
+ - finished_tasks
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties:
- results:
- description: List of operation results
+ executing_tasks:
+ description: ongoing executing tasks
+ type: string
+ finished_tasks:
+ description: ''
items:
properties:
- resource:
- description: Resource
+ begin_time:
+ description: Task begin time
+ type: string
+ duration:
+ description: ''
+ type: integer
+ end_time:
+ description: Task end time
+ type: string
+ exception:
+ description: ''
+ type: boolean
+ metadata:
+ description: ''
properties:
- results:
- description: List of operation results
- items:
- properties:
- resource:
- description: Resource
- properties:
- auth:
- description: Authentication credentials
- properties:
- password:
- description: Password for authentication
- type: string
- username:
- description: Username for authentication
- type: string
- required:
- - username
- - password
- type: object
- auth_id:
- description: Unique identifier for the join
- auth resource
- type: string
- intent:
- description: Desired state of the resource,
- e.g., 'present' or 'removed'
- type: string
- linked_to_cluster:
- description: Optional string containing a
- cluster ID. If set, the resource is
- linked to the cluster and will be automatically
- removed when the cluster is removed
- type: string
- resource_type:
- description: ceph.smb.join.auth
- type: string
- required:
- - resource_type
- - auth_id
- - intent
- - auth
- - linked_to_cluster
- type: object
- state:
- description: The current state of the resource, e.g.,
- 'created', 'updated', 'deleted'
- type: string
- success:
- description: Indicates if the operation was successful
- type: boolean
- required:
- - resource
- - state
- - success
- type: object
- type: array
- success:
- description: Indicates if the overall operation was
- successful
- type: boolean
- required:
- - results
- - success
+ pool:
+ description: ''
+ type: integer
+ required: *id183
type: object
- state:
- description: The current state of the resource, e.g.,
- 'created', 'updated', 'deleted'
+ name:
+ description: finished tasks name
type: string
+ progress:
+ description: Progress of tasks
+ type: integer
+ ret_value:
+ description: ''
+ type: boolean
success:
- description: Indicates if the operation was successful
+ description: ''
type: boolean
- required:
- - resource
- - state
- - success
+ required: *id184
type: object
type: array
- success:
- description: Indicates if the overall operation was successful
- type: boolean
- required:
- - results
- - success
+ required: *id185
type: object
- description: Resource created.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Create smb usersgroups
+ summary: Display Tasks
tags:
- - SMB
- /api/smb/usersgroups/{users_groups_id}:
- delete:
- description: "\n Delete smb usersgroups resource\n\n :param users_group_id:\
- \ Users identifier\n :return: None.\n "
- parameters:
- - description: users_groups_id
- in: path
- name: users_groups_id
- required: true
- schema:
- type: string
+ - Task
+ /api/telemetry:
+ put:
+ description: "\n Enables or disables sending data collected by the Telemetry\n\
+ \ module.\n :param enable: Enable or disable sending data\n\
+ \ :type enable: bool\n :param license_name: License string e.g.\
+ \ 'sharing-1-0' to\n make sure the user is aware of and accepts the\
+ \ license\n for sharing Telemetry data.\n :type license_name:\
+ \ string\n "
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ enable:
+ default: true
+ type: boolean
+ license_name:
+ type: string
+ type: object
responses:
- '202':
+ '200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ schema:
+ type: object
+ description: Resource updated.
+ '202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
- properties: {}
type: object
- description: Resource deleted.
+ description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Delete smb join auth
tags:
- - SMB
+ - Telemetry
+ /api/telemetry/report:
get:
- description: "\n Get Users and groups resource\n\n :return: Returns\
- \ join auth.\n :rtype: Dict\n "
- parameters:
- - in: path
- name: users_groups_id
- required: true
- schema:
- type: string
+ description: "\n Get Ceph and device report data\n :return: Ceph\
+ \ and device report data\n :rtype: dict\n "
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
- intent:
- description: Desired state of the resource, e.g., 'present' or
- 'removed'
- type: string
- linked_to_cluster:
- description: Optional string containing a cluster ID. If set,
- the resource is linked to the cluster and will be automatically
- removed when the cluster is removed
- type: string
- resource_type:
- description: ceph.smb.usersgroups
- type: string
- users_groups_id:
- description: A short string identifying the usersgroups resource
+ device_report:
+ description: ''
type: string
- values:
- description: Required object containing users and groups information
+ report:
+ description: ''
properties:
- groups:
- description: List of group objects, each containing a name
+ balancer:
+ description: ''
+ properties:
+ active:
+ description: ''
+ type: boolean
+ mode:
+ description: ''
+ type: string
+ required: &id186
+ - active
+ - mode
+ type: object
+ channels:
+ description: ''
items:
- properties:
- name:
- description: The name of the group
- type: string
- required:
- - name
- type: object
+ type: string
type: array
- users:
- description: List of user objects, each containing a name
- and password
+ channels_available:
+ description: ''
items:
- properties:
- name:
- description: The user name
+ type: string
+ type: array
+ config:
+ description: ''
+ properties:
+ active_changed:
+ description: ''
+ items:
type: string
- password:
- description: The password for the user
+ type: array
+ cluster_changed:
+ description: ''
+ items:
type: string
- required:
- - name
- - password
- type: object
- type: array
- required:
- - users
- - groups
- type: object
- required:
- - resource_type
- - users_groups_id
- - intent
- - values
- - linked_to_cluster
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Get smb usersgroups authorization resource
- tags:
- - SMB
- /api/summary:
- get:
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- schema:
- properties:
- executing_tasks:
- description: ''
- items:
- type: string
- type: array
- finished_tasks:
- description: ''
- items:
- properties:
- begin_time:
- description: ''
- type: string
- duration:
- description: ''
+ type: array
+ required: &id187
+ - cluster_changed
+ - active_changed
+ type: object
+ crashes:
+ description: ''
+ items:
type: integer
- end_time:
- description: ''
- type: string
- exception:
- description: ''
- type: string
- metadata:
- description: ''
- properties:
- pool:
- description: ''
+ type: array
+ created:
+ description: ''
+ type: string
+ crush:
+ description: ''
+ properties:
+ bucket_algs:
+ description: ''
+ properties:
+ straw2:
+ description: ''
+ type: integer
+ required: &id188
+ - straw2
+ type: object
+ bucket_sizes:
+ description: ''
+ properties:
+ '1':
+ description: ''
+ type: integer
+ '3':
+ description: ''
+ type: integer
+ required: &id189
+ - '1'
+ - '3'
+ type: object
+ bucket_types:
+ description: ''
+ properties:
+ '1':
+ description: ''
+ type: integer
+ '11':
+ description: ''
+ type: integer
+ required: &id190
+ - '1'
+ - '11'
+ type: object
+ compat_weight_set:
+ description: ''
+ type: boolean
+ device_classes:
+ description: ''
+ items:
type: integer
- required:
- - pool
- type: object
- name:
- description: ''
- type: string
- progress:
- description: ''
- type: integer
- ret_value:
- description: ''
- type: string
- success:
- description: ''
- type: boolean
- required:
- - name
- - metadata
- - begin_time
- - end_time
- - duration
- - progress
- - success
- - ret_value
- - exception
- type: object
- type: array
- have_mon_connection:
- description: ''
- type: string
- health_status:
- description: ''
- type: string
- mgr_host:
- description: ''
- type: string
- mgr_id:
- description: ''
- type: string
- rbd_mirroring:
- description: ''
- properties:
- errors:
+ type: array
+ num_buckets:
+ description: ''
+ type: integer
+ num_devices:
+ description: ''
+ type: integer
+ num_rules:
+ description: ''
+ type: integer
+ num_types:
+ description: ''
+ type: integer
+ num_weight_sets:
+ description: ''
+ type: integer
+ tunables:
+ description: ''
+ properties:
+ allowed_bucket_algs:
+ description: ''
+ type: integer
+ choose_local_fallback_tries:
+ description: ''
+ type: integer
+ choose_local_tries:
+ description: ''
+ type: integer
+ choose_total_tries:
+ description: ''
+ type: integer
+ chooseleaf_descend_once:
+ description: ''
+ type: integer
+ chooseleaf_stable:
+ description: ''
+ type: integer
+ chooseleaf_vary_r:
+ description: ''
+ type: integer
+ has_v2_rules:
+ description: ''
+ type: integer
+ has_v3_rules:
+ description: ''
+ type: integer
+ has_v4_buckets:
+ description: ''
+ type: integer
+ has_v5_rules:
+ description: ''
+ type: integer
+ legacy_tunables:
+ description: ''
+ type: integer
+ minimum_required_version:
+ description: ''
+ type: string
+ optimal_tunables:
+ description: ''
+ type: integer
+ profile:
+ description: ''
+ type: string
+ require_feature_tunables:
+ description: ''
+ type: integer
+ require_feature_tunables2:
+ description: ''
+ type: integer
+ require_feature_tunables3:
+ description: ''
+ type: integer
+ require_feature_tunables5:
+ description: ''
+ type: integer
+ straw_calc_version:
+ description: ''
+ type: integer
+ required: &id191
+ - choose_local_tries
+ - choose_local_fallback_tries
+ - choose_total_tries
+ - chooseleaf_descend_once
+ - chooseleaf_vary_r
+ - chooseleaf_stable
+ - straw_calc_version
+ - allowed_bucket_algs
+ - profile
+ - optimal_tunables
+ - legacy_tunables
+ - minimum_required_version
+ - require_feature_tunables
+ - require_feature_tunables2
+ - has_v2_rules
+ - require_feature_tunables3
+ - has_v3_rules
+ - has_v4_buckets
+ - require_feature_tunables5
+ - has_v5_rules
+ type: object
+ required: &id192
+ - num_devices
+ - num_types
+ - num_buckets
+ - num_rules
+ - device_classes
+ - tunables
+ - compat_weight_set
+ - num_weight_sets
+ - bucket_algs
+ - bucket_sizes
+ - bucket_types
+ type: object
+ fs:
description: ''
- type: integer
- warnings:
+ properties:
+ count:
+ description: ''
+ type: integer
+ feature_flags:
+ description: ''
+ properties:
+ enable_multiple:
+ description: ''
+ type: boolean
+ ever_enabled_multiple:
+ description: ''
+ type: boolean
+ required: &id193
+ - enable_multiple
+ - ever_enabled_multiple
+ type: object
+ filesystems:
+ description: ''
+ items:
+ type: integer
+ type: array
+ num_standby_mds:
+ description: ''
+ type: integer
+ total_num_mds:
+ description: ''
+ type: integer
+ required: &id194
+ - count
+ - feature_flags
+ - num_standby_mds
+ - filesystems
+ - total_num_mds
+ type: object
+ hosts:
+ description: ''
+ properties:
+ num:
+ description: ''
+ type: integer
+ num_with_mds:
+ description: ''
+ type: integer
+ num_with_mgr:
+ description: ''
+ type: integer
+ num_with_mon:
+ description: ''
+ type: integer
+ num_with_osd:
+ description: ''
+ type: integer
+ required: &id195
+ - num
+ - num_with_mon
+ - num_with_mds
+ - num_with_osd
+ - num_with_mgr
+ type: object
+ leaderboard:
+ description: ''
+ type: boolean
+ license:
+ description: ''
+ type: string
+ metadata:
+ description: ''
+ properties:
+ mon:
+ description: ''
+ properties:
+ arch:
+ description: ''
+ properties:
+ x86_64:
+ description: ''
+ type: integer
+ required: &id196
+ - x86_64
+ type: object
+ ceph_version:
+ description: ''
+ properties:
+ ceph version 16.0.0-3151-gf202994fcf:
+ description: ''
+ type: integer
+ required: &id197
+ - ceph version 16.0.0-3151-gf202994fcf
+ type: object
+ cpu:
+ description: ''
+ properties:
+ Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
+ description: ''
+ type: integer
+ required: &id198
+ - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
+ type: object
+ distro:
+ description: ''
+ properties:
+ centos:
+ description: ''
+ type: integer
+ required: &id199
+ - centos
+ type: object
+ distro_description:
+ description: ''
+ properties:
+ CentOS Linux 8 (Core):
+ description: ''
+ type: integer
+ required: &id200
+ - CentOS Linux 8 (Core)
+ type: object
+ kernel_description:
+ description: ''
+ properties:
+ '#1 SMP Wed Jul 1 19:53:01 UTC 2020':
+ description: ''
+ type: integer
+ required: &id201
+ - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
+ type: object
+ kernel_version:
+ description: ''
+ properties:
+ 5.7.7-200.fc32.x86_64:
+ description: ''
+ type: integer
+ required: &id202
+ - 5.7.7-200.fc32.x86_64
+ type: object
+ os:
+ description: ''
+ properties:
+ Linux:
+ description: ''
+ type: integer
+ required: &id203
+ - Linux
+ type: object
+ required: &id204
+ - arch
+ - ceph_version
+ - os
+ - cpu
+ - kernel_description
+ - kernel_version
+ - distro_description
+ - distro
+ type: object
+ osd:
+ description: ''
+ properties:
+ arch:
+ description: ''
+ properties:
+ x86_64:
+ description: ''
+ type: integer
+ required: &id205
+ - x86_64
+ type: object
+ ceph_version:
+ description: ''
+ properties:
+ ceph version 16.0.0-3151-gf202994fcf:
+ description: ''
+ type: integer
+ required: &id206
+ - ceph version 16.0.0-3151-gf202994fcf
+ type: object
+ cpu:
+ description: ''
+ properties:
+ Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
+ description: ''
+ type: integer
+ required: &id207
+ - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
+ type: object
+ distro:
+ description: ''
+ properties:
+ centos:
+ description: ''
+ type: integer
+ required: &id208
+ - centos
+ type: object
+ distro_description:
+ description: ''
+ properties:
+ CentOS Linux 8 (Core):
+ description: ''
+ type: integer
+ required: &id209
+ - CentOS Linux 8 (Core)
+ type: object
+ kernel_description:
+ description: ''
+ properties:
+ '#1 SMP Wed Jul 1 19:53:01 UTC 2020':
+ description: ''
+ type: integer
+ required: &id210
+ - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
+ type: object
+ kernel_version:
+ description: ''
+ properties:
+ 5.7.7-200.fc32.x86_64:
+ description: ''
+ type: integer
+ required: &id211
+ - 5.7.7-200.fc32.x86_64
+ type: object
+ os:
+ description: ''
+ properties:
+ Linux:
+ description: ''
+ type: integer
+ required: &id212
+ - Linux
+ type: object
+ osd_objectstore:
+ description: ''
+ properties:
+ bluestore:
+ description: ''
+ type: integer
+ required: &id213
+ - bluestore
+ type: object
+ rotational:
+ description: ''
+ properties:
+ '1':
+ description: ''
+ type: integer
+ required: &id214
+ - '1'
+ type: object
+ required: &id215
+ - osd_objectstore
+ - rotational
+ - arch
+ - ceph_version
+ - os
+ - cpu
+ - kernel_description
+ - kernel_version
+ - distro_description
+ - distro
+ type: object
+ required: &id216
+ - osd
+ - mon
+ type: object
+ mon:
description: ''
- type: integer
- required:
- - warnings
- - errors
- type: object
- version:
- description: ''
- type: string
- required:
- - health_status
- - mgr_id
- - mgr_host
- - have_mon_connection
- - executing_tasks
- - finished_tasks
- - version
- - rbd_mirroring
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Display Summary
- tags:
- - Summary
- /api/task:
- get:
- parameters:
- - allowEmptyValue: true
- description: Task Name
- in: query
- name: name
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- schema:
- properties:
- executing_tasks:
- description: ongoing executing tasks
- type: string
- finished_tasks:
- description: ''
- items:
- properties:
- begin_time:
- description: Task begin time
- type: string
- duration:
- description: ''
- type: integer
- end_time:
- description: Task end time
- type: string
- exception:
- description: ''
- type: boolean
- metadata:
- description: ''
+ properties:
+ count:
+ description: ''
+ type: integer
+ features:
+ description: ''
+ properties:
+ optional:
+ description: ''
+ items:
+ type: integer
+ type: array
+ persistent:
+ description: ''
+ items:
+ type: string
+ type: array
+ required: &id217
+ - persistent
+ - optional
+ type: object
+ ipv4_addr_mons:
+ description: ''
+ type: integer
+ ipv6_addr_mons:
+ description: ''
+ type: integer
+ min_mon_release:
+ description: ''
+ type: integer
+ v1_addr_mons:
+ description: ''
+ type: integer
+ v2_addr_mons:
+ description: ''
+ type: integer
+ required: &id218
+ - count
+ - features
+ - min_mon_release
+ - v1_addr_mons
+ - v2_addr_mons
+ - ipv4_addr_mons
+ - ipv6_addr_mons
+ type: object
+ osd:
+ description: ''
+ properties:
+ cluster_network:
+ description: ''
+ type: boolean
+ count:
+ description: ''
+ type: integer
+ require_min_compat_client:
+ description: ''
+ type: string
+ require_osd_release:
+ description: ''
+ type: string
+ required: &id219
+ - count
+ - require_osd_release
+ - require_min_compat_client
+ - cluster_network
+ type: object
+ pools:
+ description: ''
+ items:
properties:
+ cache_mode:
+ description: ''
+ type: string
+ erasure_code_profile:
+ description: ''
+ type: string
+ min_size:
+ description: ''
+ type: integer
+ pg_autoscale_mode:
+ description: ''
+ type: string
+ pg_num:
+ description: ''
+ type: integer
+ pgp_num:
+ description: ''
+ type: integer
pool:
description: ''
type: integer
- required:
+ size:
+ description: ''
+ type: integer
+ target_max_bytes:
+ description: ''
+ type: integer
+ target_max_objects:
+ description: ''
+ type: integer
+ type:
+ description: ''
+ type: string
+ required: &id220
- pool
+ - type
+ - pg_num
+ - pgp_num
+ - size
+ - min_size
+ - pg_autoscale_mode
+ - target_max_bytes
+ - target_max_objects
+ - erasure_code_profile
+ - cache_mode
type: object
- name:
- description: finished tasks name
- type: string
- progress:
- description: Progress of tasks
- type: integer
- ret_value:
- description: ''
- type: boolean
- success:
- description: ''
- type: boolean
- required:
- - name
- - metadata
- - begin_time
- - end_time
- - duration
- - progress
- - success
- - ret_value
- - exception
- type: object
- type: array
- required:
- - executing_tasks
- - finished_tasks
- type: object
- description: OK
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- summary: Display Tasks
- tags:
- - Task
- /api/telemetry:
- put:
- description: "\n Enables or disables sending data collected by the Telemetry\n\
- \ module.\n :param enable: Enable or disable sending data\n\
- \ :type enable: bool\n :param license_name: License string e.g.\
- \ 'sharing-1-0' to\n make sure the user is aware of and accepts the\
- \ license\n for sharing Telemetry data.\n :type license_name:\
- \ string\n "
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- enable:
- default: true
- type: boolean
- license_name:
- type: string
- type: object
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource updated.
- '202':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '400':
- description: Operation exception. Please check the response body for details.
- '401':
- description: Unauthenticated access. Please login first.
- '403':
- description: Unauthorized access. Please check your permissions.
- '500':
- description: Unexpected error. Please check the response body for the stack
- trace.
- security:
- - jwt: []
- tags:
- - Telemetry
- /api/telemetry/report:
- get:
- description: "\n Get Ceph and device report data\n :return: Ceph\
- \ and device report data\n :rtype: dict\n "
- parameters: []
- responses:
- '200':
- content:
+ type: array
+ rbd:
+ description: ''
+ properties:
+ mirroring_by_pool:
+ description: ''
+ items:
+ type: boolean
+ type: array
+ num_images_by_pool:
+ description: ''
+ items:
+ type: integer
+ type: array
+ num_pools:
+ description: ''
+ type: integer
+ required: &id221
+ - num_pools
+ - num_images_by_pool
+ - mirroring_by_pool
+ type: object
+ report_id:
+ description: ''
+ type: string
+ report_timestamp:
+ description: ''
+ type: string
+ report_version:
+ description: ''
+ type: integer
+ rgw:
+ description: ''
+ properties:
+ count:
+ description: ''
+ type: integer
+ frontends:
+ description: ''
+ items:
+ type: string
+ type: array
+ zonegroups:
+ description: ''
+ type: integer
+ zones:
+ description: ''
+ type: integer
+ required: &id222
+ - count
+ - zones
+ - zonegroups
+ - frontends
+ type: object
+ services:
+ description: ''
+ properties:
+ rgw:
+ description: ''
+ type: integer
+ required: &id223
+ - rgw
+ type: object
+ usage:
+ description: ''
+ properties:
+ pg_num:
+ description: ''
+ type: integer
+ pools:
+ description: ''
+ type: integer
+ total_avail_bytes:
+ description: ''
+ type: integer
+ total_bytes:
+ description: ''
+ type: integer
+ total_used_bytes:
+ description: ''
+ type: integer
+ required: &id224
+ - pools
+ - pg_num
+ - total_used_bytes
+ - total_bytes
+ - total_avail_bytes
+ type: object
+ required: &id225
+ - leaderboard
+ - report_version
+ - report_timestamp
+ - report_id
+ - channels
+ - channels_available
+ - license
+ - created
+ - mon
+ - config
+ - rbd
+ - pools
+ - osd
+ - crush
+ - fs
+ - metadata
+ - hosts
+ - usage
+ - services
+ - rgw
+ - balancer
+ - crashes
+ type: object
+ required: &id226
+ - report
+ - device_report
+ type: object
application/vnd.ceph.api.v1.0+json:
schema:
properties:
mode:
description: ''
type: string
- required:
- - active
- - mode
+ required: *id186
type: object
channels:
description: ''
items:
type: string
type: array
- required:
- - cluster_changed
- - active_changed
+ required: *id187
type: object
crashes:
description: ''
straw2:
description: ''
type: integer
- required:
- - straw2
+ required: *id188
type: object
bucket_sizes:
description: ''
'3':
description: ''
type: integer
- required:
- - '1'
- - '3'
+ required: *id189
type: object
bucket_types:
description: ''
'11':
description: ''
type: integer
- required:
- - '1'
- - '11'
+ required: *id190
type: object
compat_weight_set:
description: ''
straw_calc_version:
description: ''
type: integer
- required:
- - choose_local_tries
- - choose_local_fallback_tries
- - choose_total_tries
- - chooseleaf_descend_once
- - chooseleaf_vary_r
- - chooseleaf_stable
- - straw_calc_version
- - allowed_bucket_algs
- - profile
- - optimal_tunables
- - legacy_tunables
- - minimum_required_version
- - require_feature_tunables
- - require_feature_tunables2
- - has_v2_rules
- - require_feature_tunables3
- - has_v3_rules
- - has_v4_buckets
- - require_feature_tunables5
- - has_v5_rules
+ required: *id191
type: object
- required:
- - num_devices
- - num_types
- - num_buckets
- - num_rules
- - device_classes
- - tunables
- - compat_weight_set
- - num_weight_sets
- - bucket_algs
- - bucket_sizes
- - bucket_types
+ required: *id192
type: object
fs:
description: ''
ever_enabled_multiple:
description: ''
type: boolean
- required:
- - enable_multiple
- - ever_enabled_multiple
+ required: *id193
type: object
filesystems:
description: ''
total_num_mds:
description: ''
type: integer
- required:
- - count
- - feature_flags
- - num_standby_mds
- - filesystems
- - total_num_mds
+ required: *id194
type: object
hosts:
description: ''
num_with_osd:
description: ''
type: integer
- required:
- - num
- - num_with_mon
- - num_with_mds
- - num_with_osd
- - num_with_mgr
+ required: *id195
type: object
leaderboard:
description: ''
x86_64:
description: ''
type: integer
- required:
- - x86_64
+ required: *id196
type: object
ceph_version:
description: ''
ceph version 16.0.0-3151-gf202994fcf:
description: ''
type: integer
- required:
- - ceph version 16.0.0-3151-gf202994fcf
+ required: *id197
type: object
cpu:
description: ''
Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
description: ''
type: integer
- required:
- - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
+ required: *id198
type: object
distro:
description: ''
centos:
description: ''
type: integer
- required:
- - centos
+ required: *id199
type: object
distro_description:
description: ''
CentOS Linux 8 (Core):
description: ''
type: integer
- required:
- - CentOS Linux 8 (Core)
+ required: *id200
type: object
kernel_description:
description: ''
'#1 SMP Wed Jul 1 19:53:01 UTC 2020':
description: ''
type: integer
- required:
- - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
+ required: *id201
type: object
kernel_version:
description: ''
5.7.7-200.fc32.x86_64:
description: ''
type: integer
- required:
- - 5.7.7-200.fc32.x86_64
+ required: *id202
type: object
os:
description: ''
Linux:
description: ''
type: integer
- required:
- - Linux
+ required: *id203
type: object
- required:
- - arch
- - ceph_version
- - os
- - cpu
- - kernel_description
- - kernel_version
- - distro_description
- - distro
+ required: *id204
type: object
osd:
description: ''
x86_64:
description: ''
type: integer
- required:
- - x86_64
+ required: *id205
type: object
ceph_version:
description: ''
ceph version 16.0.0-3151-gf202994fcf:
description: ''
type: integer
- required:
- - ceph version 16.0.0-3151-gf202994fcf
+ required: *id206
type: object
cpu:
description: ''
Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
description: ''
type: integer
- required:
- - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
+ required: *id207
type: object
distro:
description: ''
centos:
description: ''
type: integer
- required:
- - centos
+ required: *id208
type: object
distro_description:
description: ''
CentOS Linux 8 (Core):
description: ''
type: integer
- required:
- - CentOS Linux 8 (Core)
+ required: *id209
type: object
kernel_description:
description: ''
'#1 SMP Wed Jul 1 19:53:01 UTC 2020':
description: ''
type: integer
- required:
- - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
+ required: *id210
type: object
kernel_version:
description: ''
5.7.7-200.fc32.x86_64:
description: ''
type: integer
- required:
- - 5.7.7-200.fc32.x86_64
+ required: *id211
type: object
os:
description: ''
Linux:
description: ''
type: integer
- required:
- - Linux
+ required: *id212
type: object
osd_objectstore:
description: ''
bluestore:
description: ''
type: integer
- required:
- - bluestore
+ required: *id213
type: object
rotational:
description: ''
'1':
description: ''
type: integer
- required:
- - '1'
+ required: *id214
type: object
- required:
- - osd_objectstore
- - rotational
- - arch
- - ceph_version
- - os
- - cpu
- - kernel_description
- - kernel_version
- - distro_description
- - distro
+ required: *id215
type: object
- required:
- - osd
- - mon
+ required: *id216
type: object
mon:
description: ''
items:
type: string
type: array
- required:
- - persistent
- - optional
+ required: *id217
type: object
ipv4_addr_mons:
description: ''
v2_addr_mons:
description: ''
type: integer
- required:
- - count
- - features
- - min_mon_release
- - v1_addr_mons
- - v2_addr_mons
- - ipv4_addr_mons
- - ipv6_addr_mons
+ required: *id218
type: object
osd:
description: ''
require_osd_release:
description: ''
type: string
- required:
- - count
- - require_osd_release
- - require_min_compat_client
- - cluster_network
+ required: *id219
type: object
pools:
description: ''
type:
description: ''
type: string
- required:
- - pool
- - type
- - pg_num
- - pgp_num
- - size
- - min_size
- - pg_autoscale_mode
- - target_max_bytes
- - target_max_objects
- - erasure_code_profile
- - cache_mode
+ required: *id220
type: object
type: array
rbd:
num_pools:
description: ''
type: integer
- required:
- - num_pools
- - num_images_by_pool
- - mirroring_by_pool
+ required: *id221
type: object
report_id:
description: ''
zones:
description: ''
type: integer
- required:
- - count
- - zones
- - zonegroups
- - frontends
+ required: *id222
type: object
services:
description: ''
rgw:
description: ''
type: integer
- required:
- - rgw
+ required: *id223
type: object
usage:
description: ''
total_used_bytes:
description: ''
type: integer
- required:
- - pools
- - pg_num
- - total_used_bytes
- - total_bytes
- - total_avail_bytes
+ required: *id224
type: object
- required:
- - leaderboard
- - report_version
- - report_timestamp
- - report_id
- - channels
- - channels_available
- - license
- - created
- - mon
- - config
- - rbd
- - pools
- - osd
- - crush
- - fs
- - metadata
- - hosts
- - usage
- - services
- - rgw
- - balancer
- - crashes
+ required: *id225
type: object
- required:
- - report
- - device_report
+ required: *id226
type: object
description: OK
'400':
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/json:
schema:
properties:
email:
username:
description: Username of the user
type: string
- required:
+ required: &id227
- username
- roles
- name
- pwdExpirationDate
- pwdUpdateRequired
type: object
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ email:
+ description: User email address
+ type: string
+ enabled:
+ description: Is the user enabled?
+ type: boolean
+ lastUpdate:
+ description: Details last updated
+ type: integer
+ name:
+ description: User Name
+ type: string
+ pwdExpirationDate:
+ description: Password Expiration date
+ type: string
+ pwdUpdateRequired:
+ description: Is Password Update Required?
+ type: boolean
+ roles:
+ description: User Roles
+ items:
+ type: string
+ type: array
+ username:
+ description: Username of the user
+ type: string
+ required: *id227
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
responses:
'200':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource updated.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
responses:
'201':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Resource created.
'202':
content:
+ application/json:
+ schema:
+ type: object
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ type: object
description: Operation is still executing. Please check the task queue.
'400':
description: Operation exception. Please check the response body for details.
projects / ceph.git / commitdiff