Get effective space details
Returns information about a specific effective space to which the user has access.
This operation can be invoked on behalf of the current user only.
Example cURL requests
Get user effective space
curl -u username:password -X GET \
https://$HOST/api/v3/onezone/user/effective_spaces/$SPACE_ID
{
"spaceId": "2c0160248ba9a66f45da751ca459535a",
"name": "new_space1",
"providers": {
"296ebe3c20e9666dc489b647f8647f12" : 5368709120
},
"creator": {
"type": "user",
"id": "7434b256e71e1052e0d5e3e9da657ebfc1a770c3"
},
"creationTime": 1576152793
}
Path parameters
| Parameter | Type & Description |
|---|---|
| sid required | string Space Id. |
Request Examples
onezone-rest-cli getEffectiveUserSpace sid=95b663a6467c72ab1256865efef9e387Responses
Returns the information about a specific effective space.
Unique Id of the space.
The name of the space.
A map of provider Ids supporting this space and corresponding size of provisioned storage in bytes.
creator Object representing a subject in the system, can be perceived as client (actor) identity.
Object representing a subject in the system, can be perceived as client (actor) identity.
Type of the subject
Id of the subject (null for nobody)
Timestamp in seconds (UNIX epoch), e.g. 1563819329.
Example
{
"spaceId": "2c0160248ba9a66f45da751ca459535a",
"name": "My Private space",
"providers": {
"296ebe3c20e9666dc489b647f8647f12": 5368709120,
"dcf12429647c204896eebe3b6f686967": 14400000
},
"creator": {
"type": "user",
"id": "7434b256e71e1052e0d5e3e9da657ebf"
},
"creationTime": 1576152793
}Invalid request.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}