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
{
"providers" : {
"296ebe3c20e9666dc489b647f8647f12" : 5368709120
},
"spaceId" : "f8d843beda24e54545455ecc0f4b8886",
"name" : "Test"
}
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.
| Property | Type & Description |
|---|---|
spaceId string Unique Id of the space. | |
name string The name of the space. | |
providers object A map of provider Ids supporting this space and corresponding size of provisioned storage in bytes. | |
Example
{
"spaceId": "2c0160248ba9a66f45da751ca459535a",
"name": "My Private space",
"providers": {
"296ebe3c20e9666dc489b647f8647f12": 5368709120,
"dcf12429647c204896eebe3b6f686967": 14400000
}
}Invalid request.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}