Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get cluster group details

GET /clusters/{id}/groups/{gid}

Returns details about a specific group in a cluster.

This operation requires cluster_view privilege. For administrators who do not have to be members of this cluster, oz_groups_view privilege is required.

Example cURL requests

Get cluster group details

curl -u username:password -X GET \
https://$ZONE_HOST/api/v3/onezone/clusters/$CLUSTER_ID/groups/$GROUP_ID

{
  "groupId": "f1c8b1a37aa7447b22eb65a742d40524",
  "name": "new_groupX",
  "type": "team"
}

Path parameters

Parameter	Type & Description
id required	string Cluster Id.
gid required	string Group Id.

Request Examples

Shell

onezone-rest-cli getClusterGroup id=b752ceafabb662b4e5728b2ded25cdd1 gid=f1c8b1a37aa7447b22eb65a742d40524

Responses

application/json

200

Details of a specific group in a cluster.

Property

Type & Description

groupId

string

Unique group Id.

name

string

The name of the group.

type

string

The type of the group.

Enum:

organization unit team role_holders

creator

object (Subject)

Object representing a subject in the system, can be perceived as client (actor) identity.

type

string

Type of the subject

Enum:

nobody user oneprovider

string

Id of the subject (null for nobody)

creationTime

integer (Timestamp)

Timestamp in seconds (UNIX epoch), e.g. 1563819329.

Example

application/json

{
  "groupId": "a4d3bc73aada63052310652d421609f1",
  "name": "Test group",
  "type": "team",
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}

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

Authentication 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."
  }
}

403

Authorization 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."
  }
}

404

Resource not found.

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."
  }
}

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."
  }
}