Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1339136214.2 KB
projects

Create a BackupPlanAssociation

post/v1/{+parent}/backupPlanAssociations

Path parameters

parentstring required

Required. The backup plan association project and location in the format projects/{project_id}/locations/{location}. In Backup and DR locations map to Google Cloud regions, for example us-central1.

Query parameters

backupPlanAssociationIdstring

Required. The name of the backup plan association to create. The name must be unique for the specified project and location.

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore 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).

Request body

backupPlanstring

Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}

resourcestring

Required. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").

createTimestring google-datetime

Output only. The time when the instance was created.

backupPlanRevisionIdstring

Output only. The user friendly revision ID of the BackupPlanRevision. Example: v0, v1, v2, etc.

resourceTypestring

Required. Immutable. Resource type of workload on which backupplan is applied

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

Output only. The BackupPlanAssociation resource state.

updateTimestring google-datetime

Output only. The time when the instance was updated.

backupPlanRevisionNamestring

Output only. The resource id of the BackupPlanRevision. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}

namestring

Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}

dataSourcestring

Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}

Response

Successful response