CEceph
SMB

List smb shares

Changed on 
    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]
get/api/smb/share

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/smb/share
  • Auth
    HTTP bearer

Query parameters

cluster_idstring

Unique identifier for the cluster

Response

OK

browseableboolean required

Indicates if the share is browseable

cluster_idstring required

Unique identifier for the cluster

intentstring required

Desired state of the resource, e.g., 'present' or 'removed'

namestring required

Name of the share

read_bw_limitinteger required

QoS: max read bandwidth B/s (0=disabled)

read_delay_maxinteger required

QoS: max read delay in seconds (0-300)

read_iops_limitinteger required

QoS: max read IOPS (0=disabled)

readonlyboolean required

Indicates if the share is read-only

resource_typestring required

ceph.smb.share

share_idstring required

Unique identifier for the share

write_bw_limitinteger required

QoS: max write bandwidth B/s (0=disabled)

write_delay_maxinteger required

QoS: max write delay in seconds (0-300)

write_iops_limitinteger required

QoS: max write IOPS (0=disabled)

Changes

  • d8047466225eRevision changes
    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/vnd.ceph.api.v1.0+json)

  • b6628a2527a6Revision changes
    • breaking

      removed the required property from the response with the status (media type: application/json)

    • breaking

      removed the required property from the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • breaking

      removed the required property from the response with the status (media type: application/json)

    • breaking

      removed the required property from the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • breaking

      removed the required property from the response with the status (media type: application/json)

    • breaking

      removed the required property from the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • breaking

      removed the required property from the response with the status (media type: application/json)

    • breaking

      removed the required property from the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • breaking

      removed the required property from the response with the status (media type: application/json)

    • breaking

      removed the required property from the response with the status (media type: application/vnd.ceph.api.v1.0+json)

    • breaking

      removed the required property from the response with the status (media type: application/json)

    • breaking

      removed the required property from the response with the status (media type: application/vnd.ceph.api.v1.0+json)