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 |
---|---|---|
amazonBucketS3Compatible | Contains S3 Compatible 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 AmazonS3Compatible is available. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
---|---|---|
servicePoint | string | Specifies an endpoint address. |
customRegionId | string | Specifies a region ID. |
name | string | Specifies a bucket name. |
Example
The example returns a resource representation of the S3 Compatible object storage with the ID ca324d07-60a8-4504-879d-0913a379b4b3.
Request: GET https://abc.tech.local:4443/v6/objectstoragerepositories/ca324d07-60a8-4504-879d-0913a379b4b3
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "amazonBucketS3Compatible": { "servicePoint": "https://my.servicepoint.com:443", "customRegionId": "us-east-1", "name": "d3e020df-9144-4fa3-a2ff-a83abb3f7cfa" }, "s3Folder": "S3Compatible", "id": "ca324d07-60a8-4504-879d-0913a379b4b3", "name": "S3 Compatible", "description": "", "accountId": "ed531412-7646-4fa1-bea5-986c04bcb89c", "sizeLimitEnabled": true, "sizeLimitGB": 1024, "usedSpaceBytes": 0, "freeSpaceBytes": 1099511627776, "type": "AmazonS3Compatible", "_links": { "self": { "href": "v6/objectstoragerepositories/ca324d07-60a8-4504-879d-0913a379b4b3" }, "account": { "href": "v6/accounts/ed531412-7646-4fa1-bea5-986c04bcb89c" }, "bucket": { "href": "v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1" }, "folder": { "href": "v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa/folders/S3Compatible?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1" } } } |