Get details of a volume (Microsoft Azure)
Navigation
- Microsoft Azure volumes
- Attach a Microsoft Azure volume:
- Via the visual interface
- Via the API:
- Create a volume (Microsoft Azure)
- Get details of a volume (Microsoft Azure)
- Update a volume (Microsoft Azure)
This call returns the details of a specific volume, specified as volume_id, which consists of owner and name of a volume - for example rfranklin/output.
Request
https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/volumes/{volume_id}
Example request
GET /v2/storage/volumes/rfranklin/output HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3210a98c1db9304ea9d9273156740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "Content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/volumes/rfranklin/output"
Header Fields
| Name | Description |
|---|---|
| X-SBG-Auth-Token required | Your Platform authentication token. |
| Content-Type required | application/json |
Path parameters
| Name | Description |
|---|---|
volume_idrequired | The volume that you want to query, which consists of username of the volume owner and volume name, for example rfranklin/output. |
Response
See a list of Platform-specific response codes that may be contained in the body of the response.
Response body
The response object contains information about the specified volume. The information is structured using the following key-value pairs:
| Name | Data type | Description |
|---|---|---|
active | Boolean | If a volume is deactivated, this field will be set to false |
id | String | ID of this volume, containing owner/name. |
name | String | Name of the volume. |
description | String | The description of this volume. |
service | Object | This object more closely describes the mapping of the volume to the cloud service where the data is stored. See the service object section below for an explanation of its structure. |
created_on | String | The date and time this volume was created. |
modified_on | String | The date and time this volume was last modified. |
The service object
service object| Key | Data type | Description |
|---|---|---|
type | String | Use "azure" for Microsoft Azure. |
storage_account | String | The name of the storage account that holds the container you want to attach as a volume. |
bucket | String | The attached bucket in the <storage-account>.<container-name> format. |
container | String | The name of the container that is attached as a volume. |
prefixdefault: "" | String | A service-specific prefix prepended to all objects created in this volume. |
credentials | Object | Contains the following Microsoft Azure credentials that were used to attach your storage container: - tenant_id- client_id |
tenant_id | String | Directory (tenant) ID of the application you created on the Azure Portal for the purpose of attaching your storage container. |
client_id | String | Application (client) ID of the application you created on the Azure Portal for the purpose of attaching your storage container. |
properties | Object | Contains the following properties of specific service: - resource_id |
resource_id | String | Resource ID of the Azure storage account that holds the attached storage container. |
Example response body
{
"href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/volumes/rfranklin/myvolume",
"id": "rfranklin/myvolume",
"name": "myvolume",
"description": "Volume containing raw samples",
"access_mode": "RO",
"service": {
"type": "AZURE",
"bucket": "rfranklinazure.raw-samples",
"prefix": "",
"endpoint": "https://rfranklinazure.blob.core.windows.net/",
"storage_account": "rfranklinazure",
"container": "raw-samples",
"credentials": {
"tenant_id": "a32789b5-123e-45d6-78c9-b8faeb12de9cc",
"client_id": "f3e3f987-276d-5c2c-b87e-e3fe12d782fe"
},
"properties": {
"resource_id": "/subscriptions/e1bfa7ce-123a-575d-789c-5bc70e98f986/resourceGroups/azurepoc/providers/Microsoft.Storage/storageAccounts/rfranklinazure"
}
},
"created_on": "2021-04-28T11:45:48Z",
"modified_on": "2021-04-28T11:45:48Z",
"active": true
}