List GCP GCS assets
Returns a list of GCP GCS assets.
Query Parameters
- limit int64
Limits the size of the response on each page to the specified number of items.
- start string
Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e.,
?start=1). - filter string
Narrows down the results to only the items that satisfy the filter criteria. Supported filter fields:
Field Condition Description id $eq,$in The Clumio-assigned ID of the GCS asset. protection_group_id $eq,$in The Clumio-assigned ID of the protection group. bucket_id $eq,$in The Clumio-assigned ID of the GCS bucket. bucket_name $eq,$in The name of the GCS bucket. is_deleted $eq Boolean flag indicating whether to return deleted ( true) or active (false) GCS assets.name $eq,$contains The display name of the GCS asset. added_by $in The method by which the GCS asset was added. Possible values include userandbucket_rule.
- 200
- default
- application/api.clumio.gcp-gcs-assets=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
items object[]
added_by stringIndicates how the bucket was added to the protection group. Possible values include
userandbucket_rule.added_with string[]Lists all methods by which the bucket was added to the protection group.
backup_target_region stringThe backup target region configured for the GCS asset, if any.
bucket_id stringThe Clumio-assigned ID of the bucket associated with this GCS asset.
bucket_name stringThe name of the GCS bucket associated with this GCS asset.
created_timestamp stringCreation time of the GCS asset in RFC-3339 format.
deleted_timestamp stringDeletion time of the GCS asset in RFC-3339 format.
id stringThe Clumio-assigned ID that represents the bucket within the protection group.
is_deleted booleanIndicates whether the GCS asset has been deleted (
true) or is still active (false).last_backup_timestamp stringTime of the last backup in RFC-3339 format.
name stringThe display name of the GCS asset.
native_id stringThe Clumio-assigned native ID of the GCS asset.
object_count int64The number of objects that have been backed up in this GCS asset.
organizational_unit_id stringThe Clumio-assigned ID of the organizational unit associated with the GCS asset.
project_uuid stringThe Clumio-assigned UUID of the GCP project associated with this GCS asset.
protection_group_id stringThe Clumio-assigned ID of the protection group associated with this GCS asset.
protection_group_name stringThe user-assigned name of the protection group associated with this GCS asset. Omitted when the parent protection group could not be resolved or has no name.
region_uuid stringThe Clumio-assigned UUID of the GCP region associated with this GCS asset.
size_bytes int64Total size in bytes of all objects that have been backed up in this GCS asset.
updated_timestamp stringLast update time of the GCS asset in RFC-3339 format.
version int64The resource version of the GCS asset.
- current_count int64
The number of items listed on the current page.
- limit int64
The maximum number of items displayed per page in the response.
- start string
The page number used to get this response. Pages are indexed starting from 1 (i.e.,
"start": "1"). - total_count int64
The total number of items, summed across all pages.
- total_pages_count int64
The total number of pages of results.
{
"_embedded": {
"items": [
{
"added_by": "string",
"added_with": [
"string"
],
"backup_target_region": "string",
"bucket_id": "string",
"bucket_name": "string",
"created_timestamp": "string",
"deleted_timestamp": "string",
"id": "string",
"is_deleted": true,
"last_backup_timestamp": "string",
"name": "string",
"native_id": "string",
"object_count": 0,
"organizational_unit_id": "string",
"project_uuid": "string",
"protection_group_id": "string",
"protection_group_name": "string",
"region_uuid": "string",
"size_bytes": 0,
"updated_timestamp": "string",
"version": 0
}
]
},
"current_count": 0,
"limit": 0,
"start": "string",
"total_count": 0,
"total_pages_count": 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"
}
]
}