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
bucket	bucket	Contains a container or bucket definition.
s3Folder	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).

bucket

Property	Type	Description
regionType	string	A region type.
name	string	A bucket name
location	string	The location of the bucket.
region	string	A region.

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:

{

"bucket": {

"regionType": "Global",

"name": "veeam-tw",

"location": "us-east-2",

"region": "USEastOhio"

"s3Folder": "Amazon Backups",

"id": "f88114d3-16bd-4d76-96d1-99d7d0e18e84",

"name": "Amazon",

"description": "Created by ABC\\Administrator at 12:48 AM",

"accountId": "de4f0671-953c-4f88-a60f-731bc8277e3a",

"sizeLimitEnabled": false,

"usedSpaceGB": 0,

"type": "AmazonS3",

"_links": {

"self": {"href": "https://abc.tech.local:4443/v5/objectstoragerepositories/f88114d3-16bd-4d76-96d1-99d7d0e18e84"},

"account": {"href": "https://abc.tech.local:4443/v5/accounts/de4f0671-953c-4f88-a60f-731bc8277e3a"},

"bucket": {"href": "https://abc.tech.local:4443/v5/S3Resources/buckets/veeam-tw?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a&RegionType=Global&Region=USEastOhio"},

"folder": {"href": "https://abc.tech.local:4443/v5/S3Resources/buckets/veeam-tw/folders/Amazon Backups?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a&regionType=Global"}

}