Get details of a volume (Microsoft Azure)

📘

Navigation

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://cgc-api.sbgenomics.com/v2/storage/volumes/{volume_id}

Example request

GET /v2/storage/volumes/rfranklin/output HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "Content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/output"

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your CGC authentication token.
Content-Type
required
application/json

Path parameters

NameDescription
volume_id
required
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 CGC-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:

NameData typeDescription
activeBooleanIf a volume is deactivated, this field will be set to false
idStringID of this volume, containing owner/name.
nameStringName of the volume.
descriptionStringThe description of this volume.
serviceObjectThis 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_onStringThe date and time this volume was created.
modified_onStringThe date and time this volume was last modified.

The service object

KeyData typeDescription
typeStringUse "azure" for Microsoft Azure.
storage_accountStringThe name of the storage account that holds the container you want to attach as a volume.
bucketStringThe attached bucket in the <storage-account>.<container-name> format.
containerStringThe name of the container that is attached as a volume.
prefix
default: ""
StringA service-specific prefix prepended to all objects created in this volume.
credentialsObjectContains the following Microsoft Azure credentials that were used to attach your storage container:
- tenant_id
- client_id
tenant_idStringDirectory (tenant) ID of the application you created on the Azure Portal for the purpose of attaching your storage container.
client_idStringApplication (client) ID of the application you created on the Azure Portal for the purpose of attaching your storage container.
propertiesObjectContains the following properties of specific service:
- resource_id
resource_idStringResource ID
of the Azure storage account that holds the attached storage container.

Example response body

{
    "href": "https://cgc-api.sbgenomics.com/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-b8faeb12de9c",
            "client_id": "c90b4699-bd66-53af-bd1a-a933d80629a4"
        },
        "properties": {
            "resource_id": "/subscriptions/Jm0.7M5edJEvle9.v6pqJ-9~fte1qen.vT/resourceGroups/azurepoc/providers/Microsoft.Storage/storageAccounts/rfranklinazure"
        }
    },
    "created_on": "2021-04-28T11:45:48Z",
    "modified_on": "2021-04-28T11:45:48Z",
    "active": true
}