Method: instances.getStorageInfo

Full name: projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.getStorageInfo

instances.getStorageInfo returns the storage info of the specified resource.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/*/series/*/instances/*}:getStorageInfo

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resource

string

Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreId}/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instance_uid})

Authorization requires the following IAM permission on the specified resource resource:

  • healthcare.dicomStores.dicomWebRead

Request body

The request body must be empty.

Response body

StorageInfo encapsulates all the storage info of a resource.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "referencedResource": string,
  "structuredStorageInfo": {
    object(StructuredStorageInfo)
  },
  "blobStorageInfo": {
    object(BlobStorageInfo)
  }
}
Fields
referencedResource

string

The resource whose storage info is returned. For example, to specify the resource path of a DICOM Instance: projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreId}/dicomWeb/studi/{study_uid}/series/{series_uid}/instances/{instance_uid}
structuredStorageInfo

object(StructuredStorageInfo)

Info about the data stored in structured storage for the resource.
blobStorageInfo

object(BlobStorageInfo)

Info about the data stored in blob storage for the resource.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

StructuredStorageInfo

StructuredStorageInfo contains details about the data stored in Structured Storage for the referenced resource.

JSON representation 
{
  "sizeBytes": string
}
Fields
sizeBytes

string (int64 format)

Size in bytes of data stored in structured storage.

BlobStorageInfo

BlobStorageInfo contains details about the data stored in Blob Storage for the referenced resource. Note: Storage class is only valid for DICOM and hence will only be populated for DICOM resources.

JSON representation 
{
  "sizeBytes": string,
  "storageClass": enum(BlobStorageClass),
  "storageClassUpdateTime": string
}
Fields
sizeBytes

string (int64 format)

Size in bytes of data stored in Blob Storage.
storageClass

enum(BlobStorageClass)

The storage class in which the Blob data is stored.
storageClassUpdateTime

string(Timestamp format)

The time at which the storage class was updated. This is used to compute early deletion fees of the resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".