Getting Object Storage by ID
This section explains how to get object storage information by storage ID.
Request
GET https://<hostname>:4443/v5/ObjectStorageRepositories/{id} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Type | Description |
---|---|---|
id | string | An identification number of object storage. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
The response contains the following information.
Property | Type | Description |
---|---|---|
azureContainer | Contains a container or bucket definition. | |
azureFolder | string | Specifies storage folder when backups reside. |
id | string | Object storage identification number, |
name | string | Object storage name. |
description | string | Object storage description. |
accountId | string | An account identification number under which object storage is added. |
sizeLimitEnabled | boolean | Specifies if the size limit is set. |
sizeLimitGB | string | Specifies size limit in GB. |
usedSpaceGB | string | Specifies used space in GB. |
type | string | Object storage type. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
---|---|---|
name | string | A container name. |
regionType | string | A region type. |
Example
Request: GET https://abc.tech.local:4443/v5/ObjectStorageRepositories/abca7074-ca3d-4a43-af7a-a429b3a2265d
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "azureContainer": { "name": "container1", "regionType": "Global" }, "azureFolder": "Azure Storage", "id": "abca7074-ca3d-4a43-af7a-a429b3a2265d", "name": "Azure Object Storage", "description": "Secondary Backup Storage", "accountId": "db1befe9-f6cc-4e94-b473-7d6b4a52a6bf", "sizeLimitEnabled": false, "sizeLimitGB": 0, "usedSpaceGB": 0, "type": "AzureBlob", "_links": { "self": {"href": "https://abc.tech.local:4443/v5/objectstoragerepositories/abca7074-ca3d-4a43-af7a-a429b3a2265d"}, "account": {"href": "https://abc.tech.local:4443/v5/accounts/db1befe9-f6cc-4e94-b473-7d6b4a52a6bf"}, "container": {"href": "https://abc.tech.local:4443/v5/AzureResources/containers/container1?accountId=db1befe9-f6cc-4e94-b473-7d6b4a52a6bf&RegionType=Global"}, "folder": {"href": "https://abc.tech.local:4443/v5/AzureResources/containers/container1/folders/Azure Storage?accountId=db1befe9-f6cc-4e94-b473-7d6b4a52a6bf®ionType=Global"} } } |