Getting Object Storage by ID

In this article

You can get information about an object storage with the specified ID.

Request

GET https://<hostname>:4443/v6/objectstoragerepositories/{repositoryId}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter	Type	Description
repositoryId	string	Specifies the identification number of the object storage. For more information on how to get this parameter, see Getting Object Storage Repositories.

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 body contains the following properties:

Property	Type	Description
amazonBucketS3Aws	amazonBucketS3Aws	Contains Amazon S3 bucket properties.
s3Folder	string	Specifies storage folder where backups reside.
id	string	Specifies the object storage ID.
name	string	Specifies the object storage name.
description	string	Specifies the object storage description.
accountId	string	Specifies ID of the account under which the object storage was added.
sizeLimitEnabled	boolean	Defines whether the size limit is set.
sizeLimitGB	integer	Specifies size limit in GB.
usedSpaceBytes	integer	Specifies used space in Bytes.
freeSpaceBytes	integer	Specifies free space in Bytes.
type	string	Specifies the object storage type. The following types are available: AmazonS3 AmazonS3Glacier
glacierDeepArchiveEnabled	boolean	Defines that the Amazon S3 Glacier Deep Archive storage class is enabled.
iaStorageClassEnabled	boolean	Defines that the Amazon S3 Standard-Infrequent Access storage class is enabled for data blocks that are stored in an Amazon S3 object storage.
useArchiverAppliance	boolean	Defines that Veeam Backup for Microsoft 365 uses the Amazon archiver appliance when transferring backed-up data to the archive object storage.
amazonArchiverAppliance	amazonArchiverAppliance	Contains a definition of the Amazon archiver appliance that Veeam Backup for Microsoft 365 uses when transferring backed-up data to the archive object storage.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

amazonBucketS3Aws

Property	Type	Description
regionType	string	Specifies a region type. The following types are available: Global USGovernment China
regionName	string	Specifies a region name.
regionId	string	Specifies a region ID.
name	string	Specifies a bucket name.

amazonArchiverAppliance

Property	Type	Description
instanceType	Instance Type	Specifies an instance type that the Amazon archiver appliance uses.
virtualPrivateCloud	Virtual Private Cloud	Specifies Amazon Virtual Private Cloud (Amazon VPC).
subnet	Subnet	Specifies the Amazon archiver appliance subnet.
securityGroup	Security Group	Specifies a security group associated with the Amazon archiver appliance.
appliancePort	integer	Specifies a port number that is used to route requests between the Amazon archiver appliance and Veeam Backup for Microsoft 365 backup infrastructure components.

Example

The example returns a resource representation of the Amazon S3 Glacier object storage with the ID 793c212d-5a9f-409e-a6f6-299fd84a82bf.

Request:

GET https://abc.tech.local:4443/v6/objectstoragerepositories/793c212d-5a9f-409e-a6f6-299fd84a82bf

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"s3Folder": "AmazonS3Folder1",

"id": "793c212d-5a9f-409e-a6f6-299fd84a82bf",

"name": "Amazon Archive Object Storage",

"description": "",

"accountId": "c0f030cb-a43a-4713-8da8-717c62a0b4f7",

"sizeLimitEnabled": false,

"usedSpaceBytes": 19918723665,

"type": "AmazonS3Glacier",

"_links": {

"self": {

"href": "v6/objectstoragerepositories/793c212d-5a9f-409e-a6f6-299fd84a82bf"

"account": {

"href": "v6/accounts/c0f030cb-a43a-4713-8da8-717c62a0b4f7"

"bucket": {

"href": "v6/S3Resources/buckets/test_bucket?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global&RegionId=us-east-2"

"folder": {

"href": "v6/S3Resources/buckets/test_bucket/folders/AmazonS3Folder1?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&regionType=Global"

}

"glacierDeepArchiveEnabled": false,

"amazonBucketS3Aws": {

"regionType": "Global",

"regionName": "US East (Ohio)",

"regionId": "us-east-2",

"name": "test_bucket"

"iaStorageClassEnabled": false,

"useArchiverAppliance": true,

"amazonArchiverAppliance": {

"instanceType": {

"cores": 0,

"memory": 0

"virtualPrivateCloud": {},

"subnet": {},

"securityGroup": {},

"appliancePort": 0

}