diff options
Diffstat (limited to 'src/pybind/mgr/dashboard/openapi.yaml')
| -rw-r--r-- | src/pybind/mgr/dashboard/openapi.yaml | 878 |
1 files changed, 877 insertions, 1 deletions
diff --git a/src/pybind/mgr/dashboard/openapi.yaml b/src/pybind/mgr/dashboard/openapi.yaml index aeb5d9464..8b4c6bb79 100644 --- a/src/pybind/mgr/dashboard/openapi.yaml +++ b/src/pybind/mgr/dashboard/openapi.yaml @@ -1658,6 +1658,58 @@ paths: - jwt: [] tags: - Cephfs + /api/cephfs/auth: + put: + parameters: [] + requestBody: + content: + application/json: + schema: + properties: + caps: + description: Path and given capabilities + type: string + client_id: + description: Cephx user ID + type: string + fs_name: + description: File system name + type: string + root_squash: + description: File System Identifier + type: string + required: + - fs_name + - client_id + - caps + - root_squash + 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 Ceph authentication capabilities for the specified user ID in the + given path + tags: + - Cephfs /api/cephfs/remove/{name}: delete: parameters: @@ -1735,6 +1787,316 @@ paths: summary: Rename CephFS Volume tags: - Cephfs + /api/cephfs/snapshot/schedule: + post: + parameters: [] + requestBody: + content: + application/json: + schema: + properties: + fs: + type: string + group: + type: string + path: + type: string + retention_policy: + type: string + snap_schedule: + type: string + start: + type: string + subvol: + type: string + required: + - fs + - path + - snap_schedule + - start + 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: + - CephFSSnapshotSchedule + /api/cephfs/snapshot/schedule/{fs}: + get: + parameters: + - in: path + name: fs + required: true + schema: + type: string + - default: / + in: query + name: path + schema: + type: string + - default: true + in: query + name: recursive + 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: + - CephFSSnapshotSchedule + /api/cephfs/snapshot/schedule/{fs}/{path}: + put: + parameters: + - in: path + name: fs + required: true + schema: + type: string + - in: path + name: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + group: + type: string + retention_to_add: + type: string + retention_to_remove: + type: string + subvol: + 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: + - CephFSSnapshotSchedule + /api/cephfs/snapshot/schedule/{fs}/{path}/activate: + post: + parameters: + - in: path + name: fs + required: true + schema: + type: string + - in: path + name: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + group: + type: string + schedule: + type: string + start: + type: string + subvol: + type: string + required: + - schedule + - start + 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: + - CephFSSnapshotSchedule + /api/cephfs/snapshot/schedule/{fs}/{path}/deactivate: + post: + parameters: + - in: path + name: fs + required: true + schema: + type: string + - in: path + name: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + group: + type: string + schedule: + type: string + start: + type: string + subvol: + type: string + required: + - schedule + - start + 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: + - CephFSSnapshotSchedule + /api/cephfs/snapshot/schedule/{fs}/{path}/delete_snapshot: + delete: + parameters: + - in: path + name: fs + required: true + schema: + type: string + - in: path + name: path + required: true + schema: + type: string + - in: query + name: schedule + required: true + schema: + type: string + - in: query + name: start + required: true + schema: + type: string + - allowEmptyValue: true + in: query + name: retention_policy + schema: + type: string + - allowEmptyValue: true + in: query + name: subvol + schema: + type: string + - allowEmptyValue: true + in: query + name: group + 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: + - CephFSSnapshotSchedule /api/cephfs/subvolume: post: parameters: [] @@ -1859,6 +2221,11 @@ paths: required: true schema: type: string + - default: true + in: query + name: info + schema: + type: boolean responses: '200': content: @@ -1954,6 +2321,240 @@ paths: - jwt: [] tags: - CephfsSubvolumeGroup + /api/cephfs/subvolume/snapshot: + post: + parameters: [] + requestBody: + content: + application/json: + schema: + properties: + group_name: + default: '' + type: string + snap_name: + type: string + subvol_name: + type: string + vol_name: + type: string + required: + - vol_name + - subvol_name + - snap_name + type: object + responses: + '201': + content: + application/vnd.ceph.api.v1.0+json: + type: object + description: Resource created. + '202': + content: + application/vnd.ceph.api.v1.0+json: + type: object + 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: + - CephfsSubvolumeSnapshot + /api/cephfs/subvolume/snapshot/clone: + post: + parameters: [] + requestBody: + content: + application/json: + schema: + properties: + clone_name: + type: string + group_name: + default: '' + type: string + snap_name: + type: string + subvol_name: + type: string + target_group_name: + default: '' + type: string + vol_name: + type: string + required: + - vol_name + - subvol_name + - snap_name + - clone_name + type: object + responses: + '201': + content: + application/vnd.ceph.api.v1.0+json: + type: object + description: Resource created. + '202': + content: + application/vnd.ceph.api.v1.0+json: + type: object + description: Operation is still executing. Please check the task queue. + '400': + description: Operation exception. Please check the response body for details. + '401': + description: Unauthenticated access. Please login first. + '403': + description: Unauthorized access. Please check your permissions. + '500': + description: Unexpected error. Please check the response body for the stack + trace. + security: + - jwt: [] + summary: Create a clone of a subvolume snapshot + tags: + - CephfsSnapshotClone + /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}: + delete: + parameters: + - in: path + name: vol_name + required: true + schema: + type: string + - in: path + name: subvol_name + required: true + schema: + type: string + - in: query + name: snap_name + required: true + schema: + type: string + - default: '' + in: query + name: group_name + schema: + type: string + - default: true + in: query + name: force + schema: + type: boolean + responses: + '202': + content: + application/vnd.ceph.api.v1.0+json: + type: object + description: Operation is still executing. Please check the task queue. + '204': + 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: + - CephfsSubvolumeSnapshot + get: + parameters: + - in: path + name: vol_name + required: true + schema: + type: string + - in: path + name: subvol_name + required: true + schema: + type: string + - default: '' + in: query + name: group_name + schema: + type: string + - default: true + in: query + name: info + 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: + - CephfsSubvolumeSnapshot + /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}/info: + get: + parameters: + - in: path + name: vol_name + required: true + schema: + type: string + - in: path + name: subvol_name + required: true + schema: + type: string + - in: query + name: snap_name + required: true + schema: + type: string + - default: '' + in: query + name: group_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: + - CephfsSubvolumeSnapshot /api/cephfs/subvolume/{vol_name}: delete: parameters: @@ -2013,6 +2614,11 @@ paths: name: group_name schema: type: string + - default: true + in: query + name: info + schema: + type: boolean responses: '200': content: @@ -2079,6 +2685,38 @@ paths: - jwt: [] tags: - CephFSSubvolume + /api/cephfs/subvolume/{vol_name}/exists: + get: + parameters: + - in: path + name: vol_name + required: true + schema: + type: string + - default: '' + in: query + name: group_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: + - CephFSSubvolume /api/cephfs/subvolume/{vol_name}/info: get: parameters: @@ -2505,6 +3143,60 @@ paths: - jwt: [] tags: - Cephfs + /api/cephfs/{fs_id}/statfs: + get: + description: "\n Get the statfs 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 'bytes',\n\ + \ 'files' and 'subdirs'.\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: + schema: + properties: + bytes: + description: '' + type: integer + files: + description: '' + type: integer + subdirs: + description: '' + type: integer + required: + - bytes + - files + - subdirs + 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 Cephfs statfs of the specified path + tags: + - Cephfs /api/cephfs/{fs_id}/tree: delete: description: "\n Remove a directory.\n :param fs_id: The filesystem\ @@ -2587,6 +3279,95 @@ paths: - jwt: [] tags: - Cephfs + /api/cephfs/{fs_id}/unlink: + delete: + description: "\n Removes a file, link, or symbolic link.\n :param\ + \ fs_id: The filesystem identifier.\n :param path: The path of the\ + \ file or link to unlink.\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 + /api/cephfs/{fs_id}/write_to_file: + post: + description: "\n Write some data to the specified path.\n :param\ + \ fs_id: The filesystem identifier.\n :param path: The path of the\ + \ file to write.\n :param buf: The str to write to the buf.\n \ + \ " + parameters: + - in: path + name: fs_id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + buf: + type: string + path: + type: string + required: + - path + - buf + 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: + - Cephfs /api/cluster: get: parameters: [] @@ -8631,6 +9412,10 @@ paths: properties: bucket: type: string + bucket_policy: + type: string + canned_acl: + type: string daemon_name: type: string encryption_state: @@ -8651,6 +9436,8 @@ paths: type: string placement_target: type: string + tags: + type: string uid: type: string zonegroup: @@ -8942,6 +9729,10 @@ paths: properties: bucket_id: type: string + bucket_policy: + type: string + canned_acl: + type: string daemon_name: type: string encryption_state: @@ -8963,6 +9754,8 @@ paths: type: string mfa_token_serial: type: string + tags: + type: string uid: type: string versioning_state: @@ -9430,7 +10223,80 @@ paths: trace. security: - jwt: [] - summary: Create Ceph User + summary: Create RGW role + tags: + - RGW + put: + parameters: [] + requestBody: + content: + application/json: + schema: + properties: + max_session_duration: + type: string + role_name: + type: string + required: + - role_name + - max_session_duration + type: object + responses: + '200': + content: + application/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: Edit RGW role + tags: + - RGW + /api/rgw/roles/{role_name}: + delete: + parameters: + - in: path + name: role_name + required: true + schema: + type: string + responses: + '202': + content: + application/vnd.ceph.api.v1.0+json: + type: object + description: Operation is still executing. Please check the task queue. + '204': + content: + application/vnd.ceph.api.v1.0+json: + type: object + description: Resource deleted. + '400': + description: Operation exception. Please check the response body for details. + '401': + description: Unauthenticated access. Please login first. + '403': + description: Unauthorized access. Please check your permissions. + '500': + description: Unexpected error. Please check the response body for the stack + trace. + security: + - jwt: [] + summary: Delete RGW role tags: - RGW /api/rgw/site: @@ -9525,6 +10391,8 @@ paths: type: string suspended: type: string + system: + type: string uid: type: string required: @@ -9677,6 +10545,8 @@ paths: type: string suspended: type: string + system: + type: string type: object responses: '200': @@ -12605,12 +13475,18 @@ servers: tags: - description: Initiate a session with Ceph name: Auth +- description: Cephfs Snapshot Scheduling API + name: CephFSSnapshotSchedule - description: CephFS Subvolume Management API name: CephFSSubvolume - description: Cephfs Management API name: Cephfs +- description: Cephfs Snapshot Clone Management API + name: CephfsSnapshotClone - description: Cephfs Subvolume Group Management API name: CephfsSubvolumeGroup +- description: Cephfs Subvolume Snapshot Management API + name: CephfsSubvolumeSnapshot - description: Get Cluster Details name: Cluster - description: Manage Cluster Configurations |