Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get summary of members in this cluster

GET /cluster/members_summary

Returns aggregated counts of users and groups belonging to this cluster.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE getClusterMembersSummary --host https://$HOST:9443

Responses

application/json

200

Members summary.

Property	Type & Description
usersCount integer Number of users belonging directly to the cluster.
effectiveUsersCount integer Number of users belonging directly and indirectly to the cluster.
groupsCount integer Number of groups belonging directly to the cluster.
effectiveGroupsCount integer Number of groups belonging directly and indirectly to the cluster.

400

Invalid request.

Property

Type & Description

error

object

Object describing an error.

id required string String identifying the error type. Does not change between error instances.
description required string Human readable error description. May contain information specific to given error instance.
details object Details about the error instance. The object schema is specific to each error type.

Example

application/json

{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}

401

Unauthorized request.

403

Forbidden request.

500

Internal server error.

Property

Type & Description

error

object

Object describing an error.

id required string String identifying the error type. Does not change between error instances.
description required string Human readable error description. May contain information specific to given error instance.
details object Details about the error instance. The object schema is specific to each error type.

Example

application/json

{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}