Getting Object Storage by ID
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 |
---|---|---|
azureContainer | Contains a container properties. | |
azureFolder | 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:
|
useArchiverAppliance | boolean | Defines that Veeam Backup for Microsoft 365 uses the Azure archiver appliance when transferring backed-up data to the archive object storage. |
azureArchiverAppliance | Contains a definition of the Azure archiver appliance that Veeam Backup for Microsoft 365 uses when transferring backed-up data to the archive object storage. | |
azureServiceAccount | Specifies properties of the Microsoft Azure service account that the Azure archiver appliance uses to access Microsoft Azure. | |
azureSubscription | Specifies properties of the Microsoft Azure subscription associated with a user account that is used to access Azure Blob storage. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
---|---|---|
name | string | Specifies a container name. |
regionType | string | Specifies a region type. The following types are available:
|
Property | Type | Description |
---|---|---|
virtualMachineSize | Specifies the Azure archiver appliance size. | |
resourceGroup | Specifies a resource group associated with the Azure archiver appliance. | |
virtualNetwork | Specifies a virtual network to which the Azure archiver appliance is connected. | |
subnet | Specifies the Azure archiver appliance subnet. | |
region | string | Specifies a Microsoft Azure region. |
appliancePort | integer | Specifies a port number that is used to route requests between the Azure archiver appliance and Veeam Backup for Microsoft 365 backup infrastructure components. |
Example
The example returns a resource representation of the Azure Archive object storage with the ID ffb0076b-b049-4034-aeb2-ec4d1ebc6fab.
Request: GET https://abc.tech.local:4443/v6/objectstoragerepositories/ffb0076b-b049-4034-aeb2-ec4d1ebc6fab
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "id": "ffb0076b-b049-4034-aeb2-ec4d1ebc6fab", "name": "Azure Archive Object Storage", "description": "", "accountId": "b59af548-3406-4681-a56b-3dfc6c379e96", "sizeLimitEnabled": false, "usedSpaceBytes": 19407424423, "type": "AzureBlobArchive", "_links": { "self": { "href": "/v6/objectstoragerepositories/ffb0076b-b049-4034-aeb2-ec4d1ebc6fab" }, "account": { "href": "/v6/accounts/b59af548-3406-4681-a56b-3dfc6c379e96" }, "container": { "href": "/v6/AzureResources/containers/container1?accountId=b59af548-3406-4681-a56b-3dfc6c379e96&RegionType=Global" }, "folder": { "href": "/v6/AzureResources/containers/container1/folders/AzureArchiveFolder?accountId=b59af548-3406-4681-a56b-3dfc6c379e96®ionType=Global" } }, "useArchiverAppliance": false, "azureContainer": { "name": "container1", "regionType": "Global" }, "azureFolder": "AzureArchiveFolder" } |