projects

Changed on

Creates a new Backup in a given project and location.

post/v1/{+parent}/backups

Request

  • Base URL: https://alloydb.googleapis.com
  • URL: https://alloydb.googleapis.com/v1/{+parent}/backups
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL 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

parentstring required

Required. Value for parent.

Query parameters

backupIdstring

Required. ID of the requesting object.

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

validateOnlyboolean

Optional. If set, the backend validates the request, but doesn't actually execute it.

Request body

annotationsobject

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

clusterNamestring

Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

clusterUidstring

Output only. The system-generated UID of the cluster which was used to create this resource.

createCompletionTimestring google-datetime

Output only. Timestamp when the resource finished being created.

createTimestring google-datetime

Output only. Create time stamp

databaseVersion'DATABASE_VERSION_UNSPECIFIED' | 'POSTGRES_13' | 'POSTGRES_14' | 'POSTGRES_15' | 'POSTGRES_16' | 'POSTGRES_17' | 'POSTGRES_18'

Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

deleteTimestring google-datetime

Output only. Delete time stamp

descriptionstring

User-provided description of the backup.

displayNamestring

User-settable and human-readable display name for the Backup.

etagstring

For Resource freshness validation (https://google.aip.dev/154)

expiryTimestring google-datetime

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

labelsobject

Labels as key value pairs

namestring

Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}

reconcilingboolean

Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

satisfiesPzsboolean

Output only. Reserved for future use.

sizeBytesstring int64

Output only. The size of the backup in bytes.

state'STATE_UNSPECIFIED' | 'READY' | 'CREATING' | 'FAILED' | 'DELETING'

Output only. The current state of the backup.

tagsobject

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

type'TYPE_UNSPECIFIED' | 'ON_DEMAND' | 'AUTOMATED' | 'CONTINUOUS'

The backup type, which suggests the trigger for the backup.

uidstring

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

updateTimestring google-datetime

Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.

Response

Successful response

Changes

  • 75052c733176Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status