Retrieve a GCS bucket
Returns a representation of the specified GCS bucket.
Path Parameters
- bucket_id string required
Performs the operation on the Bucket with the specified ID.
- 200
- default
Success
- application/api.clumio.gcp-gcs-buckets=v1+json
- Schema
- Example (from schema)
Schema
- _etag string
- bucket_name string
The name of the bucket
- created_timestamp string
Creation time of the bucket in RFC-3339 format.
- id string
The Clumio-assigned ID that represents the bucket.
- is_deleted boolean
Determines whether the bucket has been deleted
- is_versioning_enabled boolean
Determines whether versioning is enabled for the bucket.
labels object[]
GCP labels (key-value pairs) associated with the bucket, similar to AWS tags.
key stringThe GCP-assigned label key.
value stringThe GCP-assigned label value.
- last_backup_timestamp string
Time of the last backup in RFC-3339 format.
- location string
The GCP location associated with the bucket.
- location_type string
The location type of the bucket (e.g., "Region", "Dual-region", "Multi-region").
- location_uuid string
The Clumio-assigned UUID of the GCP location associated with the bucket.
- object_count int64
The number of objects in the bucket.
- organizational_unit_id string
The Clumio-assigned ID of the organizational unit associated with the bucket.
- project_id string
The GCP project ID associated with the bucket.
- project_uuid string
The Clumio-assigned UUID of the GCP project associated with the bucket.
- protection_group_count int64
The number of protection groups associated with the bucket.
- size_bytes int64
Total size in bytes of all objects in the bucket.
{
"_etag": "string",
"bucket_name": "string",
"created_timestamp": "string",
"id": "string",
"is_deleted": true,
"is_versioning_enabled": true,
"labels": [
{
"key": "string",
"value": "string"
}
],
"last_backup_timestamp": "string",
"location": "string",
"location_type": "string",
"location_uuid": "string",
"object_count": 0,
"organizational_unit_id": "string",
"project_id": "string",
"project_uuid": "string",
"protection_group_count": 0,
"size_bytes": 0
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
A list of errors encountered during runtime.
error_code uint32error_message stringThe reason for the error.
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}