Notice

This document is for a development version of Ceph.

Ceph RESTful API

Introduction

The Ceph RESTful API (henceforth Ceph API) is provided by the Ceph Dashboard module. The Ceph API service is available at the same URL as the regular Ceph Dashboard, under the /api base path (please refer to Host Name and Port):

http://<server_addr>:<server_port>/api

or, if HTTPS is enabled (please refer to SSL/TLS Support):

https://<server_addr>:<ssl_server_port>/api

The Ceph API leverages the following standards:

Warning

Some endpoints are still under active development, and should be carefully used since new Ceph releases could bring backward incompatible changes.

Authentication and Authorization

Requests to the Ceph API pass through two access control checkpoints:

  • Authentication: ensures that the request is performed on behalf of an existing and valid user account.

  • Authorization: ensures that the previously authenticated user can in fact perform a specific action (create, read, update or delete) on the target endpoint.

So, prior to start consuming the Ceph API, a valid JSON Web Token (JWT) has to be obtained, and it may then be reused for subsequent requests. The /api/auth endpoint will provide the valid token:

curl -X POST "https://example.com:8443/api/auth" \
-H  "Accept: application/vnd.ceph.api.v1.0+json" \
-H  "Content-Type: application/json" \
-d '{"username": <username>, "password": <password>}'

{ "token": "<redacted_token>", ...}

The token obtained must be passed together with every API request in the Authorization HTTP header:

curl -H "Authorization: Bearer <token>" ...

Authentication and authorization can be further configured from the Ceph CLI, the Ceph-Dashboard UI and the Ceph API itself (please refer to User and Role Management).

Versioning

One of the main goals of the Ceph API is to keep a stable interface. For this purpose, Ceph API is built upon the following principles:

  • Mandatory: in order to avoid implicit defaults, all endpoints require an explicit default version (starting with 1.0).

  • Per-endpoint: as this API wraps many different Ceph components, this allows for a finer-grained change control.

    • Content/MIME Type: the version expected from a specific endpoint is stated by the Accept: application/vnd.ceph.api.v<major>.<minor>+json HTTP header. If the current Ceph API server is not able to address that specific major version, a 415 - Unsupported Media Type response will be returned.

  • Semantic Versioning: with a major.minor version:

    • Major changes are backward incompatible: they might result in non-additive changes to the request and/or response formats of a specific endpoint.

    • Minor changes are backward/forward compatible: they basically consists of additive changes to the request or response formats of a specific endpoint.

An example:

curl -X GET "https://example.com:8443/api/osd" \
-H  "Accept: application/vnd.ceph.api.v1.0+json" \
-H  "Authorization: Bearer <token>"

Specification

Auth

POST /api/auth

Dashboard Authentication

Example request:

POST /api/auth HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "password": "string",
    "ttl": 1,
    "username": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{
    "permissions": {
        "cephfs": [
            "string"
        ]
    },
    "pwdExpirationDate": "string",
    "pwdUpdateRequired": true,
    "sso": true,
    "token": "string",
    "username": "string"
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/auth/check

Check token Authentication

Query Parameters:

  • token (string) -- Authentication Token (Required)

Example request:

POST /api/auth/check?token=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "token": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{
    "permissions": {
        "cephfs": [
            "string"
        ]
    },
    "pwdUpdateRequired": true,
    "sso": true,
    "username": "string"
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/auth/logout
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

CephFSSnapshotSchedule

POST /api/cephfs/snapshot/schedule

Example request:

POST /api/cephfs/snapshot/schedule HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "fs": "string",
    "group": "string",
    "path": "string",
    "retention_policy": "string",
    "snap_schedule": "string",
    "start": "string",
    "subvol": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/snapshot/schedule/{fs}
Parameters:

  • fs (string) --

Query Parameters:

  • path (string) --

  • recursive (boolean) --

Example request:

GET /api/cephfs/snapshot/schedule/{fs} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cephfs/snapshot/schedule/{fs}/{path}
Parameters:

  • fs (string) --

  • path (string) --

Example request:

PUT /api/cephfs/snapshot/schedule/{fs}/{path} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "group": "string",
    "retention_to_add": "string",
    "retention_to_remove": "string",
    "subvol": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cephfs/snapshot/schedule/{fs}/{path}/activate
Parameters:

  • fs (string) --

  • path (string) --

Example request:

POST /api/cephfs/snapshot/schedule/{fs}/{path}/activate HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "group": "string",
    "schedule": "string",
    "start": "string",
    "subvol": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cephfs/snapshot/schedule/{fs}/{path}/deactivate
Parameters:

  • fs (string) --

  • path (string) --

Example request:

POST /api/cephfs/snapshot/schedule/{fs}/{path}/deactivate HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "group": "string",
    "schedule": "string",
    "start": "string",
    "subvol": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/snapshot/schedule/{fs}/{path}/delete_snapshot
Parameters:

  • fs (string) --

  • path (string) --

Query Parameters:

  • schedule (string) -- (Required)

  • start (string) -- (Required)

  • retention_policy (string) --

  • subvol (string) --

  • group (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

CephFSSubvolume

POST /api/cephfs/subvolume

Example request:

POST /api/cephfs/subvolume HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "subvol_name": "string",
    "vol_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/subvolume/{vol_name}
Parameters:

  • vol_name (string) --

Query Parameters:

  • subvol_name (string) -- (Required)

  • group_name (string) --

  • retain_snapshots (boolean) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/subvolume/{vol_name}
Parameters:

  • vol_name (string) --

Query Parameters:

  • group_name (string) --

  • info (boolean) --

Example request:

GET /api/cephfs/subvolume/{vol_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cephfs/subvolume/{vol_name}
Parameters:

  • vol_name (string) --

Example request:

PUT /api/cephfs/subvolume/{vol_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "group_name": "string",
    "size": 1,
    "subvol_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/subvolume/{vol_name}/exists
Parameters:

  • vol_name (string) --

Query Parameters:

  • group_name (string) --

Example request:

GET /api/cephfs/subvolume/{vol_name}/exists HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/subvolume/{vol_name}/info
Parameters:

  • vol_name (string) --

Query Parameters:

  • subvol_name (string) -- (Required)

  • group_name (string) --

Example request:

GET /api/cephfs/subvolume/{vol_name}/info?subvol_name=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/subvolume/{vol_name}/snapshot-visibility
Parameters:

  • vol_name (string) --

Query Parameters:

  • subvol_name (string) -- (Required)

  • group_name (string) --

Example request:

GET /api/cephfs/subvolume/{vol_name}/snapshot-visibility?subvol_name=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cephfs/subvolume/{vol_name}/snapshot-visibility
Parameters:

  • vol_name (string) --

Example request:

PUT /api/cephfs/subvolume/{vol_name}/snapshot-visibility HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "group_name": "string",
    "subvol_name": "string",
    "value": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Cephfs

GET /api/cephfs

Example request:

GET /api/cephfs HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cephfs

Example request:

POST /api/cephfs HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "data_pool": "string",
    "metadata_pool": "string",
    "name": "string",
    "service_spec": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cephfs/auth

Set Ceph authentication capabilities for the specified user ID in the given path

Example request:

PUT /api/cephfs/auth HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "caps": "string",
    "client_id": "string",
    "fs_name": "string",
    "root_squash": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/remove/{name}

Remove CephFS Volume

Parameters:

  • name (string) -- File System Name

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cephfs/rename

Rename CephFS Volume

Example request:

PUT /api/cephfs/rename HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string",
    "new_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/{fs_id}
Parameters:

  • fs_id (string) --

Example request:

GET /api/cephfs/{fs_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/{fs_id}/client/{client_id}
Parameters:

  • fs_id (string) --

  • client_id (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/{fs_id}/clients
Parameters:

  • fs_id (string) --

Example request:

GET /api/cephfs/{fs_id}/clients HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/{fs_id}/get_root_directory

The root directory that can’t be fetched using ls_dir (api). :param fs_id: The filesystem identifier. :return: The root directory :rtype: dict

Parameters:

  • fs_id (string) --

Example request:

GET /api/cephfs/{fs_id}/get_root_directory HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/{fs_id}/ls_dir

List directories of specified path. :param fs_id: The filesystem identifier. :param path: The path where to start listing the directory content. Defaults to ‘/’ if not set. :type path: str | bytes :param depth: The number of steps to go down the directory tree. :type depth: int | str :return: The names of the directories below the specified path. :rtype: list

Parameters:

  • fs_id (string) --

Query Parameters:

  • path (string) --

  • depth (integer) --

Example request:

GET /api/cephfs/{fs_id}/ls_dir HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/{fs_id}/mds_counters
Parameters:

  • fs_id (string) --

Query Parameters:

  • counters (integer) --

Example request:

GET /api/cephfs/{fs_id}/mds_counters HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/{fs_id}/quota

Get Cephfs Quotas of the specified path

Get the quotas of the specified path. :param fs_id: The filesystem identifier. :param path: The path of the directory/file. :return: Returns a dictionary containing ‘max_bytes’ and ‘max_files’. :rtype: dict

Parameters:

  • fs_id (string) -- File System Identifier

Query Parameters:

  • path (string) -- File System Path (Required)

Example request:

GET /api/cephfs/{fs_id}/quota?path=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "max_bytes": 1,
    "max_files": 1
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cephfs/{fs_id}/quota

Set the quotas of the specified path. :param fs_id: The filesystem identifier. :param path: The path of the directory/file. :param max_bytes: The byte limit. :param max_files: The file limit.

Parameters:

  • fs_id (string) --

Example request:

PUT /api/cephfs/{fs_id}/quota HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "max_bytes": "string",
    "max_files": "string",
    "path": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cephfs/{fs_id}/rename-path

Rename a file or directory. :param fs_id: The filesystem identifier. :param src_path: The path to the existing file or directory. :param dst_path: The new name of the file or directory.

Parameters:

  • fs_id (string) --

Example request:

PUT /api/cephfs/{fs_id}/rename-path HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dst_path": "string",
    "src_path": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/{fs_id}/snapshot

Remove a snapshot. :param fs_id: The filesystem identifier. :param path: The path of the directory. :param name: The name of the snapshot.

Parameters:

  • fs_id (string) --

Query Parameters:

  • path (string) -- (Required)

  • name (string) -- (Required)

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cephfs/{fs_id}/snapshot

Create a snapshot. :param fs_id: The filesystem identifier. :param path: The path of the directory. :param name: The name of the snapshot. If not specified, a name using the current time in RFC3339 UTC format will be generated. :return: The name of the snapshot. :rtype: str

Parameters:

  • fs_id (string) --

Example request:

POST /api/cephfs/{fs_id}/snapshot HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string",
    "path": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/{fs_id}/statfs

Get Cephfs statfs of the specified path

Get the statfs of the specified path. :param fs_id: The filesystem identifier. :param path: The path of the directory/file. :return: Returns a dictionary containing ‘bytes’, ‘files’ and ‘subdirs’. :rtype: dict

Parameters:

  • fs_id (string) -- File System Identifier

Query Parameters:

  • path (string) -- File System Path (Required)

Example request:

GET /api/cephfs/{fs_id}/statfs?path=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "bytes": 1,
    "files": 1,
    "subdirs": 1
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/{fs_id}/tree

Remove a directory. :param fs_id: The filesystem identifier. :param path: The path of the directory.

Parameters:

  • fs_id (string) --

Query Parameters:

  • path (string) -- (Required)

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cephfs/{fs_id}/tree

Create a directory. :param fs_id: The filesystem identifier. :param path: The path of the directory.

Parameters:

  • fs_id (string) --

Example request:

POST /api/cephfs/{fs_id}/tree HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "path": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/{fs_id}/unlink

Removes a file, link, or symbolic link. :param fs_id: The filesystem identifier. :param path: The path of the file or link to unlink.

Parameters:

  • fs_id (string) --

Query Parameters:

  • path (string) -- (Required)

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cephfs/{fs_id}/write_to_file

Write some data to the specified path. :param fs_id: The filesystem identifier. :param path: The path of the file to write. :param buf: The str to write to the buf.

Parameters:

  • fs_id (string) --

Example request:

POST /api/cephfs/{fs_id}/write_to_file HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "buf": "string",
    "path": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

CephfsMirror

POST /api/cephfs/mirror

Create bootstrap peer

Example request:

POST /api/cephfs/mirror HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "fs_name": "string",
    "token": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/mirror/daemon-status

Get mirror daemon and peers information

Example request:

GET /api/cephfs/mirror/daemon-status HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "daemon_id": 1,
        "filesystems": [
            {
                "directory_count": 1,
                "filesystem_id": 1,
                "name": "string",
                "peers": [
                    {
                        "remote": {
                            "client_name": "string",
                            "cluster_name": "string",
                            "fs_name": "string"
                        },
                        "stats": {
                            "failure_count": 1,
                            "recovery_count": 1
                        },
                        "uuid": "string"
                    }
                ]
            }
        ]
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cephfs/mirror/token

Create bootstrap token

Example request:

POST /api/cephfs/mirror/token HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "client_name": "string",
    "fs_name": "string",
    "site_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/mirror/{fs_name}

Get peers

Parameters:

  • fs_name (string) -- File system name

Example request:

GET /api/cephfs/mirror/{fs_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "uuid": {
            "client_name": "string",
            "fs_name": "string",
            "site_name": "string"
        }
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/mirror/{fs_name}/{peer_uuid}

Delete peer

Parameters:

  • fs_name (string) -- File system name

  • peer_uuid (string) -- Peer UUID

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

CephfsSnapshotClone

POST /api/cephfs/subvolume/snapshot/clone

Create a clone of a subvolume snapshot

Example request:

POST /api/cephfs/subvolume/snapshot/clone HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "clone_name": "string",
    "group_name": "string",
    "snap_name": "string",
    "subvol_name": "string",
    "target_group_name": "string",
    "vol_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

CephfsSubvolumeGroup

POST /api/cephfs/subvolume/group

Example request:

POST /api/cephfs/subvolume/group HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "group_name": "string",
    "vol_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/subvolume/group/{vol_name}
Parameters:

  • vol_name (string) --

Query Parameters:

  • group_name (string) -- (Required)

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/subvolume/group/{vol_name}
Parameters:

  • vol_name (string) --

Query Parameters:

  • info (boolean) --

Example request:

GET /api/cephfs/subvolume/group/{vol_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cephfs/subvolume/group/{vol_name}
Parameters:

  • vol_name (string) --

Example request:

PUT /api/cephfs/subvolume/group/{vol_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "group_name": "string",
    "size": 1
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/subvolume/group/{vol_name}/info
Parameters:

  • vol_name (string) --

Query Parameters:

  • group_name (string) -- (Required)

Example request:

GET /api/cephfs/subvolume/group/{vol_name}/info?group_name=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

CephfsSubvolumeSnapshot

POST /api/cephfs/subvolume/snapshot

Example request:

POST /api/cephfs/subvolume/snapshot HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "group_name": "string",
    "snap_name": "string",
    "subvol_name": "string",
    "vol_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}
Parameters:

  • vol_name (string) --

  • subvol_name (string) --

Query Parameters:

  • snap_name (string) -- (Required)

  • group_name (string) --

  • force (boolean) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}
Parameters:

  • vol_name (string) --

  • subvol_name (string) --

Query Parameters:

  • group_name (string) --

  • info (boolean) --

Example request:

GET /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}/info
Parameters:

  • vol_name (string) --

  • subvol_name (string) --

Query Parameters:

  • snap_name (string) -- (Required)

  • group_name (string) --

Example request:

GET /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}/info?snap_name=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Cluster

GET /api/cluster

Get the cluster status

Example request:

GET /api/cluster HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cluster

Update the cluster status

Example request:

PUT /api/cluster HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "status": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cluster/user

Get list of ceph users

Get list of ceph users and its associated data

Example request:

GET /api/cluster/user HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cluster/user

Create Ceph User

Add a Ceph user, with its defined capabilities.

Example request:

POST /api/cluster/user HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "capabilities": [
        {
            "cap": "string",
            "entity": "string"
        }
    ],
    "import_data": "string",
    "user_entity": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cluster/user

Edit Ceph User Capabilities

Change the ceph user capabilities. Setting new capabilities will overwrite current ones.

Example request:

PUT /api/cluster/user HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "capabilities": [
        {
            "cap": "string",
            "entity": "string"
        }
    ],
    "user_entity": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cluster/user/export

Export Ceph Users

Example request:

POST /api/cluster/user/export HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "entities": [
        "string"
    ]
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cluster/user/{user_entities}

Delete one or more Ceph Users

Delete one or more ceph users and their defined capabilities. user_entities: comma-separated string of users to delete

Parameters:

  • user_entities (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

ClusterConfiguration

GET /api/cluster_conf

Example request:

GET /api/cluster_conf HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cluster_conf

Create/Update Cluster Configuration

Example request:

POST /api/cluster_conf HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "force_update": true,
    "name": "string",
    "value": [
        {
            "section": "string",
            "value": "string"
        }
    ]
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cluster_conf

Example request:

PUT /api/cluster_conf HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "options": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cluster_conf/filter

Get Cluster Configuration by name

Query Parameters:

  • names (string) -- Config option names

Example request:

GET /api/cluster_conf/filter HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "can_update_at_runtime": true,
        "daemon_default": "string",
        "default": "string",
        "desc": "string",
        "enum_values": [
            "string"
        ],
        "flags": [
            "string"
        ],
        "level": "string",
        "long_desc": "string",
        "max": "string",
        "min": "string",
        "name": "string",
        "see_also": [
            "string"
        ],
        "services": [
            "string"
        ],
        "tags": [
            "string"
        ],
        "type": "string"
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/cluster_conf/{name}
Parameters:

  • name (string) --

Query Parameters:

  • section (string) -- (Required)

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cluster_conf/{name}
Parameters:

  • name (string) --

Example request:

GET /api/cluster_conf/{name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

CrushRule

GET /api/crush_rule

List Crush Rule Configuration

Example request:

GET /api/crush_rule HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "max_size": 1,
    "min_size": 1,
    "rule_id": 1,
    "rule_name": "string",
    "ruleset": 1,
    "steps": [
        {}
    ],
    "type": 1
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/crush_rule

Example request:

POST /api/crush_rule HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "device_class": "string",
    "failure_domain": "string",
    "name": "string",
    "pool_type": "string",
    "profile": "string",
    "root": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/crush_rule/{name}
Parameters:

  • name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/crush_rule/{name}
Parameters:

  • name (string) --

Example request:

GET /api/crush_rule/{name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Daemon

GET /api/daemon

List all daemons in the cluster. Also filter by the daemon types specified

param daemon_types:

List of daemon types to filter by.

return:

Returns list of daemons.

rtype:

list

Query Parameters:

  • daemon_types (string) --

Example request:

GET /api/daemon HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/daemon/{daemon_name}
Parameters:

  • daemon_name (string) --

Example request:

PUT /api/daemon/{daemon_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "action": "string",
    "container_image": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

ErasureCodeProfile

GET /api/erasure_code_profile

List Erasure Code Profile Information

Example request:

GET /api/erasure_code_profile HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "crush-failure-domain": "string",
        "k": 1,
        "m": 1,
        "name": "string",
        "plugin": "string",
        "technique": "string"
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/erasure_code_profile

Example request:

POST /api/erasure_code_profile HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/erasure_code_profile/{name}
Parameters:

  • name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/erasure_code_profile/{name}
Parameters:

  • name (string) --

Example request:

GET /api/erasure_code_profile/{name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

FeatureTogglesEndpoint

GET /api/feature_toggles

Get List Of Features

Example request:

GET /api/feature_toggles HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "cephfs": true,
    "dashboard": true,
    "iscsi": true,
    "mirroring": true,
    "nfs": true,
    "rbd": true,
    "rgw": true
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Grafana

POST /api/grafana/dashboards
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/grafana/url

List Grafana URL Instance

Example request:

GET /api/grafana/url HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "instance": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/grafana/validation/{params}
Parameters:

  • params (string) --

Example request:

GET /api/grafana/validation/{params} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Hardware

GET /api/hardware/summary

Retrieve a summary of the hardware health status

Get the health status of as many hardware categories, or all of them if none is given :param categories: The hardware type, all of them by default :param hostname: The host to retrieve from, all of them by default

Query Parameters:

  • categories (string) --

  • hostname (string) --

Example request:

GET /api/hardware/summary HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Health

GET /api/health/full

Get Cluster’s detailed health report

Example request:

GET /api/health/full HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/health/get_cluster_capacity

Example request:

GET /api/health/get_cluster_capacity HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/health/get_cluster_fsid

Example request:

GET /api/health/get_cluster_fsid HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/health/get_telemetry_status

Example request:

GET /api/health/get_telemetry_status HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/health/minimal

Get Cluster’s health report with lesser details

Example request:

GET /api/health/minimal HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "client_perf": {
        "read_bytes_sec": 1,
        "read_op_per_sec": 1,
        "recovering_bytes_per_sec": 1,
        "write_bytes_sec": 1,
        "write_op_per_sec": 1
    },
    "df": {
        "stats": {
            "total_avail_bytes": 1,
            "total_bytes": 1,
            "total_used_raw_bytes": 1
        }
    },
    "fs_map": {
        "filesystems": [
            {
                "mdsmap": {
                    "balancer": "string",
                    "btime": "string",
                    "compat": {
                        "compat": "string",
                        "incompat": "string",
                        "ro_compat": "string"
                    },
                    "created": "string",
                    "damaged": [
                        1
                    ],
                    "data_pools": [
                        1
                    ],
                    "enabled": true,
                    "epoch": 1,
                    "ever_allowed_features": 1,
                    "explicitly_allowed_features": 1,
                    "failed": [
                        1
                    ],
                    "flags": 1,
                    "fs_name": "string",
                    "in": [
                        1
                    ],
                    "info": "string",
                    "last_failure": 1,
                    "last_failure_osd_epoch": 1,
                    "max_file_size": 1,
                    "max_mds": 1,
                    "metadata_pool": 1,
                    "modified": "string",
                    "required_client_features": "string",
                    "root": 1,
                    "session_autoclose": 1,
                    "session_timeout": 1,
                    "standby_count_wanted": 1,
                    "stopped": [
                        1
                    ],
                    "tableserver": 1,
                    "up": "string"
                },
                "standbys": "string"
            }
        ]
    },
    "health": {
        "checks": "string",
        "mutes": "string",
        "status": "string"
    },
    "hosts": 1,
    "iscsi_daemons": {
        "down": 1,
        "up": 1
    },
    "mgr_map": {
        "active_name": "string",
        "standbys": "string"
    },
    "mon_status": {
        "monmap": {
            "mons": "string"
        },
        "quorum": [
            1
        ]
    },
    "osd_map": {
        "osds": [
            {
                "in": 1,
                "up": 1
            }
        ]
    },
    "pg_info": {
        "object_stats": {
            "num_object_copies": 1,
            "num_objects": 1,
            "num_objects_degraded": 1,
            "num_objects_misplaced": 1,
            "num_objects_unfound": 1
        },
        "pgs_per_osd": 1,
        "statuses": "string"
    },
    "pools": "string",
    "rgw": 1,
    "scrub_status": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/health/snapshot

Get a quick overview of cluster health at a moment, analogous to the ceph status command in CLI.

Example request:

GET /api/health/snapshot HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "fsid": "string",
    "fsmap": {
        "num_active": 1,
        "num_standbys": 1
    },
    "health": {
        "checks": {
            "<check_name>": {
                "muted": true,
                "severity": "string",
                "summary": {
                    "count": 1,
                    "message": "string"
                }
            }
        },
        "mutes": [
            "string"
        ],
        "status": "string"
    },
    "mgrmap": {
        "num_active": 1,
        "num_standbys": 1
    },
    "monmap": {
        "num_mons": 1,
        "quorum": [
            1
        ]
    },
    "num_hosts": 1,
    "num_hosts_available": 1,
    "num_iscsi_gateways": {
        "down": 1,
        "up": 1
    },
    "num_rgw_gateways": 1,
    "osdmap": {
        "in": 1,
        "num_osds": 1,
        "up": 1
    },
    "pgmap": {
        "bytes_total": 1,
        "bytes_used": 1,
        "num_pgs": 1,
        "num_pools": 1,
        "pgs_by_state": [
            {
                "count": 1,
                "state_name": "string"
            }
        ],
        "recovering_bytes_per_sec": 1
    }
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Host

GET /api/host

List Host Specifications

Query Parameters:

  • sources (string) -- Host Sources

  • facts (boolean) -- Host Facts

  • offset (integer) --

  • limit (integer) --

  • search (string) --

  • sort (string) --

  • include_service_instances (boolean) -- Include Service Instances

Example request:

GET /api/host HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "addr": "string",
    "ceph_version": "string",
    "hostname": "string",
    "labels": [
        "string"
    ],
    "service_instances": [
        {
            "count": 1,
            "type": "string"
        }
    ],
    "service_type": "string",
    "services": [
        {
            "id": "string",
            "type": "string"
        }
    ],
    "sources": {
        "ceph": true,
        "orchestrator": true
    },
    "status": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/host

Example request:

POST /api/host HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "addr": "string",
    "hostname": "string",
    "labels": [
        "string"
    ],
    "status": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/host/{hostname}
Parameters:

  • hostname (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/host/{hostname}

Get the specified host. :raises: cherrypy.HTTPError: If host not found.

Parameters:

  • hostname (string) --

Example request:

GET /api/host/{hostname} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/host/{hostname}

Update the specified host. Note, this is only supported when Ceph Orchestrator is enabled. :param hostname: The name of the host to be processed. :param update_labels: To update the labels. :param labels: List of labels. :param maintenance: Enter/Exit maintenance mode. :param force: Force enter maintenance mode. :param drain: Drain host

Parameters:

  • hostname (string) -- Hostname

Example request:

PUT /api/host/{hostname} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "drain": true,
    "force": true,
    "labels": [
        "string"
    ],
    "maintenance": true,
    "update_labels": true
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/host/{hostname}/daemons
Parameters:

  • hostname (string) --

Example request:

GET /api/host/{hostname}/daemons HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/host/{hostname}/devices
Parameters:

  • hostname (string) --

Example request:

GET /api/host/{hostname}/devices HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/host/{hostname}/identify_device

Identify a device by switching on the device light for N seconds. :param hostname: The hostname of the device to process. :param device: The device identifier to process, e.g. /dev/dm-0 or ABC1234DEF567-1R1234_ABC8DE0Q. :param duration: The duration in seconds how long the LED should flash.

Parameters:

  • hostname (string) --

Example request:

POST /api/host/{hostname}/identify_device HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "device": "string",
    "duration": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/host/{hostname}/inventory

Get inventory of a host

Parameters:

  • hostname (string) -- Hostname

Query Parameters:

  • refresh (string) -- Trigger asynchronous refresh

Example request:

GET /api/host/{hostname}/inventory HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "addr": "string",
    "devices": [
        {
            "available": true,
            "device_id": "string",
            "human_readable_type": "string",
            "lsm_data": {
                "errors": [
                    "string"
                ],
                "health": "string",
                "ledSupport": {
                    "FAILstatus": "string",
                    "FAILsupport": "string",
                    "IDENTstatus": "string",
                    "IDENTsupport": "string"
                },
                "linkSpeed": "string",
                "mediaType": "string",
                "rpm": "string",
                "serialNum": "string",
                "transport": "string"
            },
            "lvs": [
                {
                    "block_uuid": "string",
                    "cluster_fsid": "string",
                    "cluster_name": "string",
                    "name": "string",
                    "osd_fsid": "string",
                    "osd_id": "string",
                    "osdspec_affinity": "string",
                    "type": "string"
                }
            ],
            "osd_ids": [
                1
            ],
            "path": "string",
            "rejected_reasons": [
                "string"
            ],
            "sys_api": {
                "human_readable_size": "string",
                "locked": 1,
                "model": "string",
                "nr_requests": "string",
                "partitions": {
                    "partition_name": {
                        "holders": [
                            "string"
                        ],
                        "human_readable_size": "string",
                        "sectors": "string",
                        "sectorsize": 1,
                        "size": 1,
                        "start": "string"
                    }
                },
                "path": "string",
                "removable": "string",
                "rev": "string",
                "ro": "string",
                "rotational": "string",
                "sas_address": "string",
                "sas_device_handle": "string",
                "scheduler_mode": "string",
                "sectors": 1,
                "sectorsize": "string",
                "size": 1,
                "support_discard": "string",
                "vendor": "string"
            }
        }
    ],
    "labels": [
        "string"
    ],
    "name": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/host/{hostname}/smart
Parameters:

  • hostname (string) --

Example request:

GET /api/host/{hostname}/smart HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Iscsi

GET /api/iscsi/discoveryauth

Get Iscsi discoveryauth Details

Example request:

GET /api/iscsi/discoveryauth HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "mutual_password": "string",
        "mutual_user": "string",
        "password": "string",
        "user": "string"
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/iscsi/discoveryauth

Set Iscsi discoveryauth

Query Parameters:

  • user (string) -- Username (Required)

  • password (string) -- Password (Required)

  • mutual_user (string) -- Mutual UserName (Required)

  • mutual_password (string) -- Mutual Password (Required)

Example request:

PUT /api/iscsi/discoveryauth?user=string&password=string&mutual_user=string&mutual_password=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "mutual_password": "string",
    "mutual_user": "string",
    "password": "string",
    "user": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

IscsiTarget

GET /api/iscsi/target

Example request:

GET /api/iscsi/target HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/iscsi/target

Example request:

POST /api/iscsi/target HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "acl_enabled": "string",
    "auth": "string",
    "clients": "string",
    "disks": "string",
    "groups": "string",
    "portals": "string",
    "target_controls": "string",
    "target_iqn": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/iscsi/target/{target_iqn}
Parameters:

  • target_iqn (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/iscsi/target/{target_iqn}
Parameters:

  • target_iqn (string) --

Example request:

GET /api/iscsi/target/{target_iqn} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/iscsi/target/{target_iqn}
Parameters:

  • target_iqn (string) --

Example request:

PUT /api/iscsi/target/{target_iqn} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "acl_enabled": "string",
    "auth": "string",
    "clients": "string",
    "disks": "string",
    "groups": "string",
    "new_target_iqn": "string",
    "portals": "string",
    "target_controls": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Logs

GET /api/logs/all

Display Logs Configuration

Example request:

GET /api/logs/all HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "audit_log": [
        {
            "addrs": {
                "addrvec": [
                    {
                        "addr": "string",
                        "nonce": 1,
                        "type": "string"
                    }
                ]
            },
            "channel": "string",
            "message": "string",
            "name": "string",
            "priority": "string",
            "rank": "string",
            "seq": 1,
            "stamp": "string"
        }
    ],
    "clog": [
        "string"
    ]
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

MdsPerfCounter

GET /api/perf_counters/mds/{service_id}
Parameters:

  • service_id (string) --

Example request:

GET /api/perf_counters/mds/{service_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

MgrModule

GET /api/mgr/module

List Mgr modules

Get the list of managed modules. :return: A list of objects with the fields ‘enabled’, ‘name’ and ‘options’. :rtype: list

Example request:

GET /api/mgr/module HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "always_on": true,
        "enabled": true,
        "name": "string",
        "options": {
            "Option_name": {
                "default_value": 1,
                "desc": "string",
                "enum_allowed": [
                    "string"
                ],
                "flags": 1,
                "level": "string",
                "long_desc": "string",
                "max": "string",
                "min": "string",
                "name": "string",
                "see_also": [
                    "string"
                ],
                "tags": [
                    "string"
                ],
                "type": "string"
            }
        }
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/mgr/module/{module_name}

Retrieve the values of the persistent configuration settings. :param module_name: The name of the Ceph Mgr module. :type module_name: str :return: The values of the module options. :rtype: dict

Parameters:

  • module_name (string) --

Example request:

GET /api/mgr/module/{module_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/mgr/module/{module_name}

Set the values of the persistent configuration settings. :param module_name: The name of the Ceph Mgr module. :type module_name: str :param config: The values of the module options to be stored. :type config: dict

Parameters:

  • module_name (string) --

Example request:

PUT /api/mgr/module/{module_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "config": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/mgr/module/{module_name}/disable

Disable the specified Ceph Mgr module. :param module_name: The name of the Ceph Mgr module. :type module_name: str

Parameters:

  • module_name (string) --

Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/mgr/module/{module_name}/enable

Enable the specified Ceph Mgr module. :param module_name: The name of the Ceph Mgr module. :type module_name: str

Parameters:

  • module_name (string) --

Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/mgr/module/{module_name}/options

Get the module options of the specified Ceph Mgr module. :param module_name: The name of the Ceph Mgr module. :type module_name: str :return: The module options as list of dicts. :rtype: list

Parameters:

  • module_name (string) --

Example request:

GET /api/mgr/module/{module_name}/options HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

MgrPerfCounter

GET /api/perf_counters/mgr/{service_id}
Parameters:

  • service_id (string) --

Example request:

GET /api/perf_counters/mgr/{service_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

MonPerfCounter

GET /api/perf_counters/mon/{service_id}
Parameters:

  • service_id (string) --

Example request:

GET /api/perf_counters/mon/{service_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Monitor

GET /api/monitor

Get Monitor Details

Example request:

GET /api/monitor HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "in_quorum": [
        {
            "addr": "string",
            "name": "string",
            "priority": 1,
            "public_addr": "string",
            "public_addrs": {
                "addrvec": [
                    {
                        "addr": "string",
                        "nonce": 1,
                        "type": "string"
                    }
                ]
            },
            "rank": 1,
            "stats": {
                "num_sessions": [
                    1
                ]
            },
            "weight": 1
        }
    ],
    "mon_status": {
        "election_epoch": 1,
        "extra_probe_peers": [
            "string"
        ],
        "feature_map": {
            "client": [
                {
                    "features": "string",
                    "num": 1,
                    "release": "string"
                }
            ],
            "mds": [
                {
                    "features": "string",
                    "num": 1,
                    "release": "string"
                }
            ],
            "mgr": [
                {
                    "features": "string",
                    "num": 1,
                    "release": "string"
                }
            ],
            "mon": [
                {
                    "features": "string",
                    "num": 1,
                    "release": "string"
                }
            ]
        },
        "features": {
            "quorum_con": "string",
            "quorum_mon": [
                "string"
            ],
            "required_con": "string",
            "required_mon": [
                1
            ]
        },
        "monmap": {
            "created": "string",
            "epoch": 1,
            "features": {
                "optional": [
                    "string"
                ],
                "persistent": [
                    "string"
                ]
            },
            "fsid": "string",
            "min_mon_release": 1,
            "min_mon_release_name": "string",
            "modified": "string",
            "mons": [
                {
                    "addr": "string",
                    "name": "string",
                    "priority": 1,
                    "public_addr": "string",
                    "public_addrs": {
                        "addrvec": [
                            {
                                "addr": "string",
                                "nonce": 1,
                                "type": "string"
                            }
                        ]
                    },
                    "rank": 1,
                    "stats": {
                        "num_sessions": [
                            1
                        ]
                    },
                    "weight": 1
                }
            ]
        },
        "name": "string",
        "outside_quorum": [
            "string"
        ],
        "quorum": [
            1
        ],
        "quorum_age": 1,
        "rank": 1,
        "state": "string",
        "sync_provider": [
            "string"
        ]
    },
    "out_quorum": [
        1
    ]
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Multi-cluster

POST /api/multi-cluster/auth

Authenticate to a remote cluster

Example request:

POST /api/multi-cluster/auth HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "cluster_alias": "string",
    "hub_url": "string",
    "password": "string",
    "ssl_certificate": "string",
    "ssl_verify": true,
    "ttl": "string",
    "url": "string",
    "username": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/multi-cluster/check_token_status

Example request:

GET /api/multi-cluster/check_token_status HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/multi-cluster/delete_cluster/{cluster_name}/{cluster_user}
Parameters:

  • cluster_name (string) --

  • cluster_user (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/multi-cluster/edit_cluster

Example request:

PUT /api/multi-cluster/edit_cluster HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "cluster_alias": "string",
    "name": "string",
    "ssl_certificate": "string",
    "url": "string",
    "username": "string",
    "verify": true
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/multi-cluster/get_config

Example request:

GET /api/multi-cluster/get_config HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/multi-cluster/get_prometheus_api_url

Example request:

GET /api/multi-cluster/get_prometheus_api_url HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/multi-cluster/reconnect_cluster

Example request:

PUT /api/multi-cluster/reconnect_cluster HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "cluster_token": "string",
    "password": "string",
    "ssl_certificate": "string",
    "ssl_verify": true,
    "ttl": "string",
    "url": "string",
    "username": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/multi-cluster/security_config

Example request:

GET /api/multi-cluster/security_config HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/multi-cluster/set_config

Example request:

PUT /api/multi-cluster/set_config HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "config": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

NFS-Ganesha

GET /api/nfs-ganesha/cluster
Query Parameters:

  • info (boolean) --

Example request:

GET /api/nfs-ganesha/cluster HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nfs-ganesha/export

List all or cluster specific NFS-Ganesha exports

Query Parameters:

  • cluster_id (string) --

Example request:

GET /api/nfs-ganesha/export HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "access_type": "string",
        "clients": [
            {
                "access_type": "string",
                "addresses": [
                    "string"
                ],
                "squash": "string"
            }
        ],
        "cluster_id": "string",
        "export_id": 1,
        "fsal": {
            "fs_name": "string",
            "name": "string",
            "sec_label_xattr": "string",
            "user_id": "string"
        },
        "path": "string",
        "protocols": [
            1
        ],
        "pseudo": "string",
        "security_label": "string",
        "squash": "string",
        "transports": [
            "string"
        ]
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/nfs-ganesha/export

Creates a new NFS-Ganesha export

Example request:

POST /api/nfs-ganesha/export HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_type": "string",
    "clients": [
        {
            "access_type": "string",
            "addresses": [
                "string"
            ],
            "squash": "string"
        }
    ],
    "cluster_id": "string",
    "fsal": {
        "fs_name": "string",
        "name": "string",
        "sec_label_xattr": "string"
    },
    "path": "string",
    "protocols": [
        1
    ],
    "pseudo": "string",
    "security_label": "string",
    "squash": "string",
    "transports": [
        "string"
    ]
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{
    "access_type": "string",
    "clients": [
        {
            "access_type": "string",
            "addresses": [
                "string"
            ],
            "squash": "string"
        }
    ],
    "cluster_id": "string",
    "export_id": 1,
    "fsal": {
        "fs_name": "string",
        "name": "string",
        "sec_label_xattr": "string",
        "user_id": "string"
    },
    "path": "string",
    "protocols": [
        1
    ],
    "pseudo": "string",
    "security_label": "string",
    "squash": "string",
    "transports": [
        "string"
    ]
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/nfs-ganesha/export/{cluster_id}/{export_id}

Deletes an NFS-Ganesha export

Parameters:

  • cluster_id (string) -- Cluster identifier

  • export_id (integer) -- Export ID

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nfs-ganesha/export/{cluster_id}/{export_id}

Get an NFS-Ganesha export

Parameters:

  • cluster_id (string) -- Cluster identifier

  • export_id (string) -- Export ID

Example request:

GET /api/nfs-ganesha/export/{cluster_id}/{export_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "access_type": "string",
    "clients": [
        {
            "access_type": "string",
            "addresses": [
                "string"
            ],
            "squash": "string"
        }
    ],
    "cluster_id": "string",
    "export_id": 1,
    "fsal": {
        "fs_name": "string",
        "name": "string",
        "sec_label_xattr": "string",
        "user_id": "string"
    },
    "path": "string",
    "protocols": [
        1
    ],
    "pseudo": "string",
    "security_label": "string",
    "squash": "string",
    "transports": [
        "string"
    ]
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nfs-ganesha/export/{cluster_id}/{export_id}

Updates an NFS-Ganesha export

Parameters:

  • cluster_id (string) -- Cluster identifier

  • export_id (integer) -- Export ID

Example request:

PUT /api/nfs-ganesha/export/{cluster_id}/{export_id} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_type": "string",
    "clients": [
        {
            "access_type": "string",
            "addresses": [
                "string"
            ],
            "squash": "string"
        }
    ],
    "fsal": {
        "fs_name": "string",
        "name": "string",
        "sec_label_xattr": "string"
    },
    "path": "string",
    "protocols": [
        1
    ],
    "pseudo": "string",
    "security_label": "string",
    "squash": "string",
    "transports": [
        "string"
    ]
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "access_type": "string",
    "clients": [
        {
            "access_type": "string",
            "addresses": [
                "string"
            ],
            "squash": "string"
        }
    ],
    "cluster_id": "string",
    "export_id": 1,
    "fsal": {
        "fs_name": "string",
        "name": "string",
        "sec_label_xattr": "string",
        "user_id": "string"
    },
    "path": "string",
    "protocols": [
        1
    ],
    "pseudo": "string",
    "security_label": "string",
    "squash": "string",
    "transports": [
        "string"
    ]
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

NVMe-oF Gateway

GET /api/nvmeof/gateway

Get information about the NVMeoF gateway

Query Parameters:

  • gw_group (string) --

  • server_address (string) --

Example request:

GET /api/nvmeof/gateway HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nvmeof/gateway/group

Example request:

GET /api/nvmeof/gateway/group HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nvmeof/gateway/listener_info/{nqn}

Get NVMeoF gateway’s listeners info

Parameters:

  • nqn (string) --

Query Parameters:

  • gw_group (string) --

  • server_address (string) --

Example request:

GET /api/nvmeof/gateway/listener_info/{nqn} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nvmeof/gateway/log_level

Get NVMeoF gateway log level information

Query Parameters:

  • gw_group (string) --

  • server_address (string) --

Example request:

GET /api/nvmeof/gateway/log_level HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/gateway/log_level

Set NVMeoF gateway log levels

Example request:

PUT /api/nvmeof/gateway/log_level HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "gw_group": "string",
    "log_level": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nvmeof/gateway/stats

Get NVMeoF statistics for the gateway

Query Parameters:

  • gw_group (string) --

  • server_address (string) --

Example request:

GET /api/nvmeof/gateway/stats HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nvmeof/gateway/version

Get the version of the NVMeoF gateway

Query Parameters:

  • gw_group (string) --

  • server_address (string) --

Example request:

GET /api/nvmeof/gateway/version HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

NVMe-oF SPDK

GET /api/nvmeof/spdk/log_level

Get NVMeoF gateway spdk log levels

Query Parameters:

  • all_log_flags (string) --

  • gw_group (string) --

  • server_address (string) --

Example request:

GET /api/nvmeof/spdk/log_level HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/spdk/log_level

Set NVMeoF gateway spdk log levels

Example request:

PUT /api/nvmeof/spdk/log_level HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "extra_log_flags": "string",
    "gw_group": "string",
    "log_level": "string",
    "print_level": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/spdk/log_level/disable

Disable NVMeoF gateway spdk log

Example request:

PUT /api/nvmeof/spdk/log_level/disable HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "extra_log_flags": "string",
    "gw_group": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

NVMe-oF Subsystem

GET /api/nvmeof/subsystem

List all NVMeoF subsystems

Query Parameters:

  • gw_group (string) --

  • server_address (string) --

Example request:

GET /api/nvmeof/subsystem HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/nvmeof/subsystem

Create a new NVMeoF subsystem

Example request:

POST /api/nvmeof/subsystem HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dhchap_key": "string",
    "enable_ha": true,
    "gw_group": "string",
    "max_namespaces": 1,
    "no_group_append": 1,
    "nqn": "string",
    "serial_number": "string",
    "server_address": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/nvmeof/subsystem/{nqn}

Delete an existing NVMeoF subsystem

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

Query Parameters:

  • force (boolean) -- Force delete

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nvmeof/subsystem/{nqn}

Get information from a specific NVMeoF subsystem

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

Query Parameters:

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Example request:

GET /api/nvmeof/subsystem/{nqn} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

NVMe-oF Subsystem Connection

GET /api/nvmeof/subsystem/{nqn}/connection

List all NVMeoF Subsystem Connections

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

Query Parameters:

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Example request:

GET /api/nvmeof/subsystem/{nqn}/connection HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

NVMe-oF Subsystem Host Allowlist

GET /api/nvmeof/subsystem/{nqn}/host

List all allowed hosts for an NVMeoF subsystem

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

Query Parameters:

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Example request:

GET /api/nvmeof/subsystem/{nqn}/host HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/nvmeof/subsystem/{nqn}/host

Allow hosts to access an NVMeoF subsystem

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

Example request:

POST /api/nvmeof/subsystem/{nqn}/host HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dhchap_controller_key": "string",
    "dhchap_key": "string",
    "gw_group": "string",
    "host_nqn": "string",
    "psk": "string",
    "server_address": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/nvmeof/subsystem/{nqn}/host/{host_nqn}

Disallow hosts from accessing an NVMeoF subsystem

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • host_nqn (string) -- NVMeoF host NQN. Use “*” to disallow any host.

Query Parameters:

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/change_controller_key

Change host DH-HMAC-CHAP controller key

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • host_nqn (string) -- NVMeoF host NQN

Example request:

PUT /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/change_controller_key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dhchap_controller_key": "string",
    "gw_group": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/change_key

Change host DH-HMAC-CHAP key

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • host_nqn (string) -- NVMeoF host NQN

Example request:

PUT /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/change_key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dhchap_key": "string",
    "gw_group": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/del_controller_key

Delete host DH-HMAC-CHAP controller key

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • host_nqn (string) -- NVMeoF host NQN.

Example request:

PUT /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/del_controller_key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "gw_group": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/del_key

Delete host DH-HMAC-CHAP key

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • host_nqn (string) -- NVMeoF host NQN.

Example request:

PUT /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/del_key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "gw_group": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

NVMe-oF Subsystem Listener

GET /api/nvmeof/subsystem/{nqn}/listener

List all NVMeoF listeners

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

Query Parameters:

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Example request:

GET /api/nvmeof/subsystem/{nqn}/listener HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/nvmeof/subsystem/{nqn}/listener

Create a new NVMeoF listener

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

Example request:

POST /api/nvmeof/subsystem/{nqn}/listener HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "adrfam": 1,
    "gw_group": "string",
    "host_name": "string",
    "server_address": "string",
    "traddr": "string",
    "trsvcid": 1
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/nvmeof/subsystem/{nqn}/listener/{host_name}/{traddr}

Delete an existing NVMeoF listener

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • host_name (string) -- NVMeoF hostname

  • traddr (string) -- NVMeoF transport address

Query Parameters:

  • trsvcid (integer) -- NVMeoF transport service port

  • adrfam (integer) -- NVMeoF address family (0 - IPv4, 1 - IPv6)

  • force (boolean) --

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

NVMe-oF Subsystem Namespace

GET /api/nvmeof/subsystem/{nqn}/namespace

List all NVMeoF namespaces in a subsystem

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

Query Parameters:

  • nsid (string) -- NVMeoF Namespace ID to filter by

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Example request:

GET /api/nvmeof/subsystem/{nqn}/namespace HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/nvmeof/subsystem/{nqn}/namespace

Create a new NVMeoF namespace.

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

Example request:

POST /api/nvmeof/subsystem/{nqn}/namespace HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "block_size": 1,
    "create_image": true,
    "disable_auto_resize": "string",
    "force": true,
    "gw_group": "string",
    "load_balancing_group": 1,
    "location": "string",
    "no_auto_visible": true,
    "nsid": "string",
    "rados_namespace": "string",
    "rbd_image_name": "string",
    "rbd_image_size": 1,
    "rbd_pool": "string",
    "read_only": "string",
    "server_address": "string",
    "size": 1,
    "trash_image": true
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/nvmeof/subsystem/{nqn}/namespace/{nsid}

Delete an existing NVMeoF namespace

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Query Parameters:

  • force (string) -- Force remove the RBD image

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nvmeof/subsystem/{nqn}/namespace/{nsid}

Get info from specified NVMeoF namespace

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Query Parameters:

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Example request:

GET /api/nvmeof/subsystem/{nqn}/namespace/{nsid} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PATCH /api/nvmeof/subsystem/{nqn}/namespace/{nsid}

Update an existing NVMeoF namespace

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PATCH /api/nvmeof/subsystem/{nqn}/namespace/{nsid} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "gw_group": "string",
    "load_balancing_group": 1,
    "location": "string",
    "r_mbytes_per_second": 1,
    "rbd_image_size": 1,
    "rw_ios_per_second": 1,
    "rw_mbytes_per_second": 1,
    "server_address": "string",
    "trash_image": true,
    "w_mbytes_per_second": 1
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/add_host

Adds a host to the specified NVMeoF namespace

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/add_host HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "force": true,
    "gw_group": "string",
    "host_nqn": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/change_load_balancing_group

set the load balancing group for specified NVMeoF namespace

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/change_load_balancing_group HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "gw_group": "string",
    "load_balancing_group": 1,
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/change_visibility

changes the visibility of the specified NVMeoF namespace to all or selected hosts

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/change_visibility HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "auto_visible": true,
    "force": true,
    "gw_group": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/del_host

Removes a host from the specified NVMeoF namespace

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/del_host HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "gw_group": "string",
    "host_nqn": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/io_stats

Get IO stats from specified NVMeoF namespace

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Query Parameters:

  • gw_group (string) -- NVMeoF gateway group

  • server_address (string) -- NVMeoF gateway address

Example request:

GET /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/io_stats HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/refresh_size

refresh the specified NVMeoF namespace to current RBD image size

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/refresh_size HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "gw_group": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/resize

resize the specified NVMeoF namespace

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/resize HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "gw_group": "string",
    "rbd_image_size": 1,
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/set_auto_resize

Enable or disable namespace auto resize when RBD image is resized

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/set_auto_resize HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "auto_resize_enabled": true,
    "gw_group": "string",
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/set_qos

set QOS for specified NVMeoF namespace

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/set_qos HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "force": true,
    "gw_group": "string",
    "r_mbytes_per_second": 1,
    "rw_ios_per_second": 1,
    "rw_mbytes_per_second": 1,
    "server_address": "string",
    "w_mbytes_per_second": 1
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/set_rbd_trash_image

changes the trash image on delete of the specified NVMeoF namespace to all or selected hosts

Parameters:

  • nqn (string) -- NVMeoF subsystem NQN

  • nsid (string) -- NVMeoF Namespace ID

Example request:

PUT /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/set_rbd_trash_image HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "gw_group": "string",
    "rbd_trash_image_on_delete": true,
    "server_address": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

OSD

GET /api/osd
Query Parameters:

  • offset (integer) --

  • limit (integer) --

  • search (string) --

  • sort (string) --

Example request:

GET /api/osd HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/osd

Example request:

POST /api/osd HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "data": "string",
    "method": "string",
    "tracking_id": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/osd/flags

Display OSD Flags

Example request:

GET /api/osd/flags HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "list_of_flags": [
        "string"
    ]
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/osd/flags

Sets OSD flags for the entire cluster.

The recovery_deletes, sortbitwise and pglog_hardlimit flags cannot be unset. purged_snapshots cannot even be set. It is therefore required to at least include those four flags for a successful operation.

Example request:

PUT /api/osd/flags HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "flags": [
        "string"
    ]
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "list_of_flags": [
        "string"
    ]
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/osd/flags/individual

Displays individual OSD flags

Example request:

GET /api/osd/flags/individual HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "flags": [
        "string"
    ],
    "osd": 1
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/osd/flags/individual

Sets OSD flags for a subset of individual OSDs.

Updates flags (noout, noin, nodown, noup) for an individual subset of OSDs.

Example request:

PUT /api/osd/flags/individual HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "flags": {
        "nodown": true,
        "noin": true,
        "noout": true,
        "noup": true
    },
    "ids": [
        1
    ]
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "added": [
        "string"
    ],
    "ids": [
        1
    ],
    "removed": [
        "string"
    ]
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/osd/safe_to_delete
type ids:

int|[int]

Query Parameters:

  • svc_ids (string) -- (Required)

Example request:

GET /api/osd/safe_to_delete?svc_ids=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/osd/safe_to_destroy

Check If OSD is Safe to Destroy

type ids:

int|[int]

Query Parameters:

  • ids (string) -- OSD Service Identifier (Required)

Example request:

GET /api/osd/safe_to_destroy?ids=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "active": [
        1
    ],
    "is_safe_to_destroy": true,
    "missing_stats": [
        "string"
    ],
    "safe_to_destroy": [
        "string"
    ],
    "stored_pgs": [
        "string"
    ]
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/osd/settings

Example request:

GET /api/osd/settings HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/osd/{svc_id}
Parameters:

  • svc_id (string) --

Query Parameters:

  • preserve_id (string) --

  • force (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/osd/{svc_id}

Returns collected data about an OSD.

return:

Returns the requested data.

Parameters:

  • svc_id (string) --

Example request:

GET /api/osd/{svc_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/osd/{svc_id}
Parameters:

  • svc_id (string) --

Example request:

PUT /api/osd/{svc_id} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "device_class": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/osd/{svc_id}/destroy

Mark osd as being destroyed. Keeps the ID intact (allowing reuse), but removes cephx keys, config-key data and lockbox keys, rendering data permanently unreadable.

The osd must be marked down before being destroyed.

Parameters:

  • svc_id (string) --

Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/osd/{svc_id}/devices
Parameters:

  • svc_id (string) --

Example request:

GET /api/osd/{svc_id}/devices HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/osd/{svc_id}/histogram
return:

Returns the histogram data.

Parameters:

  • svc_id (string) --

Example request:

GET /api/osd/{svc_id}/histogram HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/osd/{svc_id}/mark

Mark OSD flags (out, in, down, lost, …)

Note: osd must be marked down before marking lost.

Parameters:

  • svc_id (string) -- SVC ID

Example request:

PUT /api/osd/{svc_id}/mark HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "action": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/osd/{svc_id}/purge

Note: osd must be marked down before removal.

Parameters:

  • svc_id (string) --

Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/osd/{svc_id}/reweight

Reweights the OSD temporarily.

Note that ‘ceph osd reweight’ is not a persistent setting. When an OSD gets marked out, the osd weight will be set to 0. When it gets marked in again, the weight will be changed to 1.

Because of this ‘ceph osd reweight’ is a temporary solution. You should only use it to keep your cluster running while you’re ordering more hardware.

Parameters:

  • svc_id (string) --

Example request:

POST /api/osd/{svc_id}/reweight HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "weight": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/osd/{svc_id}/scrub
Parameters:

  • svc_id (string) --

Query Parameters:

  • deep (boolean) --

Example request:

POST /api/osd/{svc_id}/scrub HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "deep": true
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/osd/{svc_id}/smart
Parameters:

  • svc_id (string) --

Example request:

GET /api/osd/{svc_id}/smart HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

OsdPerfCounter

GET /api/perf_counters/osd/{service_id}
Parameters:

  • service_id (string) --

Example request:

GET /api/perf_counters/osd/{service_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PerfCounters

GET /api/perf_counters

Display Perf Counters

Example request:

GET /api/perf_counters HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "mon.a": {
        ".cache_bytes": {
            "description": "string",
            "nick": "string",
            "priority": 1,
            "type": 1,
            "units": 1,
            "value": 1
        }
    }
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Pool

GET /api/pool

Display Pool List

Query Parameters:

  • attrs (string) -- Pool Attributes

  • stats (boolean) -- Pool Stats

Example request:

GET /api/pool HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "application_metadata": [
            "string"
        ],
        "auid": 1,
        "cache_min_evict_age": 1,
        "cache_min_flush_age": 1,
        "cache_mode": "string",
        "cache_target_dirty_high_ratio_micro": 1,
        "cache_target_dirty_ratio_micro": 1,
        "cache_target_full_ratio_micro": 1,
        "create_time": "string",
        "crush_rule": "string",
        "erasure_code_profile": "string",
        "expected_num_objects": 1,
        "fast_read": true,
        "flags": 1,
        "flags_names": "string",
        "grade_table": [
            "string"
        ],
        "hit_set_count": 1,
        "hit_set_grade_decay_rate": 1,
        "hit_set_params": {
            "type": "string"
        },
        "hit_set_period": 1,
        "hit_set_search_last_n": 1,
        "last_change": "string",
        "last_force_op_resend": "string",
        "last_force_op_resend_preluminous": "string",
        "last_force_op_resend_prenautilus": "string",
        "last_pg_merge_meta": {
            "last_epoch_clean": 1,
            "last_epoch_started": 1,
            "ready_epoch": 1,
            "source_pgid": "string",
            "source_version": "string",
            "target_version": "string"
        },
        "min_read_recency_for_promote": 1,
        "min_size": 1,
        "min_write_recency_for_promote": 1,
        "object_hash": 1,
        "options": {
            "pg_num_max": 1,
            "pg_num_min": 1
        },
        "pg_autoscale_mode": "string",
        "pg_num": 1,
        "pg_num_pending": 1,
        "pg_num_target": 1,
        "pg_placement_num": 1,
        "pg_placement_num_target": 1,
        "pool": 1,
        "pool_name": "string",
        "pool_snaps": [
            "string"
        ],
        "quota_max_bytes": 1,
        "quota_max_objects": 1,
        "read_tier": 1,
        "removed_snaps": [
            "string"
        ],
        "size": 1,
        "snap_epoch": 1,
        "snap_mode": "string",
        "snap_seq": 1,
        "stripe_width": 1,
        "target_max_bytes": 1,
        "target_max_objects": 1,
        "tier_of": 1,
        "tiers": [
            "string"
        ],
        "type": "string",
        "use_gmt_hitset": true,
        "write_tier": 1
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/pool

Example request:

POST /api/pool HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "pool": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/pool/{pool_name}
Parameters:

  • pool_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/pool/{pool_name}
Parameters:

  • pool_name (string) --

Query Parameters:

  • attrs (string) --

  • stats (boolean) --

Example request:

GET /api/pool/{pool_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/pool/{pool_name}
Parameters:

  • pool_name (string) --

Example request:

PUT /api/pool/{pool_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "application_metadata": "string",
    "configuration": "string",
    "flags": "string",
    "rbd_mirroring": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/pool/{pool_name}/configuration
Parameters:

  • pool_name (string) --

Example request:

GET /api/pool/{pool_name}/configuration HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Prometheus

GET /api/prometheus
Query Parameters:

  • cluster_filter (boolean) --

Example request:

GET /api/prometheus HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/prometheus/alertgroup
Query Parameters:

  • cluster_filter (boolean) --

Example request:

GET /api/prometheus/alertgroup HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/prometheus/data

Example request:

GET /api/prometheus/data HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/prometheus/prometheus_query_data

Example request:

GET /api/prometheus/prometheus_query_data HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/prometheus/rules

Example request:

GET /api/prometheus/rules HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/prometheus/silence
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/prometheus/silence/{s_id}
Parameters:

  • s_id (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/prometheus/silences

Example request:

GET /api/prometheus/silences HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PrometheusNotifications

GET /api/prometheus/notifications

Example request:

GET /api/prometheus/notifications HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RGW

GET /api/rgw/roles

List RGW roles

Example request:

GET /api/rgw/roles HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/roles

Create RGW role

Example request:

POST /api/rgw/roles HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "role_assume_policy_doc": "string",
    "role_name": "string",
    "role_path": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/roles

Edit RGW role

Example request:

PUT /api/rgw/roles HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "max_session_duration": "string",
    "role_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/roles/{role_name}

Delete RGW role

Parameters:

  • role_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RGW Topic Management

GET /api/rgw/topic

Get RGW Topic List

Example request:

GET /api/rgw/topic HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/topic

Create a new RGW Topic

Example request:

POST /api/rgw/topic HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "ack_level": "string",
    "amqp_exchange": "string",
    "ca_location": "string",
    "cloud_events": "string",
    "daemon_name": "string",
    "kafka_brokers": "string",
    "max_retries": "string",
    "mechanism": "string",
    "name": "string",
    "opaque_data": "string",
    "owner": "string",
    "persistent": true,
    "policy": "string",
    "push_endpoint": "string",
    "retry_sleep_duration": "string",
    "time_to_live": "string",
    "use_ssl": true,
    "verify_ssl": true
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/topic/{key}

Delete RGW Topic

Parameters:

  • key (string) -- The metadata object key to retrieve the topic e.g topic:topic_name

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/topic/{key}

Get RGW Topic

Parameters:

  • key (string) -- The metadata object key to retrieve the topic e.g owner:topic_name

Example request:

GET /api/rgw/topic/{key} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Rbd

GET /api/block/image

Display Rbd Images

Query Parameters:

  • pool_name (string) -- Pool Name

  • offset (integer) -- offset

  • limit (integer) -- limit

  • search (string) --

  • sort (string) --

Example request:

GET /api/block/image HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "pool_name": "string",
        "value": [
            "string"
        ]
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/image

Example request:

POST /api/block/image HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "configuration": "string",
    "data_pool": "string",
    "features": "string",
    "metadata": "string",
    "mirror_mode": "string",
    "name": "string",
    "namespace": "string",
    "obj_size": 1,
    "pool_name": "string",
    "schedule_interval": "string",
    "size": 1,
    "stripe_count": 1,
    "stripe_unit": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/block/image/clone_format_version

Return the RBD clone format version.

Example request:

GET /api/block/image/clone_format_version HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/block/image/default_features

Example request:

GET /api/block/image/default_features HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/block/image/{image_spec}
Parameters:

  • image_spec (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/block/image/{image_spec}

Get Rbd Image Info

Parameters:

  • image_spec (string) -- URL-encoded “pool/rbd_name”. e.g. “rbd%2Ffoo”

Query Parameters:

  • omit_usage (boolean) -- When true, usage information is not returned

Example request:

GET /api/block/image/{image_spec} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "pool_name": "string",
        "value": [
            "string"
        ]
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/block/image/{image_spec}
Parameters:

  • image_spec (string) --

Example request:

PUT /api/block/image/{image_spec} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "configuration": "string",
    "enable_mirror": "string",
    "features": "string",
    "force": true,
    "image_mirror_mode": "string",
    "metadata": "string",
    "mirror_mode": "string",
    "name": "string",
    "primary": "string",
    "remove_scheduling": true,
    "resync": true,
    "schedule_interval": "string",
    "schedule_level": "string",
    "size": 1
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/image/{image_spec}/copy
Parameters:

  • image_spec (string) --

Example request:

POST /api/block/image/{image_spec}/copy HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "configuration": "string",
    "data_pool": "string",
    "dest_image_name": "string",
    "dest_namespace": "string",
    "dest_pool_name": "string",
    "features": "string",
    "metadata": "string",
    "obj_size": 1,
    "snapshot_name": "string",
    "stripe_count": 1,
    "stripe_unit": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/image/{image_spec}/flatten
Parameters:

  • image_spec (string) --

Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/image/{image_spec}/move_trash
Move an image to the trash.

Images, even ones actively in-use by clones, can be moved to the trash and deleted at a later time.

Parameters:

  • image_spec (string) --

Example request:

POST /api/block/image/{image_spec}/move_trash HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "delay": 1
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdGroup

GET /api/block/pool/{pool_name}/group

List all RBD groups in a pool

Parameters:

  • pool_name (string) -- Name of the pool to list groups from

Query Parameters:

  • namespace (string) -- Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used.

Example request:

GET /api/block/pool/{pool_name}/group HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "group": "string",
        "num_images": 1
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/pool/{pool_name}/group

Create a new RBD group in the specified pool

Parameters:

  • pool_name (string) -- Name of the pool where the group will be created

Example request:

POST /api/block/pool/{pool_name}/group HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string",
    "namespace": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/block/pool/{pool_name}/group/{group_name}

Delete an RBD group. All images must be removed from the group first.

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Name of the group to delete

Query Parameters:

  • namespace (string) -- Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used.

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/block/pool/{pool_name}/group/{group_name}

Get details of a specific RBD group including its member images

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Name of the group to retrieve

Query Parameters:

  • namespace (string) -- Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used.

Example request:

GET /api/block/pool/{pool_name}/group/{group_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "images": [
        {}
    ]
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/block/pool/{pool_name}/group/{group_name}

Rename an existing RBD group

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Current name of the group

Example request:

PUT /api/block/pool/{pool_name}/group/{group_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "namespace": "string",
    "new_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/block/pool/{pool_name}/group/{group_name}/image

Remove an RBD image from a group. The image itself is not deleted.

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Name of the group to remove the image from

Query Parameters:

  • image_name (string) -- Name of the image to remove from the group (Required)

  • namespace (string) -- Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used.

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/pool/{pool_name}/group/{group_name}/image

Add an RBD image to a group. The image must be in the same pool and namespace.

Parameters:

  • pool_name (string) -- Name of the pool containing both the group and image

  • group_name (string) -- Name of the group to add the image to

Example request:

POST /api/block/pool/{pool_name}/group/{group_name}/image HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "image_name": "string",
    "namespace": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdGroupSnapshot

GET /api/block/pool/{pool_name}/group/{group_name}/snap

List all snapshots of an RBD group

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Name of the group to list snapshots for

Query Parameters:

  • namespace (string) -- Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used.

Example request:

GET /api/block/pool/{pool_name}/group/{group_name}/snap HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": "string",
        "name": "string",
        "namespace_type": 1,
        "state": 1
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/pool/{pool_name}/group/{group_name}/snap

Create a crash-consistent snapshot of all images in the group

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Name of the group to snapshot

Example request:

POST /api/block/pool/{pool_name}/group/{group_name}/snap HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "flags": 1,
    "namespace": "string",
    "snapshot_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/block/pool/{pool_name}/group/{group_name}/snap/{snapshot_name}

Delete a group snapshot. This removes the snapshot for all images in the group.

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Name of the group

  • snapshot_name (string) -- Name of the snapshot to delete

Query Parameters:

  • namespace (string) -- Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used.

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/block/pool/{pool_name}/group/{group_name}/snap/{snapshot_name}

Get detailed information about a specific group snapshot

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Name of the group

  • snapshot_name (string) -- Name of the snapshot to retrieve

Query Parameters:

  • namespace (string) -- Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used.

Example request:

GET /api/block/pool/{pool_name}/group/{group_name}/snap/{snapshot_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "string",
    "image_snap_name": "string",
    "image_snaps": [
        {}
    ],
    "name": "string",
    "namespace_type": 1,
    "state": 1
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/block/pool/{pool_name}/group/{group_name}/snap/{snapshot_name}

Rename a group snapshot

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Name of the group

  • snapshot_name (string) -- Current name of the snapshot

Example request:

PUT /api/block/pool/{pool_name}/group/{group_name}/snap/{snapshot_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "namespace": "string",
    "new_snap_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/pool/{pool_name}/group/{group_name}/snap/{snapshot_name}/rollback

Rollback all images in the group to their state at the time of the snapshot

Parameters:

  • pool_name (string) -- Name of the pool containing the group

  • group_name (string) -- Name of the group to rollback

  • snapshot_name (string) -- Name of the snapshot to rollback to

Example request:

POST /api/block/pool/{pool_name}/group/{group_name}/snap/{snapshot_name}/rollback HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "namespace": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdMirroring

GET /api/block/mirroring/site_name

Display Rbd Mirroring sitename

Example request:

GET /api/block/mirroring/site_name HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "site_name": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/block/mirroring/site_name

Example request:

PUT /api/block/mirroring/site_name HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "site_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdMirroringPoolBootstrap

POST /api/block/mirroring/pool/{pool_name}/bootstrap/peer
Parameters:

  • pool_name (string) --

Example request:

POST /api/block/mirroring/pool/{pool_name}/bootstrap/peer HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "direction": "string",
    "token": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/mirroring/pool/{pool_name}/bootstrap/token
Parameters:

  • pool_name (string) --

Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdMirroringPoolMode

GET /api/block/mirroring/pool/{pool_name}

Display Rbd Mirroring Summary

Parameters:

  • pool_name (string) -- Pool Name

Example request:

GET /api/block/mirroring/pool/{pool_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "mirror_mode": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/block/mirroring/pool/{pool_name}
Parameters:

  • pool_name (string) --

Example request:

PUT /api/block/mirroring/pool/{pool_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "mirror_mode": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdMirroringPoolPeer

GET /api/block/mirroring/pool/{pool_name}/peer
Parameters:

  • pool_name (string) --

Example request:

GET /api/block/mirroring/pool/{pool_name}/peer HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/mirroring/pool/{pool_name}/peer
Parameters:

  • pool_name (string) --

Example request:

POST /api/block/mirroring/pool/{pool_name}/peer HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "client_id": "string",
    "cluster_name": "string",
    "key": "string",
    "mon_host": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}
Parameters:

  • pool_name (string) --

  • peer_uuid (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}
Parameters:

  • pool_name (string) --

  • peer_uuid (string) --

Example request:

GET /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}
Parameters:

  • pool_name (string) --

  • peer_uuid (string) --

Example request:

PUT /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "client_id": "string",
    "cluster_name": "string",
    "key": "string",
    "mon_host": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdMirroringSummary

GET /api/block/mirroring/summary

Display Rbd Mirroring Summary

Example request:

GET /api/block/mirroring/summary HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "content_data": {
        "daemons": [
            "string"
        ],
        "image_error": [
            "string"
        ],
        "image_ready": [
            "string"
        ],
        "image_syncing": [
            "string"
        ],
        "pools": [
            {
                "health": "string",
                "health_color": "string",
                "mirror_mode": "string",
                "name": "string",
                "peer_uuids": [
                    "string"
                ]
            }
        ]
    },
    "site_name": "string",
    "status": 1
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/block/mirroring/{pool_name}/{image_name}/summary
Parameters:

  • pool_name (string) --

  • image_name (string) --

Example request:

GET /api/block/mirroring/{pool_name}/{image_name}/summary HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdNamespace

GET /api/block/pool/{pool_name}/namespace
Parameters:

  • pool_name (string) --

Example request:

GET /api/block/pool/{pool_name}/namespace HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/pool/{pool_name}/namespace
Parameters:

  • pool_name (string) --

Example request:

POST /api/block/pool/{pool_name}/namespace HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "namespace": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/block/pool/{pool_name}/namespace/{namespace}
Parameters:

  • pool_name (string) --

  • namespace (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdSnapshot

POST /api/block/image/{image_spec}/snap
Parameters:

  • image_spec (string) --

Example request:

POST /api/block/image/{image_spec}/snap HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "mirrorImageSnapshot": "string",
    "snapshot_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/block/image/{image_spec}/snap/{snapshot_name}
Parameters:

  • image_spec (string) --

  • snapshot_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/block/image/{image_spec}/snap/{snapshot_name}
Parameters:

  • image_spec (string) --

  • snapshot_name (string) --

Example request:

PUT /api/block/image/{image_spec}/snap/{snapshot_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "is_protected": true,
    "new_snap_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/image/{image_spec}/snap/{snapshot_name}/clone

Clones a snapshot to an image

Parameters:

  • image_spec (string) --

  • snapshot_name (string) --

Example request:

POST /api/block/image/{image_spec}/snap/{snapshot_name}/clone HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "child_image_name": "string",
    "child_namespace": "string",
    "child_pool_name": "string",
    "configuration": "string",
    "data_pool": "string",
    "features": "string",
    "metadata": "string",
    "obj_size": 1,
    "stripe_count": 1,
    "stripe_unit": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/image/{image_spec}/snap/{snapshot_name}/rollback
Parameters:

  • image_spec (string) --

  • snapshot_name (string) --

Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RbdTrash

GET /api/block/image/trash

Get RBD Trash Details by pool name

List all entries from trash.

Query Parameters:

  • pool_name (string) -- Name of the pool

Example request:

GET /api/block/image/trash HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "pool_name": "string",
        "status": 1,
        "value": [
            "string"
        ]
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/image/trash/purge

Remove all expired images from trash.

Query Parameters:

  • pool_name (string) --

Example request:

POST /api/block/image/trash/purge HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "pool_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/block/image/trash/{image_id_spec}
Delete an image from trash.

If image deferment time has not expired you can not removed it unless use force. But an actively in-use by clones or has snapshots can not be removed.

Parameters:

  • image_id_spec (string) --

Query Parameters:

  • force (boolean) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/block/image/trash/{image_id_spec}/restore

Restore an image from trash.

Parameters:

  • image_id_spec (string) --

Example request:

POST /api/block/image/trash/{image_id_spec}/restore HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "new_image_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Report

GET /api/feedback

List all issues details.

Example request:

GET /api/feedback HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/feedback

Create an issue. :param project: The affected ceph component. :param tracker: The tracker type. :param subject: The title of the issue. :param description: The description of the issue. :param api_key: Ceph tracker api key.

Example request:

POST /api/feedback HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "api_key": "string",
    "description": "string",
    "project": "string",
    "subject": "string",
    "tracker": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/feedback/api_key

Deletes Ceph tracker API key.

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/feedback/api_key

Returns Ceph tracker API key.

Example request:

GET /api/feedback/api_key HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/feedback/api_key

Sets Ceph tracker API key. :param api_key: The Ceph tracker API key.

Example request:

POST /api/feedback/api_key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "api_key": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwBucket

GET /api/rgw/bucket
Query Parameters:

  • stats (boolean) --

  • daemon_name (string) --

  • uid (string) --

Example request:

GET /api/rgw/bucket HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/bucket

Example request:

POST /api/rgw/bucket HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket": "string",
    "bucket_policy": "string",
    "canned_acl": "string",
    "daemon_name": "string",
    "encryption_state": "string",
    "encryption_type": "string",
    "key_id": "string",
    "lock_enabled": "string",
    "lock_mode": "string",
    "lock_retention_period_days": "string",
    "lock_retention_period_years": "string",
    "placement_target": "string",
    "replication": "string",
    "tags": "string",
    "uid": "string",
    "zonegroup": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/bucket/deleteEncryption
Query Parameters:

  • bucket_name (string) -- (Required)

  • daemon_name (string) --

  • owner (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/bucket/getEncryption
Query Parameters:

  • bucket_name (string) -- (Required)

  • daemon_name (string) --

  • owner (string) --

Example request:

GET /api/rgw/bucket/getEncryption?bucket_name=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/bucket/getEncryptionConfig
Query Parameters:

  • daemon_name (string) --

  • owner (string) --

Example request:

GET /api/rgw/bucket/getEncryptionConfig HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/bucket/lifecycle
Query Parameters:

  • bucket_name (string) --

  • daemon_name (string) --

  • owner (string) --

  • tenant (string) --

Example request:

GET /api/rgw/bucket/lifecycle HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/bucket/lifecycle

Example request:

PUT /api/rgw/bucket/lifecycle HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_name": "string",
    "daemon_name": "string",
    "lifecycle": "string",
    "owner": "string",
    "tenant": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/bucket/notification

Delete the bucket notification

Query Parameters:

  • bucket_name (string) -- (Required)

  • notification_id (string) -- (Required)

  • daemon_name (string) --

  • owner (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/bucket/notification

Get the bucket notification

Query Parameters:

  • bucket_name (string) -- (Required)

  • daemon_name (string) --

  • owner (string) --

Example request:

GET /api/rgw/bucket/notification?bucket_name=string HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/bucket/notification

Create or update the bucket notification

Example request:

PUT /api/rgw/bucket/notification HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_name": "string",
    "daemon_name": "string",
    "notification": "string",
    "owner": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/bucket/ratelimit

Get the bucket global rate limit

Example request:

GET /api/rgw/bucket/ratelimit HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/bucket/setEncryptionConfig

Example request:

PUT /api/rgw/bucket/setEncryptionConfig HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "config": "string",
    "daemon_name": "string",
    "encryption_type": "string",
    "kms_provider": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/bucket/{bucket}
Parameters:

  • bucket (string) --

Query Parameters:

  • daemon_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/bucket/{bucket}
Parameters:

  • bucket (string) --

Query Parameters:

  • daemon_name (string) --

Example request:

GET /api/rgw/bucket/{bucket} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/bucket/{bucket}
Parameters:

  • bucket (string) --

Example request:

PUT /api/rgw/bucket/{bucket} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_id": "string",
    "bucket_policy": "string",
    "canned_acl": "string",
    "daemon_name": "string",
    "encryption_state": "string",
    "encryption_type": "string",
    "key_id": "string",
    "lifecycle": "string",
    "lock_mode": "string",
    "lock_retention_period_days": "string",
    "lock_retention_period_years": "string",
    "mfa_delete": "string",
    "mfa_token_pin": "string",
    "mfa_token_serial": "string",
    "replication": "string",
    "tags": "string",
    "uid": "string",
    "versioning_state": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/bucket/{uid}/ratelimit

Get the bucket rate limit

Parameters:

  • uid (string) --

Example request:

GET /api/rgw/bucket/{uid}/ratelimit HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/bucket/{uid}/ratelimit

Update the bucket rate limit

Parameters:

  • uid (string) --

Example request:

PUT /api/rgw/bucket/{uid}/ratelimit HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "enabled": "string",
    "max_read_bytes": "string",
    "max_read_ops": "string",
    "max_write_bytes": "string",
    "max_write_ops": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwDaemon

GET /api/rgw/daemon

Display RGW Daemons

Example request:

GET /api/rgw/daemon HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": "string",
        "port": 1,
        "server_hostname": "string",
        "version": "string",
        "zone_name": "string",
        "zonegroup_name": "string"
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/daemon/set_multisite_config

Example request:

PUT /api/rgw/daemon/set_multisite_config HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "string",
    "realm_name": "string",
    "zone_name": "string",
    "zonegroup_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/daemon/{svc_id}
Parameters:

  • svc_id (string) --

Example request:

GET /api/rgw/daemon/{svc_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwMirrorPerfCounter

GET /api/perf_counters/rbd-mirror/{service_id}
Parameters:

  • service_id (string) --

Example request:

GET /api/perf_counters/rbd-mirror/{service_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwMultisite

PUT /api/rgw/multisite/sync-flow

Create or update the sync flow

Example request:

PUT /api/rgw/multisite/sync-flow HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_name": "string",
    "destination_zone": "string",
    "flow_id": "string",
    "flow_type": "string",
    "group_id": "string",
    "source_zone": "string",
    "zones": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/multisite/sync-flow/{flow_id}/{flow_type}/{group_id}

Remove the sync flow

Parameters:

  • flow_id (string) --

  • flow_type (string) --

  • group_id (string) --

Query Parameters:

  • source_zone (string) --

  • destination_zone (string) --

  • zones (string) --

  • bucket_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/multisite/sync-pipe

Create or update the sync pipe

Example request:

PUT /api/rgw/multisite/sync-pipe HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_name": "string",
    "destination_bucket": "string",
    "destination_zones": "string",
    "group_id": "string",
    "mode": "string",
    "pipe_id": "string",
    "source_bucket": "string",
    "source_zones": "string",
    "user": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/multisite/sync-pipe/{group_id}/{pipe_id}

Remove the sync pipe

Parameters:

  • group_id (string) --

  • pipe_id (string) --

Query Parameters:

  • source_zones (string) --

  • destination_zones (string) --

  • bucket_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/multisite/sync-policy

Get the sync policy

Query Parameters:

  • bucket_name (string) --

  • zonegroup_name (string) --

  • all_policy (string) --

Example request:

GET /api/rgw/multisite/sync-policy HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/multisite/sync-policy-group

Create the sync policy group

Example request:

POST /api/rgw/multisite/sync-policy-group HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_name": "string",
    "group_id": "string",
    "status": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/multisite/sync-policy-group

Update the sync policy group

Example request:

PUT /api/rgw/multisite/sync-policy-group HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_name": "string",
    "group_id": "string",
    "status": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/multisite/sync-policy-group/{group_id}

Remove the sync policy group

Parameters:

  • group_id (string) --

Query Parameters:

  • bucket_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/multisite/sync-policy-group/{group_id}

Get the sync policy group

Parameters:

  • group_id (string) --

Query Parameters:

  • bucket_name (string) --

Example request:

GET /api/rgw/multisite/sync-policy-group/{group_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/multisite/sync_status

Get the sync status

Query Parameters:

  • daemon_name (string) --

Example request:

GET /api/rgw/multisite/sync_status HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwPerfCounter

GET /api/perf_counters/rgw/{service_id}
Parameters:

  • service_id (string) --

Example request:

GET /api/perf_counters/rgw/{service_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwRealm

GET /api/rgw/realm
Query Parameters:

  • replicable (string) --

Example request:

GET /api/rgw/realm HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/realm

Example request:

POST /api/rgw/realm HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "default": "string",
    "realm_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/realm/get_all_realms_info

Example request:

GET /api/rgw/realm/get_all_realms_info HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/realm/get_realm_tokens

Example request:

GET /api/rgw/realm/get_realm_tokens HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/realm/import_realm_token

Example request:

POST /api/rgw/realm/import_realm_token HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "placement_spec": "string",
    "port": "string",
    "realm_token": "string",
    "zone_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/realm/{realm_name}
Parameters:

  • realm_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/realm/{realm_name}
Parameters:

  • realm_name (string) --

Example request:

GET /api/rgw/realm/{realm_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/realm/{realm_name}
Parameters:

  • realm_name (string) --

Example request:

PUT /api/rgw/realm/{realm_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "default": "string",
    "new_realm_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwSite

GET /api/rgw/site
Query Parameters:

  • query (string) --

  • daemon_name (string) --

Example request:

GET /api/rgw/site HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwUser

GET /api/rgw/user

Display RGW Users

Query Parameters:

  • daemon_name (string) --

  • detailed (boolean) -- If true, returns complete user details for each user. If false, returns only the list of usernames.

Example request:

GET /api/rgw/user HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "list_of_users": [
        "string"
    ]
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/user

Create a new RGW user.

Example request:

POST /api/rgw/user HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "string",
    "account_id": 1,
    "account_policies": 1,
    "account_root_user": 1,
    "daemon_name": "string",
    "display_name": "string",
    "email": "string",
    "generate_key": "string",
    "max_buckets": "string",
    "secret_key": "string",
    "suspended": "string",
    "system": "string",
    "uid": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/user/get_emails
Query Parameters:

  • daemon_name (string) --

Example request:

GET /api/rgw/user/get_emails HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/user/ratelimit

Get the user global rate limit

Example request:

GET /api/rgw/user/ratelimit HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/user/{uid}
Parameters:

  • uid (string) --

Query Parameters:

  • daemon_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/user/{uid}
Parameters:

  • uid (string) --

Query Parameters:

  • daemon_name (string) --

  • stats (boolean) --

Example request:

GET /api/rgw/user/{uid} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/user/{uid}

Update an existing RGW user.

Parameters:

  • uid (string) --

Example request:

PUT /api/rgw/user/{uid} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "account_id": 1,
    "account_policies": 1,
    "account_root_user": 1,
    "daemon_name": "string",
    "display_name": "string",
    "email": "string",
    "max_buckets": "string",
    "suspended": "string",
    "system": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/user/{uid}/capability
Parameters:

  • uid (string) --

Query Parameters:

  • type (string) -- (Required)

  • perm (string) -- (Required)

  • daemon_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/user/{uid}/capability
Parameters:

  • uid (string) --

Example request:

POST /api/rgw/user/{uid}/capability HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "string",
    "perm": "string",
    "type": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/user/{uid}/key
Parameters:

  • uid (string) --

Query Parameters:

  • key_type (string) --

  • subuser (string) --

  • access_key (string) --

  • daemon_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/user/{uid}/key
Parameters:

  • uid (string) --

Example request:

POST /api/rgw/user/{uid}/key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "string",
    "daemon_name": "string",
    "generate_key": "string",
    "key_type": "string",
    "secret_key": "string",
    "subuser": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/user/{uid}/quota
Parameters:

  • uid (string) --

Query Parameters:

  • daemon_name (string) --

Example request:

GET /api/rgw/user/{uid}/quota HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/user/{uid}/quota
Parameters:

  • uid (string) --

Example request:

PUT /api/rgw/user/{uid}/quota HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "string",
    "enabled": "string",
    "max_objects": "string",
    "max_size_kb": 1,
    "quota_type": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/user/{uid}/ratelimit

Get the user rate limit

Parameters:

  • uid (string) --

Example request:

GET /api/rgw/user/{uid}/ratelimit HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/user/{uid}/ratelimit

Update the user rate limit

Parameters:

  • uid (string) --

Example request:

PUT /api/rgw/user/{uid}/ratelimit HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "enabled": true,
    "max_read_bytes": 1,
    "max_read_ops": 1,
    "max_write_bytes": 1,
    "max_write_ops": 1
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/user/{uid}/subuser
Parameters:

  • uid (string) --

Example request:

POST /api/rgw/user/{uid}/subuser HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access": "string",
    "access_key": "string",
    "daemon_name": "string",
    "generate_secret": "string",
    "key_type": "string",
    "secret_key": "string",
    "subuser": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/user/{uid}/subuser/{subuser}
param purge_keys:

Set to False to do not purge the keys. Note, this only works for s3 subusers.

Parameters:

  • uid (string) --

  • subuser (string) --

Query Parameters:

  • purge_keys (string) --

  • daemon_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwUserAccounts

GET /api/rgw/accounts

List all account ids or all detailed account info based on the ‘detailed’ query parameter.

  • If detailed=True, returns detailed account info.

  • If detailed=False, returns only account ids.

Query Parameters:

  • daemon_name (string) --

  • detailed (boolean) --

Example request:

GET /api/rgw/accounts HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/accounts

Update RGW account info

Create an account

param account_name:

Account name

return:

Returns account resource.

rtype:

Dict[str, Any]

Example request:

POST /api/rgw/accounts HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "account_name": "string",
    "daemon_name": "string",
    "email": "string",
    "max_access_keys": 1,
    "max_buckets": 1,
    "max_group": 1,
    "max_roles": 1,
    "max_users": 1,
    "tenant": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/accounts/{account_id}

Delete RGW Account

Removes an account

param account_id:

account identifier

return:

None.

Parameters:

  • account_id (string) -- Account id

Query Parameters:

  • daemon_name (string) -- Name of the daemon

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/accounts/{account_id}

Get RGW Account by id

Get an account by account id

Parameters:

  • account_id (string) -- Account id

Query Parameters:

  • daemon_name (string) -- Name of the daemon

Example request:

GET /api/rgw/accounts/{account_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/accounts/{account_id}

Update RGW account info

Modifies an account

param account_id:

Account identifier

return:

Returns modified account resource.

rtype:

Dict[str, Any]

Parameters:

  • account_id (string) -- Account id

Example request:

PUT /api/rgw/accounts/{account_id} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "account_name": "string",
    "daemon_name": "string",
    "email": "string",
    "max_access_keys": 1,
    "max_buckets": 1,
    "max_group": 1,
    "max_roles": 1,
    "max_users": 1,
    "tenant": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/accounts/{account_id}/quota

Set RGW Account/Bucket quota

Modifies quota

param account_id:

Account identifier

param quota_type:

‘account’ or ‘bucket’

return:

Returns modified quota.

rtype:

Dict[str, Any]

Parameters:

  • account_id (string) -- Account id

Example request:

PUT /api/rgw/accounts/{account_id}/quota HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "enabled": "string",
    "max_objects": "string",
    "max_size": "string",
    "quota_type": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/accounts/{account_id}/quota/status

Enable/Disable RGW Account/Bucket quota

Enable/Disable quota

param account_id:

Account identifier

param quota_type:

‘account’ or ‘bucket’

param quota_status:

‘enable’ or ‘disable’

return:

Returns modified quota.

rtype:

Dict[str, Any]

Parameters:

  • account_id (string) -- Account id

Example request:

PUT /api/rgw/accounts/{account_id}/quota/status HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "quota_status": "string",
    "quota_type": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwZone

GET /api/rgw/zone

Example request:

GET /api/rgw/zone HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/zone

Example request:

POST /api/rgw/zone HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "string",
    "default": true,
    "master": true,
    "secret_key": "string",
    "tier_type": "string",
    "zone_endpoints": "string",
    "zone_name": "string",
    "zonegroup_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/zone/create_system_user

Example request:

PUT /api/rgw/zone/create_system_user HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "userName": "string",
    "zoneName": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/zone/get_all_zones_info

Example request:

GET /api/rgw/zone/get_all_zones_info HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/zone/get_pool_names

Example request:

GET /api/rgw/zone/get_pool_names HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/zone/get_user_list
Query Parameters:

  • zoneName (string) --

  • realmName (string) --

Example request:

GET /api/rgw/zone/get_user_list HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/zone/storage-class

Example request:

POST /api/rgw/zone/storage-class HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "compression": "string",
    "data_pool": "string",
    "placement_target": "string",
    "storage_class": "string",
    "zone_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/zone/storage-class

Example request:

PUT /api/rgw/zone/storage-class HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "compression": "string",
    "data_pool": "string",
    "placement_target": "string",
    "storage_class": "string",
    "zone_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/zone/{zone_name}
Parameters:

  • zone_name (string) --

Query Parameters:

  • delete_pools (string) -- (Required)

  • pools (string) --

  • zonegroup_name (string) --

  • realm_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/zone/{zone_name}
Parameters:

  • zone_name (string) --

Example request:

GET /api/rgw/zone/{zone_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/zone/{zone_name}
Parameters:

  • zone_name (string) --

Example request:

PUT /api/rgw/zone/{zone_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "string",
    "compression": "string",
    "data_extra_pool": "string",
    "data_pool": "string",
    "data_pool_class": "string",
    "default": "string",
    "index_pool": "string",
    "master": "string",
    "new_zone_name": "string",
    "placement_target": "string",
    "secret_key": "string",
    "storage_class": "string",
    "tier_type": "string",
    "zone_endpoints": "string",
    "zonegroup_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

RgwZonegroup

GET /api/rgw/zonegroup

Example request:

GET /api/rgw/zonegroup HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/zonegroup

Example request:

POST /api/rgw/zonegroup HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "default": "string",
    "master": "string",
    "realm_name": "string",
    "zonegroup_endpoints": "string",
    "zonegroup_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/zonegroup/get_all_zonegroups_info

Example request:

GET /api/rgw/zonegroup/get_all_zonegroups_info HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/zonegroup/get_placement_target_by_placement_id/{placement_id}
Parameters:

  • placement_id (string) --

Example request:

GET /api/rgw/zonegroup/get_placement_target_by_placement_id/{placement_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/rgw/zonegroup/storage-class

Example request:

POST /api/rgw/zonegroup/storage-class HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "placement_targets": "string",
    "zone_group": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/zonegroup/storage-class

Example request:

PUT /api/rgw/zonegroup/storage-class HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "placement_targets": "string",
    "zone_group": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/zonegroup/storage-class/{placement_id}/{storage_class}
Parameters:

  • placement_id (string) --

  • storage_class (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/rgw/zonegroup/{zonegroup_name}
Parameters:

  • zonegroup_name (string) --

Query Parameters:

  • delete_pools (string) -- (Required)

  • pools (string) --

  • realm_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/rgw/zonegroup/{zonegroup_name}
Parameters:

  • zonegroup_name (string) --

Example request:

GET /api/rgw/zonegroup/{zonegroup_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/rgw/zonegroup/{zonegroup_name}
Parameters:

  • zonegroup_name (string) --

Example request:

PUT /api/rgw/zonegroup/{zonegroup_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "add_zones": "string",
    "default": "string",
    "master": "string",
    "new_zonegroup_name": "string",
    "placement_targets": "string",
    "realm_name": "string",
    "remove_zones": "string",
    "zonegroup_endpoints": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Role

GET /api/role

Display Role list

Example request:

GET /api/role HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "description": "string",
        "name": "string",
        "scopes_permissions": {
            "cephfs": [
                "string"
            ]
        },
        "system": true
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/role

Example request:

POST /api/role HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "description": "string",
    "name": "string",
    "scopes_permissions": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/role/{name}
Parameters:

  • name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/role/{name}
Parameters:

  • name (string) --

Example request:

GET /api/role/{name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/role/{name}
Parameters:

  • name (string) --

Example request:

PUT /api/role/{name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "description": "string",
    "scopes_permissions": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/role/{name}/clone
Parameters:

  • name (string) --

Example request:

POST /api/role/{name}/clone HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "new_name": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

SMB

GET /api/smb/cluster

List smb clusters

List smb clusters

Example request:

GET /api/smb/cluster HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "auth_mode": "string",
        "cluster_id": "string",
        "custom_dns": [
            "string"
        ],
        "domain_settings": {
            "join_sources": [
                {
                    "ref": "string",
                    "source_type": "string"
                }
            ],
            "realm": "string"
        },
        "intent": "string",
        "placement": {
            "count": 1
        },
        "public_addrs": [
            {
                "address": "string",
                "destination": "string"
            }
        ],
        "resource_type": "string",
        "user_group_settings": [
            {
                "ref": "string",
                "source_type": "string"
            }
        ]
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/smb/cluster

Create smb cluster

Create an smb cluster

param cluster_resource:

Dict cluster data

return:

Returns cluster resource.

rtype:

Dict[str, Any]

Example request:

POST /api/smb/cluster HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "cluster_resource": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{
    "results": [
        {
            "resource": {
                "auth_mode": "string",
                "cluster_id": "string",
                "custom_dns": [
                    "string"
                ],
                "domain_settings": {
                    "join_sources": [
                        {
                            "ref": "string",
                            "source_type": "string"
                        }
                    ],
                    "realm": "string"
                },
                "intent": "string",
                "placement": {
                    "count": 1
                },
                "public_addrs": [
                    {
                        "address": "string",
                        "destination": "string"
                    }
                ],
                "resource_type": "string",
                "user_group_settings": [
                    {
                        "ref": "string",
                        "source_type": "string"
                    }
                ]
            },
            "state": "string",
            "success": true
        }
    ],
    "success": true
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/smb/cluster/{cluster_id}

Remove an smb cluster

Remove an smb cluster

param cluster_id:

Cluster identifier

return:

None.

Parameters:

  • cluster_id (string) -- Unique identifier for the cluster

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/smb/cluster/{cluster_id}

Get an smb cluster

Get an smb cluster by cluster id

Parameters:

  • cluster_id (string) -- Unique identifier for the cluster

Example request:

GET /api/smb/cluster/{cluster_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "auth_mode": "string",
    "cluster_id": "string",
    "custom_dns": [
        "string"
    ],
    "domain_settings": {
        "join_sources": [
            {
                "ref": "string",
                "source_type": "string"
            }
        ],
        "realm": "string"
    },
    "intent": "string",
    "placement": {
        "count": 1
    },
    "public_addrs": [
        {
            "address": "string",
            "destination": "string"
        }
    ],
    "resource_type": "string",
    "user_group_settings": [
        {
            "ref": "string",
            "source_type": "string"
        }
    ]
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/smb/joinauth

List smb join authorization resources

List all smb join auth resources

return:

Returns list of join auth.

rtype:

List[Dict]

Example request:

GET /api/smb/joinauth HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "auth": {
            "password": "string",
            "username": "string"
        },
        "auth_id": "string",
        "intent": "string",
        "linked_to_cluster": "string",
        "resource_type": "string"
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/smb/joinauth

Create smb join auth

Create smb join auth resource

return:

Returns join auth resource.

rtype:

Dict

Example request:

POST /api/smb/joinauth HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "join_auth": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{
    "results": [
        {
            "resource": {
                "auth": {
                    "password": "string",
                    "username": "string"
                },
                "auth_id": "string",
                "intent": "string",
                "linked_to_cluster": "string",
                "resource_type": "string"
            },
            "state": "string",
            "success": true
        }
    ],
    "success": true
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/smb/joinauth/{auth_id}

Delete smb join auth

Delete smb join auth resource

param auth_id:

Join Auth identifier

return:

None.

Parameters:

  • auth_id (string) -- auth_id

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/smb/joinauth/{auth_id}

Get smb join authorization resource

Get Join auth resource

return:

Returns join auth.

rtype:

Dict

Parameters:

  • auth_id (string) --

Example request:

GET /api/smb/joinauth/{auth_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "auth": {
        "password": "string",
        "username": "string"
    },
    "auth_id": "string",
    "intent": "string",
    "linked_to_cluster": "string",
    "resource_type": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/smb/share

List smb shares

List all smb shares or all shares for a given cluster

param cluster_id:

Dict containing cluster information

return:

Returns list of shares.

rtype:

List[Dict]

Query Parameters:

  • cluster_id (string) -- Unique identifier for the cluster

Example request:

GET /api/smb/share HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "browseable": true,
    "cephfs": {
        "path": "string",
        "provider": "string",
        "subvolume": "string",
        "subvolumegroup": "string",
        "volume": "string"
    },
    "cluster_id": "string",
    "intent": "string",
    "name": "string",
    "read_bw_limit": 1,
    "read_delay_max": 1,
    "read_iops_limit": 1,
    "readonly": true,
    "resource_type": "string",
    "share_id": "string",
    "write_bw_limit": 1,
    "write_delay_max": 1,
    "write_iops_limit": 1
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/smb/share

Create smb share

Create an smb share

param share_resource:

Dict share data

return:

Returns share resource.

rtype:

Dict[str, Any]

Example request:

POST /api/smb/share HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "share_resource": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{
    "results": [
        {
            "resource": {
                "browseable": true,
                "cephfs": {
                    "path": "string",
                    "provider": "string",
                    "subvolume": "string",
                    "subvolumegroup": "string",
                    "volume": "string"
                },
                "cluster_id": "string",
                "intent": "string",
                "name": "string",
                "read_bw_limit": 1,
                "read_delay_max": 1,
                "read_iops_limit": 1,
                "readonly": true,
                "resource_type": "string",
                "share_id": "string",
                "write_bw_limit": 1,
                "write_delay_max": 1,
                "write_iops_limit": 1
            },
            "state": "string",
            "success": true
        }
    ],
    "success": true
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/smb/share/qos

Update SMB share QoS rate limiting

Update QoS rate limit parameters for an SMB share. Omitted parameters are left unchanged. Use 0 to disable a limit.

Example request:

PUT /api/smb/share/qos HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "cluster_id": "string",
    "read_bw_limit": 1,
    "read_delay_max": 1,
    "read_iops_limit": 1,
    "share_id": "string",
    "write_bw_limit": 1,
    "write_delay_max": 1,
    "write_iops_limit": 1
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/smb/share/{cluster_id}/{share_id}

Remove an smb share

Remove an smb share from a given cluster

param cluster_id:

Cluster identifier

param share_id:

Share identifier

return:

None.

Parameters:

  • cluster_id (string) -- Unique identifier for the cluster

  • share_id (string) -- Unique identifier for the share

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/smb/share/{cluster_id}/{share_id}

Get an smb share

Get an smb share by cluster and share id

Parameters:

  • cluster_id (string) -- Unique identifier for the cluster

  • share_id (string) -- Unique identifier for the share

Example request:

GET /api/smb/share/{cluster_id}/{share_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "browseable": true,
    "cephfs": {
        "path": "string",
        "provider": "string",
        "subvolume": "string",
        "subvolumegroup": "string",
        "volume": "string"
    },
    "cluster_id": "string",
    "intent": "string",
    "name": "string",
    "read_bw_limit": 1,
    "read_delay_max": 1,
    "read_iops_limit": 1,
    "readonly": true,
    "resource_type": "string",
    "share_id": "string",
    "write_bw_limit": 1,
    "write_delay_max": 1,
    "write_iops_limit": 1
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/smb/usersgroups

List smb user resources

List all smb usersgroups resources

return:

Returns list of usersgroups

rtype:

List[Dict]

Example request:

GET /api/smb/usersgroups HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "intent": "string",
        "linked_to_cluster": "string",
        "resource_type": "string",
        "users_groups_id": "string",
        "values": {
            "groups": [
                {
                    "name": "string"
                }
            ],
            "users": [
                {
                    "name": "string",
                    "password": "string"
                }
            ]
        }
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/smb/usersgroups

Create smb usersgroups

Create smb usersgroups resource

return:

Returns usersgroups resource.

rtype:

Dict

Example request:

POST /api/smb/usersgroups HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "usersgroups": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{
    "results": [
        {
            "resource": {
                "results": [
                    {
                        "resource": {
                            "auth": {
                                "password": "string",
                                "username": "string"
                            },
                            "auth_id": "string",
                            "intent": "string",
                            "linked_to_cluster": "string",
                            "resource_type": "string"
                        },
                        "state": "string",
                        "success": true
                    }
                ],
                "success": true
            },
            "state": "string",
            "success": true
        }
    ],
    "success": true
}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/smb/usersgroups/{users_groups_id}

Delete smb join auth

Delete smb usersgroups resource

param users_group_id:

Users identifier

return:

None.

Parameters:

  • users_groups_id (string) -- users_groups_id

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/smb/usersgroups/{users_groups_id}

Get smb usersgroups authorization resource

Get Users and groups resource

return:

Returns join auth.

rtype:

Dict

Parameters:

  • users_groups_id (string) --

Example request:

GET /api/smb/usersgroups/{users_groups_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "intent": "string",
    "linked_to_cluster": "string",
    "resource_type": "string",
    "users_groups_id": "string",
    "values": {
        "groups": [
            {
                "name": "string"
            }
        ],
        "users": [
            {
                "name": "string",
                "password": "string"
            }
        ]
    }
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Service

GET /api/service
Query Parameters:

  • service_name (string) --

  • offset (integer) --

  • limit (integer) --

  • search (string) --

  • sort (string) --

Example request:

GET /api/service HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/service
param service_spec:

The service specification as JSON.

param service_name:

The service name, e.g. ‘alertmanager’.

return:

None

Example request:

POST /api/service HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "service_name": "string",
    "service_spec": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/service/certificate

List All Certificates

List all certificates configured in the cluster.

This endpoint returns a list of all certificates managed by certmgr, including both user-provided and cephadm-signed certificates.

param status:

Filter by certificate status. Valid values: ‘expired’, ‘expiring’, ‘valid’, ‘invalid’

param scope:

Filter by certificate scope. Valid values: ‘SERVICE’, ‘HOST’, ‘GLOBAL’

param service_type:

Filter by service type. Supports wildcards (e.g., ‘rgw*’)

param include_cephadm_signed:

If True, include cephadm-signed certificates. If False (default), only user-provided certificates are returned.

return:

List of certificate objects with their details

Query Parameters:

  • status (string) -- Filter by certificate status (e.g., “expired”, “expiring”, “valid”, “invalid”)

  • scope (string) -- Filter by certificate scope (e.g., “service”, “host”, “global”)

  • service_type (string) -- Filter by certificate type (e.g., “rgw*”)

  • include_cephadm_signed (boolean) -- Include cephadm-signed certificates in the list (default: False)

Example request:

GET /api/service/certificate HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "cert_name": "string",
        "common_name": "string",
        "days_to_expiration": 1,
        "expiry_date": "string",
        "issuer": "string",
        "scope": "string",
        "signed_by": "string",
        "status": "string",
        "target": "string"
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/service/certificate/root-ca

Get Root CA Certificate

Get the cephadm root CA certificate.

This endpoint returns the root Certificate Authority (CA) certificate used by cephadm to sign other certificates in the cluster.

return:

Dictionary with certificate field containing root CA certificate in PEM format

Example request:

GET /api/service/certificate/root-ca HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "certificate": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/service/certificate/{service_name}

Get detailed certificate information for a service.

param service_name:

The service name, e.g. ‘rgw.myzone’.

return:

Detailed certificate information including full certificate details

Parameters:

  • service_name (string) --

Example request:

GET /api/service/certificate/{service_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/service/known_types

Get a list of known service types, e.g. ‘alertmanager’, ‘node-exporter’, ‘osd’ or ‘rgw’.

Example request:

GET /api/service/known_types HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/service/{service_name}
param service_name:

The service name, e.g. ‘mds’ or ‘crash.foo’.

return:

None

Parameters:

  • service_name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/service/{service_name}
Parameters:

  • service_name (string) --

Example request:

GET /api/service/{service_name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/service/{service_name}
param service_spec:

The service specification as JSON.

param service_name:

The service name, e.g. ‘alertmanager’.

return:

None

Parameters:

  • service_name (string) --

Example request:

PUT /api/service/{service_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "service_spec": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/service/{service_name}/daemons
Parameters:

  • service_name (string) --

Example request:

GET /api/service/{service_name}/daemons HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Settings

GET /api/settings

Display Settings Information

Get the list of available options. :param names: A comma separated list of option names that should be processed. Defaults to None. :type names: None|str :return: A list of available options. :rtype: list[dict]

Query Parameters:

  • names (string) -- Name of Settings

Example request:

GET /api/settings HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "default": true,
        "name": "string",
        "type": "string",
        "value": true
    }
]

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/settings
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/settings/{name}
Parameters:

  • name (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/settings/{name}

Get the given option. :param name: The name of the option. :return: Returns a dict containing the name, type, default value and current value of the given option. :rtype: dict

Parameters:

  • name (string) --

Example request:

GET /api/settings/{name} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/settings/{name}
Parameters:

  • name (string) --

Example request:

PUT /api/settings/{name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "value": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Summary

GET /api/summary

Display Summary

Example request:

GET /api/summary HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "executing_tasks": [
        "string"
    ],
    "finished_tasks": [
        {
            "begin_time": "string",
            "duration": 1,
            "end_time": "string",
            "exception": "string",
            "metadata": {
                "pool": 1
            },
            "name": "string",
            "progress": 1,
            "ret_value": "string",
            "success": true
        }
    ],
    "have_mon_connection": "string",
    "health_status": "string",
    "mgr_host": "string",
    "mgr_id": "string",
    "rbd_mirroring": {
        "errors": 1,
        "warnings": 1
    },
    "version": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Task

GET /api/task

Display Tasks

Query Parameters:

  • name (string) -- Task Name

Example request:

GET /api/task HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "executing_tasks": "string",
    "finished_tasks": [
        {
            "begin_time": "string",
            "duration": 1,
            "end_time": "string",
            "exception": true,
            "metadata": {
                "pool": 1
            },
            "name": "string",
            "progress": 1,
            "ret_value": true,
            "success": true
        }
    ]
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

TcmuRunnerPerfCounter

GET /api/perf_counters/tcmu-runner/{service_id}
Parameters:

  • service_id (string) --

Example request:

GET /api/perf_counters/tcmu-runner/{service_id} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Telemetry

PUT /api/telemetry

Enables or disables sending data collected by the Telemetry module. :param enable: Enable or disable sending data :type enable: bool :param license_name: License string e.g. ‘sharing-1-0’ to make sure the user is aware of and accepts the license for sharing Telemetry data. :type license_name: string

Example request:

PUT /api/telemetry HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "enable": true,
    "license_name": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/telemetry/report

Get Detailed Telemetry report

Get Ceph and device report data :return: Ceph and device report data :rtype: dict

Example request:

GET /api/telemetry/report HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "device_report": "string",
    "report": {
        "balancer": {
            "active": true,
            "mode": "string"
        },
        "channels": [
            "string"
        ],
        "channels_available": [
            "string"
        ],
        "config": {
            "active_changed": [
                "string"
            ],
            "cluster_changed": [
                "string"
            ]
        },
        "crashes": [
            1
        ],
        "created": "string",
        "crush": {
            "bucket_algs": {
                "straw2": 1
            },
            "bucket_sizes": {
                "1": 1,
                "3": 1
            },
            "bucket_types": {
                "1": 1,
                "11": 1
            },
            "compat_weight_set": true,
            "device_classes": [
                1
            ],
            "num_buckets": 1,
            "num_devices": 1,
            "num_rules": 1,
            "num_types": 1,
            "num_weight_sets": 1,
            "tunables": {
                "allowed_bucket_algs": 1,
                "choose_local_fallback_tries": 1,
                "choose_local_tries": 1,
                "choose_total_tries": 1,
                "chooseleaf_descend_once": 1,
                "chooseleaf_stable": 1,
                "chooseleaf_vary_r": 1,
                "has_v2_rules": 1,
                "has_v3_rules": 1,
                "has_v4_buckets": 1,
                "has_v5_rules": 1,
                "legacy_tunables": 1,
                "minimum_required_version": "string",
                "optimal_tunables": 1,
                "profile": "string",
                "require_feature_tunables": 1,
                "require_feature_tunables2": 1,
                "require_feature_tunables3": 1,
                "require_feature_tunables5": 1,
                "straw_calc_version": 1
            }
        },
        "fs": {
            "count": 1,
            "feature_flags": {
                "enable_multiple": true,
                "ever_enabled_multiple": true
            },
            "filesystems": [
                1
            ],
            "num_standby_mds": 1,
            "total_num_mds": 1
        },
        "hosts": {
            "num": 1,
            "num_with_mds": 1,
            "num_with_mgr": 1,
            "num_with_mon": 1,
            "num_with_osd": 1
        },
        "leaderboard": true,
        "license": "string",
        "metadata": {
            "mon": {
                "arch": {
                    "x86_64": 1
                },
                "ceph_version": {
                    "ceph version 16.0.0-3151-gf202994fcf": 1
                },
                "cpu": {
                    "Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz": 1
                },
                "distro": {
                    "centos": 1
                },
                "distro_description": {
                    "CentOS Linux 8 (Core)": 1
                },
                "kernel_description": {
                    "#1 SMP Wed Jul 1 19:53:01 UTC 2020": 1
                },
                "kernel_version": {
                    "5.7.7-200.fc32.x86_64": 1
                },
                "os": {
                    "Linux": 1
                }
            },
            "osd": {
                "arch": {
                    "x86_64": 1
                },
                "ceph_version": {
                    "ceph version 16.0.0-3151-gf202994fcf": 1
                },
                "cpu": {
                    "Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz": 1
                },
                "distro": {
                    "centos": 1
                },
                "distro_description": {
                    "CentOS Linux 8 (Core)": 1
                },
                "kernel_description": {
                    "#1 SMP Wed Jul 1 19:53:01 UTC 2020": 1
                },
                "kernel_version": {
                    "5.7.7-200.fc32.x86_64": 1
                },
                "os": {
                    "Linux": 1
                },
                "osd_objectstore": {
                    "bluestore": 1
                },
                "rotational": {
                    "1": 1
                }
            }
        },
        "mon": {
            "count": 1,
            "features": {
                "optional": [
                    1
                ],
                "persistent": [
                    "string"
                ]
            },
            "ipv4_addr_mons": 1,
            "ipv6_addr_mons": 1,
            "min_mon_release": 1,
            "v1_addr_mons": 1,
            "v2_addr_mons": 1
        },
        "osd": {
            "cluster_network": true,
            "count": 1,
            "require_min_compat_client": "string",
            "require_osd_release": "string"
        },
        "pools": [
            {
                "cache_mode": "string",
                "erasure_code_profile": "string",
                "min_size": 1,
                "pg_autoscale_mode": "string",
                "pg_num": 1,
                "pgp_num": 1,
                "pool": 1,
                "size": 1,
                "target_max_bytes": 1,
                "target_max_objects": 1,
                "type": "string"
            }
        ],
        "rbd": {
            "mirroring_by_pool": [
                true
            ],
            "num_images_by_pool": [
                1
            ],
            "num_pools": 1
        },
        "report_id": "string",
        "report_timestamp": "string",
        "report_version": 1,
        "rgw": {
            "count": 1,
            "frontends": [
                "string"
            ],
            "zonegroups": 1,
            "zones": 1
        },
        "services": {
            "rgw": 1
        },
        "usage": {
            "pg_num": 1,
            "pools": 1,
            "total_avail_bytes": 1,
            "total_bytes": 1,
            "total_used_bytes": 1
        }
    }
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Upgrade

GET /api/cluster/upgrade

Get the available versions to upgrade

Query Parameters:

  • tags (boolean) -- Show all image tags

  • image (string) -- Ceph Image

  • show_all_versions (boolean) -- Show all available versions

Example request:

GET /api/cluster/upgrade HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cluster/upgrade/pause

Pause the cluster upgrade

Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cluster/upgrade/resume

Resume the cluster upgrade

Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/cluster/upgrade/start

Start the cluster upgrade

Example request:

POST /api/cluster/upgrade/start HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_types": "string",
    "host_placement": "string",
    "image": "string",
    "limit": "string",
    "services": "string",
    "version": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/cluster/upgrade/status

Get the cluster upgrade status

Example request:

GET /api/cluster/upgrade/status HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/cluster/upgrade/stop

Stop the cluster upgrade

Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

User

GET /api/user

Get List Of Users

Example request:

GET /api/user HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "email": "string",
    "enabled": true,
    "lastUpdate": 1,
    "name": "string",
    "pwdExpirationDate": "string",
    "pwdUpdateRequired": true,
    "roles": [
        "string"
    ],
    "username": "string"
}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

POST /api/user

Example request:

POST /api/user HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "email": "string",
    "enabled": true,
    "name": "string",
    "password": "string",
    "pwdExpirationDate": "string",
    "pwdUpdateRequired": true,
    "roles": "string",
    "username": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

DELETE /api/user/{username}
Parameters:

  • username (string) --

Status Codes:

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 204 No Content --

    Resource deleted.

    Example response:

    HTTP/1.1 204 No Content
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

GET /api/user/{username}
Parameters:

  • username (string) --

Example request:

GET /api/user/{username} HTTP/1.1
Host: example.com
Status Codes:

  • 200 OK --

    OK

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

PUT /api/user/{username}
Parameters:

  • username (string) --

Example request:

PUT /api/user/{username} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "email": "string",
    "enabled": "string",
    "name": "string",
    "password": "string",
    "pwdExpirationDate": "string",
    "pwdUpdateRequired": true,
    "roles": "string"
}
Status Codes:

  • 200 OK --

    Resource updated.

    Example response:

    HTTP/1.1 200 OK
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

UserChangePassword

POST /api/user/{username}/change_password
Parameters:

  • username (string) --

Example request:

POST /api/user/{username}/change_password HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "new_password": "string",
    "old_password": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

UserPasswordPolicy

POST /api/user/validate_password

Check if the password meets the password policy. :param password: The password to validate. :param username: The name of the user (optional). :param old_password: The old password (optional). :return: An object with properties valid, credits and valuation. ‘credits’ contains the password complexity credits and ‘valuation’ the textual summary of the validation.

Example request:

POST /api/user/validate_password HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "old_password": "string",
    "password": "string",
    "username": "string"
}
Status Codes:

  • 201 Created --

    Resource created.

    Example response:

    HTTP/1.1 201 Created
Content-Type: application/json

{}

  • 202 Accepted --

    Operation is still executing. Please check the task queue.

    Example response:

    HTTP/1.1 202 Accepted
Content-Type: application/json

{}

  • 400 Bad Request -- Operation exception. Please check the response body for details.

  • 401 Unauthorized -- Unauthenticated access. Please login first.

  • 403 Forbidden -- Unauthorized access. Please check your permissions.

  • 500 Internal Server Error -- Unexpected error. Please check the response body for the stack trace.

Brought to you by the Ceph Foundation

The Ceph Documentation is a community resource funded and hosted by the non-profit Ceph Foundation. If you would like to support this and our other efforts, please consider joining now.