This section explains how to get object storage information by storage ID.
Request
GET https://<hostname>:4443/v4/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 | 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 | bool | 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 |
|---|---|---|
servicePoint | string | An endpoint address. |
customRegionId | string | A region identification number. |
name | string | A bucket name |
Example
Request: GET https://abc.tech.local:4443/v4/ObjectStorageRepositories/2a4bcacd-1288-45f4-a30e-d6b1b938cde5
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "bucket": { "servicePoint": "s3.us-west-1.wasabisys.com:443", "customRegionId": "us-east-1", "name": "twbucket" }, "s3Folder": "OSR", "id": "9a3cc5d6-6584-4e34-b730-f461d7dbd298", "name": "s3", "description": "Created by EPSILON\\Administrator at 10/21/2019 12:49:03 AM", "accountId": "a88abf77-916c-4ebc-bfbc-87124ae49bf6", "sizeLimitEnabled": false, "usedSpaceBytes": 77204328, "type": "AmazonS3Compatible", "_links": { "self": {"href": "https://epsilon.tech.local:4443/v4/objectstoragerepositories/9a3cc5d6-6584-4e34-b730-f461d7dbd298"}, "account": {"href": "https://epsilon.tech.local:4443/v4/accounts/a88abf77-916c-4ebc-bfbc-87124ae49bf6"}, "bucket": {"href": "https://epsilon.tech.local:4443/v4/S3CompatibleResources/buckets/twbucket?accountId=a88abf77-916c-4ebc-bfbc-87124ae49bf6&ServicePoint=s3.us-west-1.wasabisys.com:443&CustomRegionId=us-east-1"}, "folder": {"href": "https://epsilon.tech.local:4443/v4/S3CompatibleResources/buckets/twbucket/folders/OSR?accountId=a88abf77-916c-4ebc-bfbc-87124ae49bf6&ServicePoint=s3.us-west-1.wasabisys.com:443&CustomRegionId=us-east-1"} } } |
