List Storage Buckets
Retrieves a list of buckets for a given project.
External Documentation
To learn more, visit the GCP documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Prefix | Filter results to buckets whose names begin with this prefix. |
| Project | A valid API project identifier. |
| Return All Pages | Automatically fetch all resources, page by page. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Max Results | Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller. |
| Projection | Set of properties to return. Defaults to noAcl. |
Example Output
{
"items": [
{
"acl": [
{
"bucket": "The name of the bucket.",
"domain": "The domain associated with the entity, if any.",
"email": "The email address associated with the entity, if any.",
"entity": "The entity holding the permission, in one of the following forms:\n- user-userId\n- user-email\n- group-groupId\n- group-email\n- domain-domain\n- project-team-projectId\n- allUsers\n- allAuthenticatedUsers Examples:\n- The user liz@example.com would be user-liz@example.com.\n- The group example@googlegroups.com would be group-example@googlegroups.com.\n- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.",
"entityId": "The ID for the entity, if any.",
"etag": "HTTP 1.1 Entity tag for the access-control entry.",
"id": "The ID of the access-control entry.",
"kind": "storage#bucketAccessControl",
"projectTeam": {
"projectNumber": "The project number.",
"team": "The team."
},
"role": "The access permission for the entity.",
"selfLink": "The link to this access-control entry."
}
],
"billing": {
"requesterPays": false
},
"cors": [
{
"maxAgeSeconds": 0,
"method": [
"string"
],
"origin": [
"string"
],
"responseHeader": [
"string"
]
}
],
"customPlacementConfig": {
"dataLocations": [
"string"
]
},
"defaultEventBasedHold": false,
"defaultObjectAcl": [
{
"bucket": "The name of the bucket.",
"domain": "The domain associated with the entity, if any.",
"email": "The email address associated with the entity, if any.",
"entity": "The entity holding the permission, in one of the following forms:\n- user-userId\n- user-email\n- group-groupId\n- group-email\n- domain-domain\n- project-team-projectId\n- allUsers\n- allAuthenticatedUsers Examples:\n- The user liz@example.com would be user-liz@example.com.\n- The group example@googlegroups.com would be group-example@googlegroups.com.\n- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.",
"entityId": "The ID for the entity, if any.",
"etag": "HTTP 1.1 Entity tag for the access-control entry.",
"generation": "The content generation of the object, if applied to an object.",
"id": "The ID of the access-control entry.",
"kind": "storage#objectAccessControl",
"object": "The name of the object, if applied to an object.",
"projectTeam": {
"projectNumber": "The project number.",
"team": "The team."
},
"role": "The access permission for the entity.",
"selfLink": "The link to this access-control entry."
}
],
"encryption": {
"defaultKmsKeyName": "A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified."
},
"etag": "HTTP 1.1 Entity tag for the bucket.",
"iamConfiguration": {
"bucketPolicyOnly": {
"enabled": false,
"lockedTime": "The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable."
},
"publicAccessPrevention": "The bucket's Public Access Prevention configuration. Currently, 'unspecified' and 'enforced' are supported.",
"uniformBucketLevelAccess": {
"enabled": false,
"lockedTime": "The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable."
}
},
"id": "The ID of the bucket. For buckets, the id and name properties are the same.",
"kind": "storage#bucket",
"labels": {},
"lifecycle": {
"rule": [
{
"action": {
"storageClass": "Target storage class. Required iff the type of the action is SetStorageClass.",
"type": "Type of the action. Currently, only Delete and SetStorageClass are supported."
},
"condition": {
"age": 0,
"createdBefore": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when an object is created before midnight of the specified date in UTC.",
"customTimeBefore": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when the custom time on an object is before this date in UTC.",
"daysSinceCustomTime": 0,
"daysSinceNoncurrentTime": 0,
"isLive": false,
"matchesPattern": "A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the \"Early Access\" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.",
"matchesStorageClass": [
"string"
],
"noncurrentTimeBefore": "A date in RFC 3339 format with only the date part (for instance, \"2013-01-15\"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.",
"numNewerVersions": 0
}
}
]
},
"location": "The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.",
"locationType": "The type of the bucket location.",
"logging": {
"logBucket": "The destination bucket where the current bucket's logs should be placed.",
"logObjectPrefix": "A prefix for log object names."
},
"metageneration": "The metadata generation of this bucket.",
"name": "The name of the bucket.",
"owner": {
"entity": "The entity, in the form project-owner-projectId.",
"entityId": "The ID for the entity."
},
"projectNumber": "The project number of the project the bucket belongs to.",
"retentionPolicy": {
"effectiveTime": "Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.",
"isLocked": false,
"retentionPeriod": "The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes."
},
"rpo": "The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.",
"satisfiesPZS": false,
"selfLink": "The URI of this bucket.",
"storageClass": "The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.",
"timeCreated": "The creation time of the bucket in RFC 3339 format.",
"updated": "The modification time of the bucket in RFC 3339 format.",
"versioning": {
"enabled": false
},
"website": {
"mainPageSuffix": "If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.",
"notFoundPage": "If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result."
}
}
],
"kind": "storage#buckets",
"nextPageToken": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
}
Workflow Library Example
List Storage Buckets with Gcp and Send Results Via Email
Preview this Workflow on desktop