GOgoogle
projects

POST /v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans

Changed on

Creates a new RestoreVerificationPlan in a given project and location.

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

Query parameters

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 the 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).

restoreVerificationPlanIdstring

Required. The name of the RestoreVerificationPlan to create. The name must be unique for the specified project and location. The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, ^[a-z]([-a-z0-9]*[a-z0-9])?$.

Request body

createTimestring google-datetime

Output only. When the RestoreVerificationPlan was created.

descriptionstring

Optional. The description of the RestoreVerificationPlan resource. The description allows for additional details about RestoreVerificationPlan and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters.

labelsobject

Optional. User-defined labels.

namestring

Output only. Identifier. The resource name of the RestoreVerificationPlan. Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}

schedulestring

Required. Describes the schedule on which the restore verification will be executed. The schedule is specified as a Crontab string.

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

Output only. The State for the RestoreVerificationPlan.

timeZonestring

Optional. Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database, like "America/New_York" or "UTC". Defaults to UTC if not specified.

updateTimestring google-datetime

Output only. When the RestoreVerificationPlan was last updated.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes