GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}

Changed on

Gets details of a BackupVault.

Request

  • Base URL
    https://backupdr.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-backupdr
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-backupdr
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required
backupVaultsIdstring required

Query parameters

view'BACKUP_VAULT_VIEW_UNSPECIFIED' | 'BACKUP_VAULT_VIEW_BASIC' | 'BACKUP_VAULT_VIEW_FULL'

Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault

Response

Successful response

accessRestriction'ACCESS_RESTRICTION_UNSPECIFIED' | 'WITHIN_PROJECT' | 'WITHIN_ORGANIZATION' | 'UNRESTRICTED' | 'WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA'

Optional. Restricts access to certain sources and destinations for data being sent into, or restored from, the backup vault. Defaults to WITHIN_ORGANIZATION if not provided during creation.

annotationsobject

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

backupCountstring int64

Output only. The number of backups in this backup vault.

backupMinimumEnforcedRetentionDurationstring google-duration

Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.

backupRetentionInheritance'BACKUP_RETENTION_INHERITANCE_UNSPECIFIED' | 'INHERIT_VAULT_RETENTION' | 'MATCH_BACKUP_EXPIRE_TIME'

Optional. Setting for how a backup's enforced retention end time is inherited.

createTimestring google-datetime

Output only. The time when the instance was created.

deletableboolean

Output only. Set to true when there are no backups nested under this resource.

descriptionstring

Optional. The description of the BackupVault instance (2048 characters or less).

effectiveTimestring google-datetime

Optional. Time after which the BackupVault resource is locked.

etagstring

Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.

labelsobject

Optional. Resource labels to represent user provided metadata. No labels currently defined:

namestring

Output only. Identifier. Name of the backup vault to create. It must have the format"projects/{project}/locations/{location}/backupVaults/{backupvault}". {backupvault} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.

serviceAccountstring

Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'ERROR' | 'UPDATING'

Output only. The BackupVault resource instance state.

totalStoredBytesstring int64

Output only. Total size of the storage used by all backup resources.

uidstring

Output only. Immutable after resource creation until resource deletion.

updateTimestring google-datetime

Output only. The time when the instance was updated.

Changes

  • da857420b4f6Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-backupdr was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-backupdr was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c

  • 3244196e66b0Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-backupdr was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-backupdr was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c