- jwt: []
tags:
- Cephfs
- /api/cephfs/{fs_id}:
- get:
- parameters:
- - in: path
- name: fs_id
- required: true
- schema:
- type: string
+ post:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ name:
+ type: string
+ service_spec:
+ type: string
+ required:
+ - name
+ - service_spec
+ type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
- jwt: []
tags:
- Cephfs
- /api/cephfs/{fs_id}/client/{client_id}:
+ /api/cephfs/remove/{name}:
delete:
parameters:
- - in: path
- name: fs_id
- required: true
- schema:
- type: string
- - in: path
- name: client_id
+ - description: File System Name
+ in: path
+ name: name
required: true
schema:
type: string
trace.
security:
- jwt: []
+ summary: Remove CephFS Volume
tags:
- Cephfs
- /api/cephfs/{fs_id}/clients:
- get:
- parameters:
- - in: path
- name: fs_id
- required: true
- schema:
- type: string
+ /api/cephfs/rename:
+ put:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ name:
+ description: Existing FS Name
+ type: string
+ new_name:
+ description: New FS Name
+ type: string
+ required:
+ - name
+ - new_name
+ type: object
responses:
'200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
trace.
security:
- jwt: []
+ summary: Rename CephFS Volume
tags:
- Cephfs
- /api/cephfs/{fs_id}/get_root_directory:
- get:
- description: "\n The root directory that can't be fetched using ls_dir\
- \ (api).\n :param fs_id: The filesystem identifier.\n :return:\
- \ The root directory\n :rtype: dict\n "
- parameters:
- - in: path
- name: fs_id
- required: true
- schema:
- type: string
+ /api/cephfs/subvolume:
+ post:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ subvol_name:
+ type: string
+ vol_name:
+ type: string
+ required:
+ - vol_name
+ - subvol_name
+ type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - Cephfs
- /api/cephfs/{fs_id}/ls_dir:
- get:
- description: "\n List directories of specified path.\n :param\
- \ fs_id: The filesystem identifier.\n :param path: The path where to\
- \ start listing the directory content.\n Defaults to '/' if not set.\n\
- \ :type path: str | bytes\n :param depth: The number of steps\
- \ to go down the directory tree.\n :type depth: int | str\n \
- \ :return: The names of the directories below the specified path.\n \
- \ :rtype: list\n "
- parameters:
- - in: path
- name: fs_id
- required: true
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: path
- schema:
- type: string
- - default: 1
- in: query
- name: depth
- schema:
- type: integer
+ - CephFSSubvolume
+ /api/cephfs/subvolume/group:
+ post:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ group_name:
+ type: string
+ vol_name:
+ type: string
+ required:
+ - vol_name
+ - group_name
+ type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - Cephfs
- /api/cephfs/{fs_id}/mds_counters:
- get:
+ - CephfsSubvolumeGroup
+ /api/cephfs/subvolume/group/{vol_name}:
+ delete:
parameters:
- in: path
- name: fs_id
+ name: vol_name
required: true
schema:
type: string
- - allowEmptyValue: true
- in: query
- name: counters
+ - in: query
+ name: group_name
+ required: true
schema:
- type: integer
+ type: string
responses:
- '200':
+ '202':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - Cephfs
- /api/cephfs/{fs_id}/quota:
+ - CephfsSubvolumeGroup
get:
- description: "\n Get the quotas of the specified path.\n :param\
- \ fs_id: The filesystem identifier.\n :param path: The path of the\
- \ directory/file.\n :return: Returns a dictionary containing 'max_bytes'\n\
- \ and 'max_files'.\n :rtype: dict\n "
parameters:
- - description: File System Identifier
- in: path
- name: fs_id
- required: true
- schema:
- type: string
- - description: File System Path
- in: query
- name: path
+ - in: path
+ name: vol_name
required: true
schema:
type: string
'200':
content:
application/vnd.ceph.api.v1.0+json:
- schema:
- properties:
- max_bytes:
- description: ''
- type: integer
- max_files:
- description: ''
- type: integer
- required:
- - max_bytes
- - max_files
- type: object
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get Cephfs Quotas of the specified path
tags:
- - Cephfs
+ - CephfsSubvolumeGroup
put:
- description: "\n Set the quotas of the specified path.\n :param\
- \ fs_id: The filesystem identifier.\n :param path: The path of the\
- \ directory/file.\n :param max_bytes: The byte limit.\n :param\
- \ max_files: The file limit.\n "
parameters:
- in: path
- name: fs_id
+ name: vol_name
required: true
schema:
type: string
application/json:
schema:
properties:
- max_bytes:
- type: string
- max_files:
- type: string
- path:
+ group_name:
type: string
+ size:
+ type: integer
required:
- - path
+ - group_name
+ - size
type: object
responses:
'200':
security:
- jwt: []
tags:
- - Cephfs
- /api/cephfs/{fs_id}/snapshot:
- delete:
- description: "\n Remove a snapshot.\n :param fs_id: The filesystem\
- \ identifier.\n :param path: The path of the directory.\n :param\
- \ name: The name of the snapshot.\n "
+ - CephfsSubvolumeGroup
+ /api/cephfs/subvolume/group/{vol_name}/info:
+ get:
parameters:
- in: path
- name: fs_id
- required: true
- schema:
- type: string
- - in: query
- name: path
+ name: vol_name
required: true
schema:
type: string
- in: query
- name: name
+ name: group_name
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/vnd.ceph.api.v1.0+json:
type: object
- description: Resource deleted.
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Cephfs
- post:
- description: "\n Create a snapshot.\n :param fs_id: The filesystem\
- \ identifier.\n :param path: The path of the directory.\n :param\
- \ name: The name of the snapshot. If not specified, a name using the\n \
- \ current time in RFC3339 UTC format will be generated.\n :return:\
- \ The name of the snapshot.\n :rtype: str\n "
+ - CephfsSubvolumeGroup
+ /api/cephfs/subvolume/{vol_name}:
+ delete:
parameters:
- in: path
- name: fs_id
+ name: vol_name
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- name:
- type: string
- path:
- type: string
- required:
- - path
- type: object
+ - in: query
+ name: subvol_name
+ required: true
+ schema:
+ type: string
+ - default: ''
+ in: query
+ name: group_name
+ schema:
+ type: string
+ - default: false
+ in: query
+ name: retain_snapshots
+ schema:
+ type: boolean
responses:
- '201':
+ '202':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
- '202':
+ description: Operation is still executing. Please check the task queue.
+ '204':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Operation is still executing. Please check the task queue.
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Cephfs
- /api/cephfs/{fs_id}/tree:
- delete:
- description: "\n Remove a directory.\n :param fs_id: The filesystem\
- \ identifier.\n :param path: The path of the directory.\n "
+ - CephFSSubvolume
+ get:
parameters:
- in: path
- name: fs_id
+ name: vol_name
required: true
schema:
type: string
- - in: query
- name: path
- required: true
+ - default: ''
+ in: query
+ name: group_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/vnd.ceph.api.v1.0+json:
type: object
- description: Resource deleted.
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Cephfs
- post:
- description: "\n Create a directory.\n :param fs_id: The filesystem\
- \ identifier.\n :param path: The path of the directory.\n "
+ - CephFSSubvolume
+ put:
parameters:
- in: path
- name: fs_id
+ name: vol_name
required: true
schema:
type: string
application/json:
schema:
properties:
- path:
+ group_name:
+ default: ''
+ type: string
+ size:
+ type: integer
+ subvol_name:
type: string
required:
- - path
+ - subvol_name
+ - size
type: object
responses:
- '201':
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
+ description: Resource updated.
'202':
content:
application/vnd.ceph.api.v1.0+json:
security:
- jwt: []
tags:
- - Cephfs
- /api/cluster:
+ - CephFSSubvolume
+ /api/cephfs/subvolume/{vol_name}/info:
get:
- parameters: []
+ parameters:
+ - in: path
+ name: vol_name
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: subvol_name
+ required: true
+ schema:
+ type: string
+ - default: ''
+ in: query
+ name: group_name
+ schema:
+ type: string
responses:
'200':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get the cluster status
tags:
- - Cluster
- put:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- status:
- description: Cluster Status
- type: string
- required:
- - status
- type: object
+ - CephFSSubvolume
+ /api/cephfs/{fs_id}:
+ get:
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
responses:
'200':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource updated.
+ 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:
+ - Cephfs
+ /api/cephfs/{fs_id}/client/{client_id}:
+ delete:
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: client_id
+ required: true
+ schema:
+ type: string
+ responses:
'202':
content:
- application/vnd.ceph.api.v0.1+json:
+ 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':
trace.
security:
- jwt: []
- summary: Update the cluster status
tags:
- - Cluster
- /api/cluster/user:
+ - Cephfs
+ /api/cephfs/{fs_id}/clients:
get:
- description: "\n Get list of ceph users and its respective data\n \
- \ "
- parameters: []
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
responses:
'200':
content:
trace.
security:
- jwt: []
- summary: Get Ceph Users
tags:
- - Cluster
- post:
- description: "\n Add a ceph user with its defined capabilities.\n \
- \ :param user_entity: Entity to change\n :param capabilities: List\
- \ of capabilities to add to user_entity\n "
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- capabilities:
- type: string
- import_data:
- default: ''
- type: string
- user_entity:
- default: ''
- type: string
- type: object
+ - Cephfs
+ /api/cephfs/{fs_id}/get_root_directory:
+ get:
+ description: "\n The root directory that can't be fetched using ls_dir\
+ \ (api).\n :param fs_id: The filesystem identifier.\n :return:\
+ \ The root directory\n :rtype: dict\n "
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
+ '200':
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 Ceph User
tags:
- - Cluster
- put:
- description: "\n Change the ceph user capabilities.\n Setting\
- \ new capabilities will overwrite current ones.\n :param user_entity:\
- \ Entity to change\n :param capabilities: List of updated capabilities\
- \ to user_entity\n "
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- capabilities:
- type: string
- user_entity:
- default: ''
- type: string
- type: object
+ - Cephfs
+ /api/cephfs/{fs_id}/ls_dir:
+ get:
+ description: "\n List directories of specified path.\n :param\
+ \ fs_id: The filesystem identifier.\n :param path: The path where to\
+ \ start listing the directory content.\n Defaults to '/' if not set.\n\
+ \ :type path: str | bytes\n :param depth: The number of steps\
+ \ to go down the directory tree.\n :type depth: int | str\n \
+ \ :return: The names of the directories below the specified path.\n \
+ \ :rtype: list\n "
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: path
+ schema:
+ type: string
+ - default: 1
+ in: query
+ name: depth
+ schema:
+ type: integer
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.
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Edit Ceph User
tags:
- - Cluster
- /api/cluster/user/export:
- post:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- entities:
- type: string
- required:
- - entities
- type: object
+ - Cephfs
+ /api/cephfs/{fs_id}/mds_counters:
+ get:
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: counters
+ schema:
+ type: integer
responses:
- '201':
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
- '202':
+ 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:
+ - Cephfs
+ /api/cephfs/{fs_id}/quota:
+ get:
+ description: "\n Get the quotas of the specified path.\n :param\
+ \ fs_id: The filesystem identifier.\n :param path: The path of the\
+ \ directory/file.\n :return: Returns a dictionary containing 'max_bytes'\n\
+ \ and 'max_files'.\n :rtype: dict\n "
+ parameters:
+ - description: File System Identifier
+ in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
+ - description: File System Path
+ in: query
+ name: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
+ schema:
+ properties:
+ max_bytes:
+ description: ''
+ type: integer
+ max_files:
+ description: ''
+ type: integer
+ required:
+ - max_bytes
+ - max_files
+ type: object
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Export Ceph Users
+ summary: Get Cephfs Quotas of the specified path
tags:
- - Cluster
- /api/cluster/user/{user_entity}:
- delete:
- description: "\n Delete a ceph user and it's defined capabilities.\n\
- \ :param user_entity: Entity to delete\n "
+ - Cephfs
+ put:
+ description: "\n Set the quotas of the specified path.\n :param\
+ \ fs_id: The filesystem identifier.\n :param path: The path of the\
+ \ directory/file.\n :param max_bytes: The byte limit.\n :param\
+ \ max_files: The file limit.\n "
parameters:
- in: path
- name: user_entity
+ name: fs_id
required: true
schema:
type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ max_bytes:
+ type: string
+ max_files:
+ type: string
+ path:
+ type: string
+ required:
+ - path
+ type: object
responses:
- '202':
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ description: Resource updated.
+ '202':
content:
application/vnd.ceph.api.v1.0+json:
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 Ceph User
tags:
- - Cluster
- /api/cluster_conf:
- get:
- parameters: []
+ - Cephfs
+ /api/cephfs/{fs_id}/snapshot:
+ delete:
+ description: "\n Remove a snapshot.\n :param fs_id: The filesystem\
+ \ identifier.\n :param path: The path of the directory.\n :param\
+ \ name: The name of the snapshot.\n "
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: path
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: name
+ required: true
+ schema:
+ type: string
responses:
- '200':
+ '202':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - ClusterConfiguration
+ - Cephfs
post:
- parameters: []
+ description: "\n Create a snapshot.\n :param fs_id: The filesystem\
+ \ identifier.\n :param path: The path of the directory.\n :param\
+ \ name: The name of the snapshot. If not specified, a name using the\n \
+ \ current time in RFC3339 UTC format will be generated.\n :return:\
+ \ The name of the snapshot.\n :rtype: str\n "
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
properties:
name:
type: string
- value:
+ path:
type: string
required:
- - name
- - value
+ - path
type: object
responses:
'201':
security:
- jwt: []
tags:
- - ClusterConfiguration
- put:
- parameters: []
+ - Cephfs
+ /api/cephfs/{fs_id}/tree:
+ delete:
+ description: "\n Remove a directory.\n :param fs_id: The filesystem\
+ \ identifier.\n :param path: The path of the directory.\n "
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: path
+ 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:
+ - Cephfs
+ post:
+ description: "\n Create a directory.\n :param fs_id: The filesystem\
+ \ identifier.\n :param path: The path of the directory.\n "
+ parameters:
+ - in: path
+ name: fs_id
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- options:
+ path:
type: string
required:
- - options
+ - path
type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource updated.
+ description: Resource created.
'202':
content:
application/vnd.ceph.api.v1.0+json:
security:
- jwt: []
tags:
- - ClusterConfiguration
- /api/cluster_conf/filter:
+ - Cephfs
+ /api/cluster:
get:
- parameters:
- - allowEmptyValue: true
- description: Config option names
- in: query
- name: names
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
- 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:
- - name
- - type
- - level
- - desc
- - long_desc
- - default
- - daemon_default
- - tags
- - services
- - see_also
- - enum_values
- - min
- - max
- - can_update_at_runtime
- - flags
- type: array
+ application/vnd.ceph.api.v0.1+json:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Get Cluster Configuration by name
+ summary: Get the cluster status
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
+ - Cluster
+ put:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ status:
+ description: Cluster Status
+ type: string
+ required:
+ - status
+ type: object
responses:
- '202':
+ '200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/vnd.ceph.api.v0.1+json:
type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ description: Resource updated.
+ '202':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/vnd.ceph.api.v0.1+json:
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: Update the cluster status
tags:
- - ClusterConfiguration
+ - Cluster
+ /api/cluster/upgrade:
get:
parameters:
- - in: path
- name: name
- required: true
+ - default: false
+ description: Show all image tags
+ in: query
+ name: tags
+ schema:
+ type: boolean
+ - allowEmptyValue: true
+ description: Ceph Image
+ in: query
+ name: image
schema:
type: string
+ - default: false
+ description: Show all available versions
+ in: query
+ name: show_all_versions
+ schema:
+ type: boolean
responses:
'200':
content:
trace.
security:
- jwt: []
+ summary: Get the available versions to upgrade
tags:
- - ClusterConfiguration
- /api/crush_rule:
- get:
+ - Upgrade
+ /api/cluster/upgrade/pause:
+ put:
parameters: []
responses:
'200':
content:
- 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:
- - rule_id
- - rule_name
- - ruleset
- - type
- - min_size
- - max_size
- - steps
- type: object
- description: OK
+ 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':
trace.
security:
- jwt: []
- summary: List Crush Rule Configuration
+ summary: Pause the cluster upgrade
tags:
- - CrushRule
+ - Upgrade
+ /api/cluster/upgrade/resume:
+ put:
+ parameters: []
+ 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: Resume the cluster upgrade
+ tags:
+ - Upgrade
+ /api/cluster/upgrade/start:
post:
parameters: []
requestBody:
application/json:
schema:
properties:
- device_class:
+ daemon_types:
type: string
- failure_domain:
+ host_placement:
type: string
- name:
+ image:
type: string
- root:
+ limit:
+ type: string
+ services:
+ type: string
+ version:
type: string
- required:
- - name
- - root
- - failure_domain
type: object
responses:
'201':
trace.
security:
- jwt: []
+ summary: Start the cluster upgrade
tags:
- - CrushRule
- /api/crush_rule/{name}:
- delete:
- parameters:
- - in: path
- name: name
- required: true
- schema:
- type: string
+ - Upgrade
+ /api/cluster/upgrade/status:
+ get:
+ parameters: []
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/vnd.ceph.api.v1.0+json:
type: object
- description: Resource deleted.
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
+ summary: Get the cluster upgrade status
tags:
- - CrushRule
- get:
- parameters:
- - in: path
- name: name
- required: true
- schema:
- type: string
+ - Upgrade
+ /api/cluster/upgrade/stop:
+ put:
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v2.0+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
trace.
security:
- jwt: []
+ summary: Stop the cluster upgrade
tags:
- - CrushRule
- /api/daemon/{daemon_name}:
- put:
- parameters:
- - in: path
- name: daemon_name
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
+ - Upgrade
+ /api/cluster/user:
+ get:
+ description: "\n Get list of ceph users and its respective data\n \
+ \ "
+ 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: []
+ summary: Get Ceph Users
+ tags:
+ - Cluster
+ post:
+ description: "\n Add a ceph user with its defined capabilities.\n \
+ \ :param user_entity: Entity to change\n :param capabilities: List\
+ \ of capabilities to add to user_entity\n "
+ parameters: []
+ requestBody:
+ content:
+ application/json:
schema:
properties:
- action:
+ capabilities:
+ type: string
+ import_data:
default: ''
type: string
- container_image:
+ user_entity:
+ default: ''
type: string
type: object
responses:
- '200':
+ '201':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource updated.
+ description: Resource created.
'202':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
description: Operation is still executing. Please check the task queue.
'400':
trace.
security:
- jwt: []
+ summary: Create Ceph User
tags:
- - Daemon
- /api/erasure_code_profile:
- get:
+ - Cluster
+ put:
+ description: "\n Change the ceph user capabilities.\n Setting\
+ \ new capabilities will overwrite current ones.\n :param user_entity:\
+ \ Entity to change\n :param capabilities: List of updated capabilities\
+ \ to user_entity\n "
parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ capabilities:
+ type: string
+ user_entity:
+ default: ''
+ type: string
+ type: object
responses:
'200':
content:
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:
- - crush-failure-domain
- - k
- - m
- - plugin
- - technique
- - name
- type: array
- description: OK
+ 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':
trace.
security:
- jwt: []
- summary: List Erasure Code Profile Information
+ summary: Edit Ceph User
tags:
- - ErasureCodeProfile
+ - Cluster
+ /api/cluster/user/export:
post:
parameters: []
requestBody:
application/json:
schema:
properties:
- name:
+ entities:
type: string
required:
- - name
+ - entities
type: object
responses:
'201':
trace.
security:
- jwt: []
+ summary: Export Ceph Users
tags:
- - ErasureCodeProfile
- /api/erasure_code_profile/{name}:
+ - Cluster
+ /api/cluster/user/{user_entity}:
delete:
+ description: "\n Delete a ceph user and it's defined capabilities.\n\
+ \ :param user_entity: Entity to delete\n "
parameters:
- in: path
- name: name
+ name: user_entity
required: true
schema:
type: string
trace.
security:
- jwt: []
+ summary: Delete Ceph User
tags:
- - ErasureCodeProfile
+ - Cluster
+ /api/cluster_conf:
get:
- parameters:
- - in: path
- name: name
- required: true
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
security:
- jwt: []
tags:
- - ErasureCodeProfile
- /api/feature_toggles:
- get:
+ - ClusterConfiguration
+ post:
parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ name:
+ type: string
+ value:
+ type: string
+ required:
+ - name
+ - value
+ type: object
responses:
- '200':
+ '201':
content:
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:
- - rbd
- - mirroring
- - iscsi
- - cephfs
- - rgw
- - 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:
- get:
- description: "\n List all issues details.\n "
- parameters: []
- responses:
- '200':
+ type: object
+ description: Resource created.
+ '202':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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:
- - Report
- post:
- description: "\n Create an issue.\n :param project: The affected\
- \ ceph component.\n :param tracker: The tracker type.\n :param\
- \ subject: The title of the issue.\n :param description: The description\
- \ of the issue.\n :param api_key: Ceph tracker api key.\n "
+ - ClusterConfiguration
+ put:
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- api_key:
- type: string
- description:
- type: string
- project:
- type: string
- subject:
- type: string
- tracker:
+ options:
type: string
required:
- - project
- - tracker
- - subject
- - description
+ - options
type: object
responses:
- '201':
+ '200':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
+ description: Resource updated.
'202':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
description: Operation is still executing. Please check the task queue.
'400':
security:
- jwt: []
tags:
- - Report
- /api/feedback/api_key:
- delete:
- description: "\n Deletes Ceph tracker API key.\n "
- parameters: []
- responses:
- '202':
- content:
- application/vnd.ceph.api.v0.1+json:
+ - ClusterConfiguration
+ /api/cluster_conf/filter:
+ get:
+ parameters:
+ - allowEmptyValue: true
+ description: Config option names
+ in: query
+ name: names
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/vnd.ceph.api.v1.0+json:
+ 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:
+ - name
+ - type
+ - level
+ - desc
+ - long_desc
+ - default
+ - daemon_default
+ - tags
+ - services
+ - see_also
+ - enum_values
+ - min
+ - max
+ - 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.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
description: Resource deleted.
'400':
security:
- jwt: []
tags:
- - Report
+ - ClusterConfiguration
get:
- description: "\n Returns Ceph tracker API key.\n "
- parameters: []
+ parameters:
+ - in: path
+ name: name
+ required: true
+ schema:
+ type: string
responses:
'200':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
description: OK
'400':
security:
- jwt: []
tags:
- - Report
+ - ClusterConfiguration
+ /api/crush_rule:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ 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:
+ - rule_id
+ - rule_name
+ - ruleset
+ - type
+ - min_size
+ - max_size
+ - steps
+ 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 Crush Rule Configuration
+ tags:
+ - CrushRule
post:
- description: "\n Sets Ceph tracker API key.\n :param api_key:\
- \ The Ceph tracker API key.\n "
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- api_key:
+ device_class:
+ type: string
+ failure_domain:
+ type: string
+ name:
+ type: string
+ root:
type: string
required:
- - api_key
+ - name
+ - root
+ - failure_domain
type: object
responses:
'201':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
description: Resource created.
'202':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
description: Operation is still executing. Please check the task queue.
'400':
security:
- jwt: []
tags:
- - Report
- /api/grafana/dashboards:
- post:
- parameters: []
+ - CrushRule
+ /api/crush_rule/{name}:
+ delete:
+ parameters:
+ - in: path
+ name: name
+ required: true
+ schema:
+ type: string
responses:
- '201':
+ '202':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
- '202':
+ description: Operation is still executing. Please check the task queue.
+ '204':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Operation is still executing. Please check the task queue.
+ description: Resource deleted.
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - Grafana
- /api/grafana/url:
+ - CrushRule
get:
- parameters: []
+ parameters:
+ - in: path
+ name: name
+ required: true
+ schema:
+ type: string
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
- schema:
- properties:
- instance:
- description: grafana instance
- type: string
- required:
- - instance
- type: object
+ application/vnd.ceph.api.v2.0+json:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: List Grafana URL Instance
tags:
- - Grafana
- /api/grafana/validation/{params}:
+ - CrushRule
+ /api/daemon:
get:
+ description: "List all daemons in the cluster. Also filter by the daemon types\
+ \ specified\n\n :param daemon_types: List of daemon types to filter\
+ \ by.\n :return: Returns list of daemons.\n :rtype: list\n \
+ \ "
parameters:
- - in: path
- name: params
- required: true
+ - allowEmptyValue: true
+ in: query
+ name: daemon_types
schema:
type: string
responses:
security:
- jwt: []
tags:
- - Grafana
- /api/health/full:
+ - Daemon
+ /api/daemon/{daemon_name}:
+ put:
+ parameters:
+ - in: path
+ name: daemon_name
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ action:
+ default: ''
+ type: string
+ container_image:
+ type: string
+ type: object
+ responses:
+ '200':
+ content:
+ application/vnd.ceph.api.v0.1+json:
+ 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:
+ - Daemon
+ /api/erasure_code_profile:
get:
parameters: []
responses:
'200':
content:
application/vnd.ceph.api.v1.0+json:
- type: object
+ 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:
+ - crush-failure-domain
+ - k
+ - m
+ - plugin
+ - technique
+ - name
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: List Erasure Code Profile Information
tags:
- - Health
- /api/health/get_cluster_capacity:
- get:
+ - ErasureCodeProfile
+ post:
parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ name:
+ type: string
+ required:
+ - name
+ type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - Health
- /api/health/get_cluster_fsid:
+ - ErasureCodeProfile
+ /api/erasure_code_profile/{name}:
+ delete:
+ parameters:
+ - in: path
+ name: name
+ 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:
+ - ErasureCodeProfile
get:
- parameters: []
+ parameters:
+ - in: path
+ name: name
+ required: true
+ schema:
+ type: string
responses:
'200':
content:
security:
- jwt: []
tags:
- - Health
- /api/health/minimal:
+ - ErasureCodeProfile
+ /api/feature_toggles:
get:
parameters: []
responses:
application/vnd.ceph.api.v1.0+json:
schema:
properties:
- client_perf:
+ cephfs:
description: ''
- properties:
- read_bytes_sec:
- description: ''
- type: integer
- read_op_per_sec:
- description: ''
- type: integer
- recovering_bytes_per_sec:
- description: ''
- type: integer
- write_bytes_sec:
- description: ''
- type: integer
- write_op_per_sec:
- description: ''
- type: integer
- required:
- - read_bytes_sec
- - read_op_per_sec
- - recovering_bytes_per_sec
- - write_bytes_sec
- - write_op_per_sec
- type: object
- df:
+ type: boolean
+ dashboard:
description: ''
- properties:
- stats:
- description: ''
- properties:
- total_avail_bytes:
- description: ''
- type: integer
- total_bytes:
- description: ''
- type: integer
- total_used_raw_bytes:
- description: ''
- type: integer
- required:
- - total_avail_bytes
- - total_bytes
- - total_used_raw_bytes
- type: object
- required:
- - stats
- type: object
- fs_map:
+ type: boolean
+ iscsi:
description: ''
- properties:
- filesystems:
- description: ''
- items:
- properties:
- mdsmap:
- description: ''
- properties:
- balancer:
- description: ''
- type: string
- compat:
- description: ''
- properties:
- compat:
- description: ''
- type: string
- incompat:
- description: ''
- type: string
- ro_compat:
- description: ''
- type: string
- required:
- - compat
- - ro_compat
- - incompat
- 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:
- - session_autoclose
- - balancer
- - up
- - last_failure_osd_epoch
- - in
- - last_failure
- - max_file_size
- - explicitly_allowed_features
- - damaged
- - tableserver
- - failed
- - metadata_pool
- - epoch
- - stopped
- - max_mds
- - compat
- - required_client_features
- - data_pools
- - info
- - fs_name
- - created
- - standby_count_wanted
- - enabled
- - modified
- - session_timeout
- - flags
- - ever_allowed_features
- - root
- type: object
- standbys:
- description: ''
- type: string
- required:
- - mdsmap
- - standbys
- type: object
- type: array
- required:
- - filesystems
- type: object
- health:
- description: ''
- properties:
- checks:
- description: ''
- type: string
- mutes:
- description: ''
- type: string
- status:
- description: ''
- type: string
- required:
- - checks
- - mutes
- - status
- type: object
- hosts:
- description: ''
- type: integer
- iscsi_daemons:
- description: ''
- properties:
- down:
- description: ''
- type: integer
- up:
- description: ''
- type: integer
- required:
- - up
- - down
- type: object
- mgr_map:
- description: ''
- properties:
- active_name:
- description: ''
- type: string
- standbys:
- description: ''
- type: string
- required:
- - active_name
- - standbys
- type: object
- mon_status:
- description: ''
- properties:
- monmap:
- description: ''
- properties:
- mons:
- description: ''
- type: string
- required:
- - mons
- type: object
- quorum:
- description: ''
- items:
- type: integer
- type: array
- required:
- - monmap
- - quorum
- type: object
- osd_map:
+ type: boolean
+ mirroring:
description: ''
- properties:
- osds:
- description: ''
- items:
- properties:
- in:
- description: ''
- type: integer
- up:
- description: ''
- type: integer
- required:
- - in
- - up
- type: object
- type: array
- required:
- - osds
- type: object
- pg_info:
+ type: boolean
+ nfs:
description: ''
- properties:
- object_stats:
- description: ''
- 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:
- - num_objects
- - num_object_copies
- - num_objects_degraded
- - num_objects_misplaced
- - num_objects_unfound
- type: object
- pgs_per_osd:
- description: ''
- type: integer
- statuses:
- description: ''
- type: string
- required:
- - object_stats
- - pgs_per_osd
- - statuses
- type: object
- pools:
+ type: boolean
+ rbd:
description: ''
- type: string
+ type: boolean
rgw:
description: ''
- type: integer
- scrub_status:
- description: ''
- type: string
+ type: boolean
required:
- - client_perf
- - df
- - fs_map
- - health
- - hosts
- - iscsi_daemons
- - mgr_map
- - mon_status
- - osd_map
- - pg_info
- - pools
+ - rbd
+ - mirroring
+ - iscsi
+ - cephfs
- rgw
- - scrub_status
+ - nfs
+ - dashboard
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get Cluster's minimal health report
+ summary: Get List Of Features
tags:
- - Health
- /api/host:
+ - FeatureTogglesEndpoint
+ /api/feedback:
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
+ description: "\n List all issues details.\n "
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.2+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:
- 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:
- description: ''
- type: boolean
- orchestrator:
- description: ''
- type: boolean
- required:
- - ceph
- - orchestrator
- type: object
- status:
- description: ''
- type: string
- required:
- - hostname
- - services
- - service_instances
- - ceph_version
- - addr
- - labels
- - service_type
- - sources
- - status
- type: object
+ application/vnd.ceph.api.v0.1+json:
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: List Host Specifications
tags:
- - Host
+ - Report
post:
+ description: "\n Create an issue.\n :param project: The affected\
+ \ ceph component.\n :param tracker: The tracker type.\n :param\
+ \ subject: The title of the issue.\n :param description: The description\
+ \ of the issue.\n :param api_key: Ceph tracker api key.\n "
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- addr:
- description: Network Address
+ api_key:
type: string
- hostname:
- description: Hostname
+ description:
type: string
- labels:
- description: Host Labels
- items:
- type: string
- type: array
- status:
- description: Host Status
+ project:
+ type: string
+ subject:
+ type: string
+ tracker:
type: string
required:
- - hostname
+ - project
+ - tracker
+ - subject
+ - description
type: object
responses:
'201':
security:
- jwt: []
tags:
- - Host
- /api/host/{hostname}:
+ - Report
+ /api/feedback/api_key:
delete:
- parameters:
- - in: path
- name: hostname
- required: true
- schema:
- type: string
+ description: "\n Deletes Ceph tracker API key.\n "
+ parameters: []
responses:
'202':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/vnd.ceph.api.v0.1+json:
type: object
description: Operation is still executing. Please check the task queue.
'204':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/vnd.ceph.api.v0.1+json:
type: object
description: Resource deleted.
'400':
security:
- jwt: []
tags:
- - Host
+ - Report
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
+ description: "\n Returns Ceph tracker API key.\n "
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/vnd.ceph.api.v0.1+json:
type: object
description: OK
'400':
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
+ - Report
+ post:
+ description: "\n Sets Ceph tracker API key.\n :param api_key:\
+ \ The Ceph tracker API key.\n "
+ parameters: []
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
+ api_key:
+ type: string
+ required:
+ - api_key
type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v0.1+json:
- schema:
- properties: {}
- type: object
- description: Resource updated.
+ type: object
+ description: Resource created.
'202':
content:
application/vnd.ceph.api.v0.1+json:
security:
- jwt: []
tags:
- - Host
- /api/host/{hostname}/daemons:
- get:
- parameters:
- - in: path
- name: hostname
- required: true
- schema:
- type: string
+ - Report
+ /api/grafana/dashboards:
+ post:
+ parameters: []
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - Host
- /api/host/{hostname}/devices:
+ - Grafana
+ /api/grafana/url:
get:
- parameters:
- - in: path
- name: hostname
- required: true
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
application/vnd.ceph.api.v1.0+json:
- type: object
+ schema:
+ properties:
+ instance:
+ description: grafana instance
+ type: string
+ required:
+ - instance
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: List Grafana URL Instance
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 "
+ - Grafana
+ /api/grafana/validation/{params}:
+ get:
parameters:
- in: path
- name: hostname
+ name: params
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- device:
- type: string
- duration:
- type: string
- required:
- - device
- - duration
+ 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:
+ - Grafana
+ /api/health/full:
+ get:
+ parameters: []
responses:
- '201':
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
- '202':
+ 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:
+ - Health
+ /api/health/get_cluster_capacity:
+ get:
+ parameters: []
+ responses:
+ '200':
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':
security:
- jwt: []
tags:
- - Host
- /api/host/{hostname}/inventory:
+ - Health
+ /api/health/get_cluster_fsid:
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
+ 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:
+ - Health
+ /api/health/minimal:
+ get:
+ parameters: []
responses:
'200':
content:
application/vnd.ceph.api.v1.0+json:
schema:
properties:
- addr:
- description: Host address
- 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: ''
+ client_perf:
+ description: ''
+ properties:
+ read_bytes_sec:
+ description: ''
+ type: integer
+ read_op_per_sec:
+ description: ''
+ type: integer
+ recovering_bytes_per_sec:
+ description: ''
+ type: integer
+ write_bytes_sec:
+ description: ''
+ type: integer
+ write_op_per_sec:
+ description: ''
+ type: integer
+ required:
+ - read_bytes_sec
+ - read_op_per_sec
+ - recovering_bytes_per_sec
+ - write_bytes_sec
+ - write_op_per_sec
+ type: object
+ df:
+ description: ''
+ properties:
+ stats:
+ description: ''
+ properties:
+ total_avail_bytes:
+ description: ''
+ type: integer
+ total_bytes:
+ description: ''
+ type: integer
+ total_used_raw_bytes:
+ description: ''
+ type: integer
+ required:
+ - total_avail_bytes
+ - total_bytes
+ - total_used_raw_bytes
+ type: object
+ required:
+ - stats
+ type: object
+ fs_map:
+ description: ''
+ properties:
+ filesystems:
+ description: ''
+ items:
properties:
- errors:
- description: ''
- items:
- type: string
- type: array
- health:
- description: ''
- type: string
- ledSupport:
+ mdsmap:
description: ''
properties:
- FAILstatus:
+ balancer:
description: ''
type: string
- FAILsupport:
+ compat:
description: ''
- type: string
- IDENTstatus:
+ properties:
+ compat:
+ description: ''
+ type: string
+ incompat:
+ description: ''
+ type: string
+ ro_compat:
+ description: ''
+ type: string
+ required:
+ - compat
+ - ro_compat
+ - incompat
+ type: object
+ created:
description: ''
type: string
- IDENTsupport:
+ damaged:
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: ''
- type: string
- required:
- - serialNum
- - transport
- - mediaType
- - rpm
- - linkSpeed
- - health
- - ledSupport
- - errors
- type: object
- 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:
- - 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
- 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:
+ items:
+ type: integer
+ type: array
+ data_pools:
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
+ 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:
- - partition_name
+ - session_autoclose
+ - balancer
+ - up
+ - last_failure_osd_epoch
+ - in
+ - last_failure
+ - max_file_size
+ - explicitly_allowed_features
+ - damaged
+ - tableserver
+ - failed
+ - metadata_pool
+ - epoch
+ - stopped
+ - max_mds
+ - compat
+ - required_client_features
+ - data_pools
+ - info
+ - fs_name
+ - created
+ - standby_count_wanted
+ - enabled
+ - modified
+ - session_timeout
+ - flags
+ - ever_allowed_features
+ - root
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: integer
- support_discard:
- description: ''
- type: string
- vendor:
+ standbys:
description: ''
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
+ - mdsmap
+ - standbys
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: array
+ required:
+ - filesystems
+ type: object
+ health:
+ description: ''
+ properties:
+ checks:
+ description: ''
+ type: string
+ mutes:
+ description: ''
+ type: string
+ status:
+ description: ''
+ type: string
+ required:
+ - checks
+ - mutes
+ - status
+ type: object
+ hosts:
+ description: ''
+ type: integer
+ iscsi_daemons:
+ description: ''
+ properties:
+ down:
+ description: ''
+ type: integer
+ up:
+ description: ''
+ type: integer
+ required:
+ - up
+ - down
+ type: object
+ mgr_map:
+ description: ''
+ properties:
+ active_name:
+ description: ''
+ type: string
+ standbys:
+ description: ''
+ type: string
+ required:
+ - active_name
+ - standbys
+ type: object
+ mon_status:
+ description: ''
+ properties:
+ monmap:
+ description: ''
+ properties:
+ mons:
+ description: ''
+ type: string
+ required:
+ - mons
+ type: object
+ quorum:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required:
+ - monmap
+ - quorum
+ type: object
+ osd_map:
+ description: ''
+ properties:
+ osds:
+ description: ''
+ items:
+ properties:
+ in:
+ description: ''
+ type: integer
+ up:
+ description: ''
+ type: integer
+ required:
+ - in
+ - up
+ type: object
+ type: array
+ required:
+ - osds
+ type: object
+ pg_info:
+ description: ''
+ properties:
+ object_stats:
+ description: ''
+ 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:
+ - num_objects
+ - num_object_copies
+ - num_objects_degraded
+ - num_objects_misplaced
+ - num_objects_unfound
+ type: object
+ pgs_per_osd:
+ description: ''
+ type: integer
+ statuses:
+ description: ''
+ type: string
+ required:
+ - object_stats
+ - pgs_per_osd
+ - statuses
+ type: object
+ pools:
+ description: ''
+ type: string
+ rgw:
+ description: ''
+ type: integer
+ scrub_status:
+ description: ''
type: string
required:
- - name
- - addr
- - devices
- - labels
+ - client_perf
+ - df
+ - fs_map
+ - health
+ - hosts
+ - iscsi_daemons
+ - mgr_map
+ - mon_status
+ - osd_map
+ - pg_info
+ - pools
+ - rgw
+ - scrub_status
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get inventory of a host
+ summary: Get Cluster's minimal health report
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
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/vnd.ceph.api.v1.3+json:
schema:
- items:
- properties:
- mutual_password:
- description: ''
- type: string
- mutual_user:
- description: ''
- type: string
- password:
- description: password
- type: string
- user:
- description: username
+ 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
+ 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:
+ 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:
+ description: ''
+ type: boolean
+ orchestrator:
+ description: ''
+ type: boolean
+ required:
+ - ceph
+ - orchestrator
+ type: object
+ status:
+ description: ''
+ type: string
required:
- - user
- - password
- - mutual_user
- - mutual_password
- 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 Iscsi discoveryauth Details
- 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
- requestBody:
- content:
- application/json:
- schema:
- properties:
- mutual_password:
- description: Mutual Password
- type: string
- mutual_user:
- description: Mutual UserName
- type: string
- password:
- description: Password
- type: string
- user:
- description: Username
- type: string
- required:
- - user
- - password
- - mutual_user
- - mutual_password
- 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 Iscsi discoveryauth
- tags:
- - Iscsi
- /api/iscsi/target:
- get:
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
+ - hostname
+ - services
+ - service_instances
+ - ceph_version
+ - addr
+ - labels
+ - service_type
+ - sources
+ - status
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: List Host Specifications
tags:
- - IscsiTarget
+ - Host
post:
parameters: []
requestBody:
application/json:
schema:
properties:
- acl_enabled:
- type: string
- auth:
- type: string
- clients:
- type: string
- disks:
- type: string
- groups:
- type: string
- portals:
+ addr:
+ description: Network Address
type: string
- target_controls:
+ hostname:
+ description: Hostname
type: string
- target_iqn:
+ 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.v1.0+json:
+ application/vnd.ceph.api.v0.1+json:
type: object
description: Resource created.
'202':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/vnd.ceph.api.v0.1+json:
type: object
description: Operation is still executing. Please check the task queue.
'400':
security:
- jwt: []
tags:
- - IscsiTarget
- /api/iscsi/target/{target_iqn}:
+ - Host
+ /api/host/{hostname}:
delete:
parameters:
- in: path
- name: target_iqn
+ name: hostname
required: true
schema:
type: string
security:
- jwt: []
tags:
- - IscsiTarget
+ - Host
get:
+ description: "\n Get the specified host.\n :raises: cherrypy.HTTPError:\
+ \ If host not found.\n "
parameters:
- in: path
- name: target_iqn
+ name: hostname
required: true
schema:
type: string
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/vnd.ceph.api.v1.2+json:
type: object
description: OK
'400':
security:
- jwt: []
tags:
- - IscsiTarget
+ - 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:
- - in: path
- name: target_iqn
+ - description: Hostname
+ in: path
+ 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:
- type: string
- target_controls:
- 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:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
- 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:
+ application/vnd.ceph.api.v0.1+json:
type: object
description: Operation is still executing. Please check the task queue.
'400':
security:
- jwt: []
tags:
- - IscsiTarget
- /api/logs/all:
- get:
- parameters: []
- responses:
- '200':
- content:
- 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:
- - type
- - addr
- - nonce
- type: object
- type: array
- required:
- - 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:
- - 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:
+ - Host
+ /api/host/{hostname}/daemons:
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: []
+ parameters:
+ - in: path
+ name: hostname
+ required: true
+ schema:
+ type: string
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
- 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:
- - name
- - type
- - level
- - flags
- - default_value
- - min
- - max
- - enum_allowed
- - desc
- - long_desc
- - tags
- - see_also
- type: object
- required:
- - Option_name
- type: object
- type: object
- required:
- - name
- - enabled
- - always_on
- - options
- type: array
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: List Mgr modules
tags:
- - MgrModule
- /api/mgr/module/{module_name}:
+ - Host
+ /api/host/{hostname}/devices:
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
+ name: hostname
required: true
schema:
type: string
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 "
+ - 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: module_name
+ name: hostname
required: true
schema:
type: string
application/json:
schema:
properties:
- config:
+ device:
+ type: string
+ duration:
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:
+ - device
+ - duration
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:
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 "
+ - Host
+ /api/host/{hostname}/inventory:
+ get:
parameters:
- - in: path
- name: module_name
+ - description: Hostname
+ 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':
- 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
+ - allowEmptyValue: true
+ description: Trigger asynchronous refresh
+ in: query
+ name: refresh
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:
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:
+ FAILstatus:
description: ''
type: string
- num:
- description: ''
- type: integer
- release:
+ FAILsupport:
description: ''
type: string
- required:
- - features
- - release
- - num
- type: object
- type: array
- mds:
- description: ''
- items:
- properties:
- features:
+ IDENTstatus:
description: ''
type: string
- num:
- description: ''
- type: integer
- release:
+ IDENTsupport:
description: ''
type: string
required:
- - features
- - release
- - num
+ - IDENTsupport
+ - IDENTstatus
+ - FAILsupport
+ - FAILstatus
type: object
- type: array
- mgr:
- description: ''
- items:
- properties:
- features:
- description: ''
- type: string
- num:
- description: ''
- type: integer
- release:
- description: ''
- type: string
- required:
- - features
- - release
- - num
- type: object
- type: array
- mon:
- description: ''
- items:
- properties:
- features:
- description: ''
- type: string
- num:
- description: ''
- type: integer
- release:
- description: ''
- type: string
- required:
- - features
- - release
- - num
- 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:
+ - serialNum
+ - transport
+ - mediaType
+ - rpm
+ - linkSpeed
+ - health
+ - ledSupport
+ - errors
+ 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
+ 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:
- - persistent
- - optional
+ - name
+ - osd_id
+ - cluster_name
+ - type
+ - osd_fsid
+ - cluster_fsid
+ - osdspec_affinity
+ - block_uuid
type: object
- fsid:
- description: ''
- type: string
- min_mon_release:
- description: ''
+ 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
+ type: string
+ sectors:
+ description: ''
+ type: string
+ sectorsize:
+ description: ''
+ type: integer
+ size:
+ description: ''
+ type: integer
+ start:
+ description: ''
+ type: string
required:
- - num_sessions
+ - start
+ - sectors
+ - sectorsize
+ - size
+ - human_readable_size
+ - holders
type: object
- weight:
- description: ''
- type: integer
required:
- - rank
- - name
- - public_addrs
- - addr
- - public_addr
- - priority
- - weight
- - stats
+ - partition_name
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:
+ - 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:
+ - 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: integer
+ type: string
type: array
+ name:
+ description: Hostname
+ type: string
required:
- - mon_status
- - in_quorum
- - out_quorum
+ - name
+ - addr
+ - devices
+ - labels
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Get Monitor Details
+ summary: Get inventory of a host
tags:
- - Monitor
- /api/nfs-ganesha/cluster:
+ - Host
+ /api/host/{hostname}/smart:
get:
- parameters: []
+ parameters:
+ - in: path
+ name: hostname
+ required: true
+ schema:
+ type: string
responses:
'200':
content:
- application/vnd.ceph.api.v0.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
description: OK
'400':
security:
- jwt: []
tags:
- - NFS-Ganesha
- /api/nfs-ganesha/export:
+ - Host
+ /api/iscsi/discoveryauth:
get:
parameters: []
responses:
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:
- - 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
+ mutual_password:
+ description: ''
type: string
- protocols:
- description: List of protocol types
- items:
- type: integer
- type: array
- pseudo:
- description: Pseudo FS path
+ mutual_user:
+ description: ''
type: string
- security_label:
- description: Security label
+ password:
+ description: password
type: string
- squash:
- description: Export squash policy
+ user:
+ description: username
type: string
- transports:
- description: List of transport types
- items:
- type: string
- type: array
type: object
required:
- - export_id
- - path
- - cluster_id
- - pseudo
- - access_type
- - squash
- - security_label
- - protocols
- - transports
- - fsal
- - clients
+ - user
+ - password
+ - mutual_user
+ - mutual_password
type: array
description: OK
'400':
trace.
security:
- jwt: []
- summary: List all NFS-Ganesha exports
+ summary: Get Iscsi discoveryauth Details
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
+ - 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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ mutual_password:
+ description: Mutual Password
type: string
- protocols:
- description: List of protocol types
- items:
- type: integer
- type: array
- pseudo:
- description: Pseudo FS path
+ mutual_user:
+ description: Mutual UserName
type: string
- security_label:
- description: Security label
+ password:
+ description: Password
type: string
- squash:
- description: Export squash policy
+ user:
+ description: Username
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
+ - user
+ - password
+ - mutual_user
+ - mutual_password
type: object
responses:
- '201':
+ '200':
content:
- 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:
- - 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:
+ type: object
+ description: Resource updated.
'202':
content:
- application/vnd.ceph.api.v2.0+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
description: Operation is still executing. Please check the task queue.
'400':
trace.
security:
- jwt: []
- summary: Creates a new NFS-Ganesha export
+ summary: Set Iscsi discoveryauth
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
+ - Iscsi
+ /api/iscsi/target:
+ get:
+ parameters: []
responses:
- '202':
- content:
- application/vnd.ceph.api.v2.0+json:
- type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ '200':
content:
- application/vnd.ceph.api.v2.0+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource deleted.
+ description: OK
'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:
- 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':
+ - IscsiTarget
+ post:
+ parameters: []
+ 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
+ type: object
+ responses:
+ '201':
content:
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
+ 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':
trace.
security:
- jwt: []
- summary: Get an NFS-Ganesha export
tags:
- - NFS-Ganesha
- put:
+ - IscsiTarget
+ /api/iscsi/target/{target_iqn}:
+ delete:
parameters:
- - description: Cluster identifier
- in: path
- name: cluster_id
+ - in: path
+ name: target_iqn
required: true
schema:
type: string
- - description: Export ID
- in: path
- name: export_id
+ 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:
+ - IscsiTarget
+ get:
+ parameters:
+ - in: path
+ name: target_iqn
required: true
schema:
- type: integer
+ 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:
+ - IscsiTarget
+ put:
+ parameters:
+ - in: path
+ name: target_iqn
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- access_type:
- description: Export access type
+ acl_enabled:
+ type: string
+ auth:
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
+ disks:
type: string
- security_label:
- description: Security label
+ groups:
type: string
- squash:
- description: Export squash policy
+ new_target_iqn:
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/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:
- - 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 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/osd:
- 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:
- - OSD
- post:
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- data:
- type: string
- method:
+ portals:
type: string
- tracking_id:
+ target_controls:
type: string
- required:
- - method
- - data
- - tracking_id
type: object
responses:
- '201':
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
+ description: Resource updated.
'202':
content:
application/vnd.ceph.api.v1.0+json:
security:
- jwt: []
tags:
- - OSD
- /api/osd/flags:
+ - IscsiTarget
+ /api/logs/all:
get:
parameters: []
responses:
application/vnd.ceph.api.v1.0+json:
schema:
properties:
- list_of_flags:
+ 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:
+ - type
+ - addr
+ - nonce
+ type: object
+ type: array
+ required:
+ - 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:
+ - name
+ - rank
+ - addrs
+ - stamp
+ - seq
+ - channel
+ - priority
+ - message
+ type: object
+ type: array
+ clog:
description: ''
items:
type: string
type: array
required:
- - list_of_flags
+ - clog
+ - audit_log
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Display OSD Flags
+ summary: Display Logs Configuration
tags:
- - OSD
- put:
- description: "\n The `recovery_deletes`, `sortbitwise` and `pglog_hardlimit`\
- \ flags cannot be unset.\n `purged_snapshots` cannot even be set. It\
- \ is therefore required to at\n least include those four flags for\
- \ a successful operation.\n "
+ - 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: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- flags:
- description: List of flags to set. The flags `recovery_deletes`,
- `sortbitwise` and `pglog_hardlimit` cannot be unset. Additionally
- `purged_snapshots` cannot even be set.
- items:
- type: string
- type: array
- required:
- - flags
- type: object
responses:
'200':
content:
application/vnd.ceph.api.v1.0+json:
schema:
- properties:
- list_of_flags:
- description: ''
- items:
+ 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
- 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:
+ - name
+ - type
+ - level
+ - flags
+ - default_value
+ - min
+ - max
+ - enum_allowed
+ - desc
+ - long_desc
+ - tags
+ - see_also
+ type: object
+ required:
+ - Option_name
+ type: object
+ type: object
required:
- - list_of_flags
- 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.
+ - name
+ - enabled
+ - always_on
+ - options
+ type: array
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
trace.
security:
- jwt: []
- summary: Sets OSD flags for the entire cluster.
+ summary: List Mgr modules
tags:
- - OSD
- /api/osd/flags/individual:
+ - MgrModule
+ /api/mgr/module/{module_name}:
get:
- parameters: []
+ 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:
- schema:
- properties:
- flags:
- description: List of active flags
- items:
- type: string
- type: array
- osd:
- description: OSD ID
- type: integer
- required:
- - osd
- - flags
- type: object
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Displays individual OSD flags
tags:
- - OSD
+ - MgrModule
put:
- description: "\n Updates flags (`noout`, `noin`, `nodown`, `noup`) for\
- \ an individual\n subset of OSDs.\n "
- parameters: []
+ 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:
- flags:
- description: Directory of flags to set or unset. The flags `noin`,
- `noout`, `noup` and `nodown` are going to be considered only.
- properties:
- nodown:
- description: Sets/unsets `nodown`
- type: boolean
- noin:
- description: Sets/unsets `noin`
- type: boolean
- noout:
- description: Sets/unsets `noout`
- type: boolean
- noup:
- description: Sets/unsets `noup`
- type: boolean
- type: object
- ids:
- description: List of OSD ids the flags should be applied to.
- items:
- type: integer
- type: array
+ config:
+ type: string
required:
- - flags
- - ids
+ - config
type: object
responses:
'200':
content:
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:
- - added
- - removed
- - ids
- type: object
+ type: object
description: Resource updated.
'202':
content:
trace.
security:
- jwt: []
- summary: Sets OSD flags for a subset of individual OSDs.
tags:
- - OSD
- /api/osd/safe_to_delete:
- get:
- description: "\n :type ids: int|[int]\n "
+ - 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: query
- name: svc_ids
+ - in: path
+ name: module_name
required: true
schema:
type: string
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - OSD
- /api/osd/safe_to_destroy:
- get:
- description: "\n :type ids: int|[int]\n "
+ - 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: OSD Service Identifier
- in: query
- name: ids
+ - in: path
+ name: module_name
required: true
schema:
type: string
responses:
- '200':
- content:
- 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:
- - safe_to_destroy
- - active
- - missing_stats
- - stored_pgs
- - is_safe_to_destroy
- 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: Check If OSD is Safe to Destroy
- tags:
- - OSD
- /api/osd/settings:
- get:
- parameters: []
- responses:
- '200':
- content:
- application/vnd.ceph.api.v0.1+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:
- - OSD
- /api/osd/{svc_id}:
- delete:
- parameters:
- - in: path
- name: svc_id
- required: true
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: preserve_id
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: force
- 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:
- - OSD
- get:
- description: "\n Returns collected data about an OSD.\n\n :return:\
- \ Returns the requested data.\n "
- 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:
- - OSD
- put:
- parameters:
- - in: path
- name: svc_id
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- device_class:
- type: string
- required:
- - device_class
- 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:
- - OSD
- /api/osd/{svc_id}/destroy:
- post:
- description: "\n Mark osd as being destroyed. Keeps the ID intact (allowing\
- \ reuse), but\n removes cephx keys, config-key data and lockbox keys,\
- \ rendering data\n permanently unreadable.\n\n The osd must\
- \ be marked down before being destroyed.\n "
- parameters:
- - in: path
- name: svc_id
- required: true
- schema:
- type: string
- responses:
- '201':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
security:
- jwt: []
tags:
- - OSD
- /api/osd/{svc_id}/devices:
+ - 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: svc_id
+ name: module_name
required: true
schema:
type: string
security:
- jwt: []
tags:
- - OSD
- /api/osd/{svc_id}/histogram:
+ - MgrModule
+ /api/monitor:
get:
- description: "\n :return: Returns the histogram data.\n "
- 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:
- - OSD
- /api/osd/{svc_id}/mark:
- put:
- description: "\n Note: osd must be marked `down` before marking lost.\n\
- \ "
- parameters:
- - description: SVC ID
- in: path
- name: svc_id
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- action:
- type: string
- required:
- - action
- 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: Mark OSD flags (out, in, down, lost, ...)
- tags:
- - OSD
- /api/osd/{svc_id}/purge:
- post:
- description: "\n Note: osd must be marked `down` before removal.\n \
- \ "
- parameters:
- - in: path
- name: svc_id
- 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:
- - OSD
- /api/osd/{svc_id}/reweight:
- post:
- description: "\n Reweights the OSD temporarily.\n\n Note that\
- \ \u2018ceph osd reweight\u2019 is not a persistent setting. When an OSD\n\
- \ gets marked out, the osd weight will be set to 0. When it gets marked\n\
- \ in again, the weight will be changed to 1.\n\n Because of\
- \ this \u2018ceph osd reweight\u2019 is a temporary solution. You should\n\
- \ only use it to keep your cluster running while you\u2019re ordering\
- \ more\n hardware.\n\n - Craig Lewis (http://lists.ceph.com/pipermail/ceph-users-ceph.com/2014-June/040967.html)\n\
- \ "
- parameters:
- - in: path
- name: svc_id
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- weight:
- type: string
- required:
- - weight
- 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:
- - OSD
- /api/osd/{svc_id}/scrub:
- post:
- parameters:
- - in: path
- name: svc_id
- required: true
- schema:
- type: string
- - default: false
- in: query
- name: deep
- schema:
- type: boolean
- requestBody:
- content:
- application/json:
- schema:
- properties:
- deep:
- default: false
- type: boolean
- 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:
- - OSD
- /api/osd/{svc_id}/smart:
- 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:
- - OSD
- /api/perf_counters:
- get:
- parameters: []
+ parameters: []
responses:
'200':
content:
application/vnd.ceph.api.v1.0+json:
schema:
properties:
- mon.a:
- description: Service ID
+ 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:
+ - type
+ - addr
+ - nonce
+ type: object
+ type: array
+ required:
+ - addrvec
+ type: object
+ rank:
+ description: ''
+ type: integer
+ stats:
+ description: ''
+ properties:
+ num_sessions:
+ 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:
- .cache_bytes:
+ election_epoch:
+ description: ''
+ type: integer
+ extra_probe_peers:
+ description: ''
+ items:
+ type: string
+ type: array
+ feature_map:
description: ''
properties:
- description:
- description: ''
- type: string
- nick:
+ client:
description: ''
- type: string
- priority:
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required:
+ - features
+ - release
+ - num
+ type: object
+ type: array
+ mds:
description: ''
- type: integer
- type:
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required:
+ - features
+ - release
+ - num
+ type: object
+ type: array
+ mgr:
description: ''
- type: integer
- units:
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required:
+ - features
+ - release
+ - num
+ type: object
+ type: array
+ mon:
+ description: ''
+ items:
+ properties:
+ features:
+ description: ''
+ type: string
+ num:
+ description: ''
+ type: integer
+ release:
+ description: ''
+ type: string
+ required:
+ - features
+ - release
+ - num
+ type: object
+ type: array
+ required:
+ - 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:
+ - required_con
+ - required_mon
+ - quorum_con
+ - quorum_mon
+ type: object
+ monmap:
+ description: ''
+ properties:
+ created:
+ description: ''
+ type: string
+ epoch:
description: ''
type: integer
- value:
+ features:
+ description: ''
+ properties:
+ optional:
+ description: ''
+ items:
+ type: string
+ type: array
+ persistent:
+ description: ''
+ items:
+ type: string
+ type: array
+ required:
+ - 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:
+ - type
+ - addr
+ - nonce
+ type: object
+ type: array
+ required:
+ - addrvec
+ type: object
+ rank:
+ description: ''
+ type: integer
+ stats:
+ description: ''
+ properties:
+ num_sessions:
+ 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
required:
- - description
- - nick
- - type
- - priority
- - units
- - value
+ - 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:
- - .cache_bytes
- type: object
- required:
- - mon.a
+ - name
+ - rank
+ - state
+ - election_epoch
+ - quorum
+ - quorum_age
+ - features
+ - outside_quorum
+ - extra_probe_peers
+ - sync_provider
+ - monmap
+ - feature_map
+ type: object
+ out_quorum:
+ description: ''
+ items:
+ type: integer
+ type: array
+ required:
+ - mon_status
+ - in_quorum
+ - out_quorum
type: object
description: OK
'400':
trace.
security:
- jwt: []
- summary: Display Perf Counters
+ summary: Get Monitor Details
tags:
- - PerfCounters
- /api/perf_counters/mds/{service_id}:
+ - Monitor
+ /api/nfs-ganesha/cluster:
get:
- parameters:
- - in: path
- name: service_id
- required: true
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/vnd.ceph.api.v0.1+json:
type: object
description: OK
'400':
security:
- jwt: []
tags:
- - MdsPerfCounter
- /api/perf_counters/mgr/{service_id}:
+ - NFS-Ganesha
+ /api/nfs-ganesha/export:
get:
- parameters:
- - in: path
- name: service_id
- required: true
- schema:
- type: string
+ parameters: []
responses:
'200':
content:
application/vnd.ceph.api.v1.0+json:
- type: object
+ 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:
+ - 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
+ type: object
+ required:
+ - export_id
+ - path
+ - cluster_id
+ - pseudo
+ - access_type
+ - squash
+ - security_label
+ - protocols
+ - transports
+ - fsal
+ - clients
+ type: array
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: List all NFS-Ganesha exports
tags:
- - MgrPerfCounter
- /api/perf_counters/mon/{service_id}:
- get:
- parameters:
- - in: path
- name: service_id
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/vnd.ceph.api.v1.0+json:
+ - 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
- 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:
- - MonPerfCounter
- /api/perf_counters/osd/{service_id}:
- get:
- parameters:
- - in: path
- name: service_id
- required: true
- schema:
- type: string
responses:
- '200':
+ '201':
content:
- application/vnd.ceph.api.v1.0+json:
+ 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:
+ - 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.
+ '202':
+ content:
+ application/vnd.ceph.api.v2.0+json:
type: object
- description: OK
+ 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: Creates a new NFS-Ganesha export
tags:
- - OsdPerfCounter
- /api/perf_counters/rbd-mirror/{service_id}:
- get:
+ - NFS-Ganesha
+ /api/nfs-ganesha/export/{cluster_id}/{export_id}:
+ delete:
parameters:
- - in: path
- name: service_id
+ - 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:
- '200':
+ '202':
content:
- application/vnd.ceph.api.v1.0+json:
+ application/vnd.ceph.api.v2.0+json:
type: object
- description: OK
+ 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:
- - RgwMirrorPerfCounter
- /api/perf_counters/rgw/{service_id}:
+ - NFS-Ganesha
get:
parameters:
- - in: path
- name: service_id
+ - description: Cluster identifier
+ in: path
+ name: cluster_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:
- - RgwPerfCounter
- /api/perf_counters/tcmu-runner/{service_id}:
- get:
- parameters:
- - in: path
- name: service_id
+ - description: Export ID
+ in: path
+ name: export_id
required: true
schema:
type: string
'200':
content:
application/vnd.ceph.api.v1.0+json:
- type: object
+ 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':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Get an NFS-Ganesha export
tags:
- - TcmuRunnerPerfCounter
- /api/pool:
- get:
+ - NFS-Ganesha
+ put:
parameters:
- - allowEmptyValue: true
- description: Pool Attributes
- in: query
- name: attrs
- schema:
+ - description: Cluster identifier
+ in: path
+ name: cluster_id
+ required: true
+ schema:
type: string
- - default: false
- description: Pool Stats
- in: query
- name: stats
+ - description: Export ID
+ in: path
+ name: export_id
+ required: true
schema:
- type: boolean
- responses:
- '200':
- content:
- 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: 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
- type: array
- hit_set_count:
- description: ''
- type: integer
- hit_set_grade_decay_rate:
- description: ''
- type: integer
- hit_set_params:
- description: ''
- properties:
- type:
- description: ''
+ addresses:
+ description: list of IP addresses
+ items:
type: string
- required:
- - type
- 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: 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
- last_force_op_resend_preluminous:
- description: ''
+ name:
+ description: name of FSAL
type: string
- last_force_op_resend_prenautilus:
- description: ''
+ sec_label_xattr:
+ description: Name of xattr for security label
type: string
- last_pg_merge_meta:
- description: ''
+ 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/vnd.ceph.api.v2.0+json:
+ schema:
+ properties:
+ access_type:
+ description: Export access type
+ type: string
+ clients:
+ description: List of client configurations
+ items:
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: ''
+ access_type:
+ description: Client access type
type: string
- target_version:
- description: ''
+ addresses:
+ description: list of IP addresses
+ items:
+ type: string
+ type: array
+ squash:
+ description: Client squash policy
type: string
required:
- - ready_epoch
- - last_epoch_started
- - last_epoch_clean
- - source_pgid
- - source_version
- - target_version
+ - addresses
+ - access_type
+ - squash
type: object
- min_read_recency_for_promote:
- description: ''
+ 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
- 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:
- - pg_num_min
- - pg_num_max
- 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: 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
- 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: array
+ required:
+ - export_id
+ - path
+ - cluster_id
+ - pseudo
+ - access_type
+ - squash
+ - security_label
+ - protocols
+ - transports
+ - fsal
+ - clients
+ 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/osd:
+ 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:
+ - OSD
+ post:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ data:
+ type: string
+ method:
+ type: string
+ tracking_id:
+ type: string
+ required:
+ - method
+ - data
+ - tracking_id
+ 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:
+ - OSD
+ /api/osd/flags:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ list_of_flags:
+ description: ''
+ items:
type: string
- use_gmt_hitset:
- description: ''
- type: boolean
- write_tier:
- description: ''
- type: integer
- type: object
+ type: array
required:
- - pool
- - pool_name
- - flags
- - flags_names
- - type
- - size
- - min_size
- - crush_rule
- - object_hash
- - pg_autoscale_mode
- - pg_num
- - pg_placement_num
- - pg_placement_num_target
- - pg_num_target
- - pg_num_pending
- - last_pg_merge_meta
- - auid
- - snap_mode
- - snap_seq
- - snap_epoch
- - pool_snaps
- - quota_max_bytes
- - quota_max_objects
- - tiers
- - tier_of
- - read_tier
- - write_tier
- - cache_mode
- - target_max_bytes
- - target_max_objects
- - cache_target_dirty_ratio_micro
+ - list_of_flags
+ 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 OSD Flags
+ tags:
+ - OSD
+ put:
+ description: "\n The `recovery_deletes`, `sortbitwise` and `pglog_hardlimit`\
+ \ flags cannot be unset.\n `purged_snapshots` cannot even be set. It\
+ \ is therefore required to at\n least include those four flags for\
+ \ a successful operation.\n "
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ flags:
+ description: List of flags to set. The flags `recovery_deletes`,
+ `sortbitwise` and `pglog_hardlimit` cannot be unset. Additionally
+ `purged_snapshots` cannot even be set.
+ items:
+ type: string
+ type: array
+ required:
+ - flags
+ type: object
+ responses:
+ '200':
+ content:
+ application/vnd.ceph.api.v1.0+json:
+ schema:
+ properties:
+ list_of_flags:
+ description: ''
+ items:
+ type: string
+ type: array
+ required:
+ - list_of_flags
+ 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: Sets OSD flags for the entire cluster.
+ tags:
+ - OSD
+ /api/osd/flags/individual:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ 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:
+ - osd
+ - flags
+ 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: Displays individual OSD flags
+ tags:
+ - OSD
+ put:
+ description: "\n Updates flags (`noout`, `noin`, `nodown`, `noup`) for\
+ \ an individual\n subset of OSDs.\n "
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ flags:
+ description: Directory of flags to set or unset. The flags `noin`,
+ `noout`, `noup` and `nodown` are going to be considered only.
+ properties:
+ nodown:
+ description: Sets/unsets `nodown`
+ type: boolean
+ noin:
+ description: Sets/unsets `noin`
+ type: boolean
+ noout:
+ description: Sets/unsets `noout`
+ type: boolean
+ noup:
+ description: Sets/unsets `noup`
+ type: boolean
+ type: object
+ ids:
+ description: List of OSD ids the flags should be applied to.
+ items:
+ type: integer
+ type: array
+ required:
+ - flags
+ - ids
+ type: object
+ responses:
+ '200':
+ content:
+ 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:
+ - added
+ - removed
+ - ids
+ 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: Sets OSD flags for a subset of individual OSDs.
+ tags:
+ - OSD
+ /api/osd/safe_to_delete:
+ get:
+ description: "\n :type ids: int|[int]\n "
+ parameters:
+ - in: query
+ name: svc_ids
+ 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:
+ - OSD
+ /api/osd/safe_to_destroy:
+ get:
+ description: "\n :type ids: int|[int]\n "
+ parameters:
+ - description: OSD Service Identifier
+ in: query
+ name: ids
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ 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:
+ - safe_to_destroy
+ - active
+ - missing_stats
+ - stored_pgs
+ - is_safe_to_destroy
+ 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: Check If OSD is Safe to Destroy
+ tags:
+ - OSD
+ /api/osd/settings:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/vnd.ceph.api.v0.1+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:
+ - OSD
+ /api/osd/{svc_id}:
+ delete:
+ parameters:
+ - in: path
+ name: svc_id
+ required: true
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: preserve_id
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: force
+ 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:
+ - OSD
+ get:
+ description: "\n Returns collected data about an OSD.\n\n :return:\
+ \ Returns the requested data.\n "
+ 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:
+ - OSD
+ put:
+ parameters:
+ - in: path
+ name: svc_id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ device_class:
+ type: string
+ required:
+ - device_class
+ 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:
+ - OSD
+ /api/osd/{svc_id}/destroy:
+ post:
+ description: "\n Mark osd as being destroyed. Keeps the ID intact (allowing\
+ \ reuse), but\n removes cephx keys, config-key data and lockbox keys,\
+ \ rendering data\n permanently unreadable.\n\n The osd must\
+ \ be marked down before being destroyed.\n "
+ parameters:
+ - in: path
+ name: svc_id
+ 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:
+ - OSD
+ /api/osd/{svc_id}/devices:
+ 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:
+ - OSD
+ /api/osd/{svc_id}/histogram:
+ get:
+ description: "\n :return: Returns the histogram data.\n "
+ 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:
+ - OSD
+ /api/osd/{svc_id}/mark:
+ put:
+ description: "\n Note: osd must be marked `down` before marking lost.\n\
+ \ "
+ parameters:
+ - description: SVC ID
+ in: path
+ name: svc_id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ action:
+ type: string
+ required:
+ - action
+ 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: Mark OSD flags (out, in, down, lost, ...)
+ tags:
+ - OSD
+ /api/osd/{svc_id}/purge:
+ post:
+ description: "\n Note: osd must be marked `down` before removal.\n \
+ \ "
+ parameters:
+ - in: path
+ name: svc_id
+ 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:
+ - OSD
+ /api/osd/{svc_id}/reweight:
+ post:
+ description: "\n Reweights the OSD temporarily.\n\n Note that\
+ \ \u2018ceph osd reweight\u2019 is not a persistent setting. When an OSD\n\
+ \ gets marked out, the osd weight will be set to 0. When it gets marked\n\
+ \ in again, the weight will be changed to 1.\n\n Because of\
+ \ this \u2018ceph osd reweight\u2019 is a temporary solution. You should\n\
+ \ only use it to keep your cluster running while you\u2019re ordering\
+ \ more\n hardware.\n\n - Craig Lewis (http://lists.ceph.com/pipermail/ceph-users-ceph.com/2014-June/040967.html)\n\
+ \ "
+ parameters:
+ - in: path
+ name: svc_id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ weight:
+ type: string
+ required:
+ - weight
+ 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:
+ - OSD
+ /api/osd/{svc_id}/scrub:
+ post:
+ parameters:
+ - in: path
+ name: svc_id
+ required: true
+ schema:
+ type: string
+ - default: false
+ in: query
+ name: deep
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ deep:
+ default: false
+ type: boolean
+ 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:
+ - OSD
+ /api/osd/{svc_id}/smart:
+ 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:
+ - OSD
+ /api/perf_counters:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/vnd.ceph.api.v1.0+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:
+ - description
+ - nick
+ - type
+ - priority
+ - units
+ - value
+ type: object
+ required:
+ - .cache_bytes
+ type: object
+ required:
+ - mon.a
+ 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 Perf Counters
+ tags:
+ - PerfCounters
+ /api/perf_counters/mds/{service_id}:
+ get:
+ parameters:
+ - in: path
+ name: service_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:
+ - MdsPerfCounter
+ /api/perf_counters/mgr/{service_id}:
+ get:
+ parameters:
+ - in: path
+ name: service_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:
+ - MgrPerfCounter
+ /api/perf_counters/mon/{service_id}:
+ get:
+ parameters:
+ - in: path
+ name: service_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:
+ - MonPerfCounter
+ /api/perf_counters/osd/{service_id}:
+ get:
+ parameters:
+ - in: path
+ name: service_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:
+ - OsdPerfCounter
+ /api/perf_counters/rbd-mirror/{service_id}:
+ get:
+ parameters:
+ - in: path
+ name: service_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:
+ - RgwMirrorPerfCounter
+ /api/perf_counters/rgw/{service_id}:
+ get:
+ parameters:
+ - in: path
+ name: service_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:
+ - RgwPerfCounter
+ /api/perf_counters/tcmu-runner/{service_id}:
+ get:
+ parameters:
+ - in: path
+ name: service_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:
+ - TcmuRunnerPerfCounter
+ /api/pool:
+ get:
+ parameters:
+ - allowEmptyValue: true
+ description: Pool Attributes
+ in: query
+ name: attrs
+ schema:
+ type: string
+ - default: false
+ description: Pool Stats
+ in: query
+ name: stats
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ 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:
+ - type
+ 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:
+ - ready_epoch
+ - last_epoch_started
+ - last_epoch_clean
+ - source_pgid
+ - source_version
+ - target_version
+ 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:
+ - pg_num_min
+ - pg_num_max
+ 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:
+ - pool
+ - pool_name
+ - flags
+ - flags_names
+ - type
+ - size
+ - min_size
+ - crush_rule
+ - object_hash
+ - pg_autoscale_mode
+ - pg_num
+ - pg_placement_num
+ - pg_placement_num_target
+ - pg_num_target
+ - pg_num_pending
+ - last_pg_merge_meta
+ - auid
+ - snap_mode
+ - snap_seq
+ - snap_epoch
+ - pool_snaps
+ - quota_max_bytes
+ - quota_max_objects
+ - tiers
+ - tier_of
+ - read_tier
+ - write_tier
+ - cache_mode
+ - target_max_bytes
+ - target_max_objects
+ - cache_target_dirty_ratio_micro
- cache_target_dirty_high_ratio_micro
- cache_target_full_ratio_micro
- cache_min_flush_age
trace.
security:
- jwt: []
- summary: Display Pool List
+ 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/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:
+ - Pool
+ /api/pool/{pool_name}:
+ delete:
+ parameters:
+ - in: path
+ name: pool_name
+ 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:
+ - 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/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:
+ - 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
+ 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:
+ - Pool
+ /api/pool/{pool_name}/configuration:
+ get:
+ parameters:
+ - in: path
+ name: pool_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:
+ - Pool
+ /api/prometheus:
+ 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:
+ - Prometheus
+ /api/prometheus/data:
+ 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:
+ - Prometheus
+ /api/prometheus/notifications:
+ 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:
+ - PrometheusNotifications
+ /api/prometheus/rules:
+ 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:
+ - Prometheus
+ /api/prometheus/silence:
+ post:
+ parameters: []
+ 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:
+ - Prometheus
+ /api/prometheus/silence/{s_id}:
+ delete:
+ parameters:
+ - in: path
+ name: s_id
+ 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:
+ - Prometheus
+ /api/prometheus/silences:
+ 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:
+ - Prometheus
+ /api/rgw/bucket:
+ 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
+ responses:
+ '200':
+ content:
+ application/vnd.ceph.api.v1.1+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:
+ - RgwBucket
+ post:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ bucket:
+ 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
+ uid:
+ type: string
+ zonegroup:
+ type: string
+ required:
+ - bucket
+ - uid
+ 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:
+ - RgwBucket
+ /api/rgw/bucket/deleteEncryption:
+ delete:
+ 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
+ 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
+ /api/rgw/bucket/getEncryption:
+ 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
+ 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:
+ - RgwBucket
+ /api/rgw/bucket/getEncryptionConfig:
+ get:
+ parameters:
+ - 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: 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
- post:
+ - RgwBucket
+ /api/rgw/bucket/setEncryptionConfig:
+ put:
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- pool:
- default: rbd-mirror
+ address:
+ type: string
+ auth_method:
+ type: string
+ client_cert:
+ type: string
+ client_key:
+ type: string
+ daemon_name:
+ type: string
+ encryption_type:
+ type: string
+ kms_provider:
+ type: string
+ namespace:
+ default: ''
+ type: string
+ owner:
+ type: string
+ secret_engine:
+ type: string
+ secret_path:
+ default: ''
+ type: string
+ ssl_cert:
+ type: string
+ token:
type: string
type: object
responses:
- '201':
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
+ description: Resource updated.
'202':
content:
application/vnd.ceph.api.v1.0+json:
security:
- jwt: []
tags:
- - Pool
- /api/pool/{pool_name}:
+ - RgwBucket
+ /api/rgw/bucket/{bucket}:
delete:
parameters:
- in: path
- name: pool_name
+ name: bucket
required: true
schema:
type: string
+ - default: 'true'
+ in: query
+ name: purge_objects
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
responses:
'202':
content:
security:
- jwt: []
tags:
- - Pool
+ - RgwBucket
get:
parameters:
- in: path
- name: pool_name
+ name: bucket
required: true
schema:
type: string
- allowEmptyValue: true
in: query
- name: attrs
+ name: daemon_name
schema:
type: string
- - default: false
- in: query
- name: stats
- schema:
- type: boolean
responses:
'200':
content:
security:
- jwt: []
tags:
- - Pool
+ - RgwBucket
put:
parameters:
- in: path
- name: pool_name
+ name: bucket
required: true
schema:
type: string
application/json:
schema:
properties:
- application_metadata:
+ bucket_id:
type: string
- configuration:
+ daemon_name:
type: string
- flags:
+ encryption_state:
+ default: 'false'
+ type: string
+ encryption_type:
+ type: string
+ key_id:
+ 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
+ uid:
+ type: string
+ versioning_state:
+ type: string
+ required:
+ - bucket_id
+ - uid
+ 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:
+ - RgwBucket
+ /api/rgw/daemon:
+ get:
+ parameters: []
+ responses:
+ '200':
+ content:
+ 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
+ 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 Daemons
+ tags:
+ - RgwDaemon
+ /api/rgw/daemon/set_multisite_config:
+ put:
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ daemon_name:
+ type: string
+ realm_name:
+ type: string
+ zone_name:
+ type: string
+ zonegroup_name:
type: string
type: object
responses:
security:
- jwt: []
tags:
- - Pool
- /api/pool/{pool_name}/configuration:
+ - RgwDaemon
+ /api/rgw/daemon/{svc_id}:
get:
parameters:
- in: path
- name: pool_name
+ name: svc_id
required: true
schema:
type: string
security:
- jwt: []
tags:
- - Pool
- /api/prometheus:
+ - RgwDaemon
+ /api/rgw/realm:
get:
parameters: []
responses:
security:
- jwt: []
tags:
- - Prometheus
- /api/prometheus/data:
- get:
+ - RgwRealm
+ post:
parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ default:
+ type: string
+ realm_name:
+ type: string
+ required:
+ - realm_name
+ - default
+ type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - Prometheus
- /api/prometheus/notifications:
+ - RgwRealm
+ /api/rgw/realm/get_all_realms_info:
get:
parameters: []
responses:
security:
- jwt: []
tags:
- - PrometheusNotifications
- /api/prometheus/rules:
+ - RgwRealm
+ /api/rgw/realm/get_realm_tokens:
get:
parameters: []
responses:
security:
- jwt: []
tags:
- - Prometheus
- /api/prometheus/silence:
+ - RgwRealm
+ /api/rgw/realm/import_realm_token:
post:
parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ placement_spec:
+ type: string
+ port:
+ type: string
+ realm_token:
+ type: string
+ zone_name:
+ type: string
+ required:
+ - realm_token
+ - zone_name
+ - port
+ - placement_spec
+ type: object
responses:
'201':
content:
security:
- jwt: []
tags:
- - Prometheus
- /api/prometheus/silence/{s_id}:
+ - RgwRealm
+ /api/rgw/realm/{realm_name}:
delete:
parameters:
- in: path
- name: s_id
+ name: realm_name
required: true
schema:
type: string
security:
- jwt: []
tags:
- - Prometheus
- /api/prometheus/silences:
+ - RgwRealm
get:
- parameters: []
+ parameters:
+ - in: path
+ name: realm_name
+ required: true
+ schema:
+ type: string
responses:
'200':
content:
security:
- jwt: []
tags:
- - Prometheus
- /api/rgw/bucket:
- get:
+ - RgwRealm
+ put:
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
+ - 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/vnd.ceph.api.v1.1+json:
+ application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - RgwBucket
- post:
+ - RgwRealm
+ /api/rgw/roles:
+ get:
parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- bucket:
- 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
- uid:
- type: string
- zonegroup:
- type: string
- required:
- - bucket
- - uid
- type: object
responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
+ '200':
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: List RGW roles
tags:
- - RgwBucket
- /api/rgw/bucket/deleteEncryption:
- delete:
- 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
+ - 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:
- '202':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Operation is still executing. Please check the task queue.
- '204':
+ description: Resource created.
+ '202':
content:
application/vnd.ceph.api.v1.0+json:
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: Create Ceph User
tags:
- - RgwBucket
- /api/rgw/bucket/getEncryption:
+ - RGW
+ /api/rgw/site:
get:
parameters:
- - in: query
- name: bucket_name
- required: true
- schema:
- type: string
- allowEmptyValue: true
in: query
- name: daemon_name
+ name: query
schema:
type: string
- allowEmptyValue: true
in: query
- name: owner
+ name: daemon_name
schema:
type: string
responses:
security:
- jwt: []
tags:
- - RgwBucket
- /api/rgw/bucket/getEncryptionConfig:
+ - RgwSite
+ /api/rgw/user:
get:
parameters:
- allowEmptyValue: true
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
+ schema:
+ properties:
+ list_of_users:
+ description: list of rgw users
+ items:
+ type: string
+ type: array
+ required:
+ - list_of_users
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
+ summary: Display RGW Users
tags:
- - RgwBucket
- /api/rgw/bucket/setEncryptionConfig:
- put:
+ - RgwUser
+ post:
parameters: []
requestBody:
content:
application/json:
schema:
properties:
- address:
- type: string
- auth_method:
- type: string
- client_cert:
- type: string
- client_key:
+ access_key:
type: string
daemon_name:
type: string
- encryption_type:
- type: string
- kms_provider:
+ display_name:
type: string
- namespace:
- default: ''
+ email:
type: string
- owner:
+ generate_key:
type: string
- secret_engine:
+ max_buckets:
type: string
- secret_path:
- default: ''
+ secret_key:
type: string
- ssl_cert:
+ suspended:
type: string
- token:
+ uid:
type: string
+ required:
+ - uid
+ - display_name
type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource updated.
+ description: Resource created.
'202':
content:
application/vnd.ceph.api.v1.0+json:
security:
- jwt: []
tags:
- - RgwBucket
- /api/rgw/bucket/{bucket}:
+ - RgwUser
+ /api/rgw/user/get_emails:
+ get:
+ parameters:
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ 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:
+ - RgwUser
+ /api/rgw/user/{uid}:
delete:
parameters:
- in: path
- name: bucket
+ name: uid
required: true
schema:
type: string
- - default: 'true'
- in: query
- name: purge_objects
- schema:
- type: string
- allowEmptyValue: true
in: query
name: daemon_name
security:
- jwt: []
tags:
- - RgwBucket
+ - RgwUser
get:
parameters:
- in: path
- name: bucket
+ name: uid
required: true
schema:
type: string
name: daemon_name
schema:
type: string
+ - default: true
+ in: query
+ name: stats
+ schema:
+ type: boolean
responses:
'200':
content:
security:
- jwt: []
tags:
- - RgwBucket
+ - RgwUser
put:
parameters:
- in: path
- name: bucket
+ name: uid
required: true
schema:
type: string
application/json:
schema:
properties:
- bucket_id:
- type: string
daemon_name:
type: string
- encryption_state:
- default: 'false'
- type: string
- encryption_type:
- type: string
- key_id:
- 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:
+ display_name:
type: string
- mfa_token_serial:
+ email:
type: string
- uid:
+ max_buckets:
type: string
- versioning_state:
+ suspended:
type: string
- required:
- - bucket_id
- - uid
type: object
responses:
'200':
security:
- jwt: []
tags:
- - RgwBucket
- /api/rgw/daemon:
- get:
- parameters: []
+ - 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:
- '200':
+ '202':
content:
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
- description: OK
+ 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: Display RGW Daemons
tags:
- - RgwDaemon
- /api/rgw/daemon/{svc_id}:
- get:
+ - RgwUser
+ post:
parameters:
- in: path
- name: svc_id
+ 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/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
security:
- jwt: []
tags:
- - RgwDaemon
- /api/rgw/roles:
- get:
- parameters: []
+ - 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: subuser
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: access_key
+ schema:
+ type: string
+ - allowEmptyValue: true
+ in: query
+ name: daemon_name
+ schema:
+ type: string
responses:
- '200':
+ '202':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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: List RGW roles
tags:
- - RGW
+ - RgwUser
post:
- parameters: []
+ parameters:
+ - in: path
+ name: uid
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- role_assume_policy_doc:
- default: ''
+ access_key:
type: string
- role_name:
- default: ''
+ daemon_name:
type: string
- role_path:
- default: ''
+ generate_key:
+ default: 'true'
+ type: string
+ key_type:
+ default: s3
+ type: string
+ secret_key:
+ type: string
+ subuser:
type: string
type: object
responses:
trace.
security:
- jwt: []
- summary: Create Ceph User
- tags:
- - RGW
- /api/rgw/site:
- get:
- parameters:
- - allowEmptyValue: true
- in: query
- name: query
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: daemon_name
- 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:
- - RgwSite
- /api/rgw/user:
+ - RgwUser
+ /api/rgw/user/{uid}/quota:
get:
parameters:
+ - in: path
+ name: uid
+ required: true
+ schema:
+ type: string
- allowEmptyValue: true
in: query
name: daemon_name
'200':
content:
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
+ type: object
description: OK
'400':
description: Operation exception. Please check the response body for details.
trace.
security:
- jwt: []
- summary: Display RGW Users
tags:
- RgwUser
- post:
- parameters: []
+ put:
+ parameters:
+ - in: path
+ name: uid
+ required: true
+ schema:
+ type: string
requestBody:
content:
application/json:
schema:
properties:
- access_key:
- type: string
daemon_name:
type: string
- display_name:
- type: string
- email:
- type: string
- generate_key:
- type: string
- max_buckets:
- type: string
- secret_key:
+ enabled:
type: string
- suspended:
+ max_objects:
type: string
- uid:
+ max_size_kb:
+ type: integer
+ quota_type:
type: string
required:
- - uid
- - display_name
+ - quota_type
+ - enabled
+ - max_size_kb
+ - max_objects
type: object
responses:
- '201':
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
+ description: Resource updated.
'202':
content:
application/vnd.ceph.api.v1.0+json:
- jwt: []
tags:
- RgwUser
- /api/rgw/user/get_emails:
- get:
+ /api/rgw/user/{uid}/subuser:
+ post:
parameters:
- - allowEmptyValue: true
- in: query
- name: daemon_name
+ - in: path
+ name: uid
+ required: true
schema:
type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ access:
+ type: string
+ access_key:
+ type: string
+ daemon_name:
+ type: string
+ generate_secret:
+ default: 'true'
+ type: string
+ key_type:
+ default: s3
+ type: string
+ secret_key:
+ type: string
+ subuser:
+ type: string
+ required:
+ - subuser
+ - access
+ type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: OK
+ 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':
- jwt: []
tags:
- RgwUser
- /api/rgw/user/{uid}:
+ /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
+ - in: path
+ name: subuser
+ required: true
+ schema:
+ type: string
+ - default: 'true'
+ in: query
+ name: purge_keys
+ schema:
+ type: string
- allowEmptyValue: true
in: query
name: daemon_name
- jwt: []
tags:
- RgwUser
+ /api/rgw/zone:
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
+ parameters: []
responses:
'200':
content:
security:
- jwt: []
tags:
- - RgwUser
- put:
- parameters:
- - in: path
- name: uid
- required: true
- schema:
- type: string
+ - RgwZone
+ post:
+ parameters: []
requestBody:
content:
application/json:
schema:
properties:
- daemon_name:
+ access_key:
type: string
- display_name:
+ default:
+ default: false
+ type: boolean
+ master:
+ default: false
+ type: boolean
+ secret_key:
type: string
- email:
+ zone_endpoints:
type: string
- max_buckets:
+ zone_name:
type: string
- suspended:
+ zonegroup_name:
type: string
+ required:
+ - zone_name
type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource updated.
+ description: Resource created.
'202':
content:
application/vnd.ceph.api.v1.0+json:
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
+ - 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/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.
- '204':
+ '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/get_all_zones_info:
+ get:
+ parameters: []
+ responses:
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource deleted.
+ description: OK
'400':
description: Operation exception. Please check the response body for details.
'401':
security:
- jwt: []
tags:
- - RgwUser
- post:
+ - RgwZone
+ /api/rgw/zone/get_pool_names:
+ 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:
+ - RgwZone
+ /api/rgw/zone/get_user_list:
+ get:
parameters:
- - in: path
- name: uid
- required: true
+ - allowEmptyValue: true
+ in: query
+ name: zoneName
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:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
+ '200':
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':
security:
- jwt: []
tags:
- - RgwUser
- /api/rgw/user/{uid}/key:
+ - RgwZone
+ /api/rgw/zone/{zone_name}:
delete:
parameters:
- in: path
- name: uid
+ name: zone_name
required: true
schema:
type: string
- - default: s3
- in: query
- name: key_type
- schema:
- type: string
- - allowEmptyValue: true
- in: query
- name: subuser
+ - in: query
+ name: delete_pools
+ required: true
schema:
type: string
- allowEmptyValue: true
in: query
- name: access_key
+ name: pools
schema:
type: string
- allowEmptyValue: true
in: query
- name: daemon_name
+ name: zonegroup_name
schema:
type: string
responses:
security:
- jwt: []
tags:
- - RgwUser
- post:
+ - RgwZone
+ get:
parameters:
- in: path
- name: uid
+ name: zone_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:
+ - RgwZone
+ put:
+ parameters:
+ - in: path
+ name: zone_name
required: true
schema:
type: string
schema:
properties:
access_key:
+ default: ''
type: string
- daemon_name:
+ compression:
+ default: ''
type: string
- generate_key:
- default: 'true'
+ data_extra_pool:
+ default: ''
type: string
- key_type:
- default: s3
+ data_pool:
+ default: ''
+ type: string
+ data_pool_class:
+ default: ''
+ type: string
+ default:
+ default: ''
+ type: string
+ index_pool:
+ default: ''
+ type: string
+ master:
+ default: ''
+ type: string
+ new_zone_name:
+ type: string
+ placement_target:
+ default: ''
type: string
secret_key:
+ default: ''
type: string
- subuser:
+ storage_class:
+ default: ''
+ type: string
+ zone_endpoints:
+ default: ''
+ type: string
+ zonegroup_name:
type: string
+ required:
+ - new_zone_name
+ - zonegroup_name
type: object
responses:
- '201':
+ '200':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource created.
+ description: Resource updated.
'202':
content:
application/vnd.ceph.api.v1.0+json:
security:
- jwt: []
tags:
- - RgwUser
- /api/rgw/user/{uid}/quota:
+ - RgwZone
+ /api/rgw/zonegroup:
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:
security:
- jwt: []
tags:
- - RgwUser
- put:
- parameters:
- - in: path
- name: uid
- required: true
- schema:
- type: string
+ - RgwZonegroup
+ post:
+ parameters: []
requestBody:
content:
application/json:
schema:
properties:
- daemon_name:
+ default:
type: string
- enabled:
+ master:
type: string
- max_objects:
+ realm_name:
type: string
- max_size_kb:
- type: integer
- quota_type:
+ zonegroup_endpoints:
+ type: string
+ zonegroup_name:
type: string
required:
- - quota_type
- - enabled
- - max_size_kb
- - max_objects
+ - realm_name
+ - zonegroup_name
type: object
responses:
- '200':
+ '201':
content:
application/vnd.ceph.api.v1.0+json:
type: object
- description: Resource updated.
+ description: Resource created.
'202':
content:
application/vnd.ceph.api.v1.0+json:
security:
- jwt: []
tags:
- - RgwUser
- /api/rgw/user/{uid}/subuser:
- post:
- parameters:
- - in: path
- name: uid
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- properties:
- access:
- type: string
- access_key:
- type: string
- daemon_name:
- type: string
- generate_secret:
- default: 'true'
- type: string
- key_type:
- default: s3
- type: string
- secret_key:
- type: string
- subuser:
- type: string
- required:
- - subuser
- - access
- type: object
+ - RgwZonegroup
+ /api/rgw/zonegroup/get_all_zonegroups_info:
+ get:
+ parameters: []
responses:
- '201':
- content:
- application/vnd.ceph.api.v1.0+json:
- type: object
- description: Resource created.
- '202':
+ '200':
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':
security:
- jwt: []
tags:
- - RgwUser
- /api/rgw/user/{uid}/subuser/{subuser}:
+ - RgwZonegroup
+ /api/rgw/zonegroup/{zonegroup_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: zonegroup_name
required: true
schema:
type: string
- - in: path
- name: subuser
+ - in: query
+ name: delete_pools
required: true
schema:
type: string
- - default: 'true'
- in: query
- name: purge_keys
- schema:
- type: string
- allowEmptyValue: true
in: query
- name: daemon_name
+ name: pools
schema:
type: string
responses:
security:
- jwt: []
tags:
- - RgwUser
+ - RgwZonegroup
+ get:
+ parameters:
+ - in: path
+ name: zonegroup_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:
+ - RgwZonegroup
+ put:
+ parameters:
+ - in: path
+ name: zonegroup_name
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ 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: ''
+ type: string
+ required:
+ - realm_name
+ - new_zonegroup_name
+ 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:
+ - RgwZonegroup
/api/role:
get:
parameters: []
tags:
- description: Initiate a session with Ceph
name: Auth
+- description: CephFS Subvolume Management API
+ name: CephFSSubvolume
- description: Cephfs Management API
name: Cephfs
+- description: Cephfs Subvolume Group Management API
+ name: CephfsSubvolumeGroup
- description: Get Cluster Details
name: Cluster
- description: Manage Cluster Configurations
name: RgwMirrorPerfCounter
- description: Rgw Perf Counters Management API
name: RgwPerfCounter
+- description: '*No description available*'
+ name: RgwRealm
- description: RGW Site Management API
name: RgwSite
- description: RGW User Management API
name: RgwUser
+- description: '*No description available*'
+ name: RgwZone
+- description: '*No description available*'
+ name: RgwZonegroup
- description: Role Management API
name: Role
- description: Service Management API
name: TcmuRunnerPerfCounter
- description: Display Telemetry Report
name: Telemetry
+- description: Upgrade Management API
+ name: Upgrade
- description: Display User Details
name: User
- description: Change User Password
projects / ceph.git / blobdiff