Get space details
Returns the details about a specific space.
This operation requires any of the following authentication:
- as user who is an effective member of the space (
{id}), - as provider that supports the space (
{id}), - as user who has
oz_spaces_viewadmin privilege.
Example cURL requests
Get space details
curl -u admin:password -X GET \
https://$ZONE_HOST/api/v3/onezone/spaces/$SPACE_ID
{
"spaceId": "2c0160248ba9a66f45da751ca459535a",
"name": "My Private space",
"description": "My Private data",
"organizationName": "",
"tags": ["images", "sport"],
"advertisedInMarketplace": false,
"marketplaceContactEmail": "",
"providers": {
"296ebe3c20e9666dc489b647f8647f12": 5368709120,
"dcf12429647c204896eebe3b6f686967": 14400000
},
"supportParametersRegistry": {
"296ebe3c20e9666dc489b647f8647f12": {
"accountingEnabled": false,
"dirStatsServiceEnabled": true,
"dirStatsServiceStatus": "enabled"
},
"dcf12429647c204896eebe3b6f686967": {
"accountingEnabled": false,
"dirStatsServiceEnabled": false,
"dirStatsServiceStatus": "stopping"
}
},
"shareCount": 58,
"creator": {
"type": "user",
"id": "7434b256e71e1052e0d5e3e9da657ebfc1a770c3"
},
"creationTime": 1576152793
}
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Space Id. |
Request Examples
onezone-rest-cli getSpace id=b752ceafabb662b4e5728b2ded25cdd1Responses
Information about a space.
Unique Id of the space.
The name of the space.
Space description in markdown (.md) format.
Name of the organization responsible for space management.
A list of short keywords or phrases that helps to understand the purpose of a space. Available space tags can be retrieved from the configuration endpoint.
Specifies whether the space should be publicly advertised in the Space Marketplace.
Email address that will be used for notifying the person responsible for space management in the Marketplace about new membership requests. This field is visible only to space members with both space_view and space_manage_in_marketplace privileges, otherwise an empty string is returned. Similarly, it can be modified only by users with the space_manage_in_marketplace privilege.
A map of provider Ids supporting this space and corresponding size of provisioned storage in bytes.
A map of provider Ids supporting this space and corresponding support parameters of the provider.
The total number of shares (including public data records) in this space.
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",
"description": "My Private data",
"organizationName": "",
"tags": [
"images",
"sport"
],
"advertisedInMarketplace": false,
"marketplaceContactEmail": "",
"providers": {
"296ebe3c20e9666dc489b647f8647f12": 5368709120,
"dcf12429647c204896eebe3b6f686967": 14400000
},
"supportParametersRegistry": {
"296ebe3c20e9666dc489b647f8647f12": {
"accountingEnabled": false,
"dirStatsServiceEnabled": true,
"dirStatsServiceStatus": "enabled"
},
"dcf12429647c204896eebe3b6f686967": {
"accountingEnabled": false,
"dirStatsServiceEnabled": false,
"dirStatsServiceStatus": "stopping"
}
},
"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."
}
}