Method: projects.locations.backupVaults.dataSources.setInternalStatus

Sets the internal status of a DataSource.

HTTP request

POST https://backupdr.googleapis.com/v1/{dataSource=projects/*/locations/*/backupVaults/*/dataSources/*}:setInternalStatus

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataSource

string

Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.

Request body

The request body contains data with the following structure:

JSON representation
{
  "value": string,
  "backupConfigState": enum (BackupConfigState),
  "requestId": string
}
Fields
value

string (bytes format)

Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances.

A base64-encoded string.

backupConfigState

enum (BackupConfigState)

Required. Output only. The new BackupConfigState to set for the DataSource.

requestId

string

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 after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the dataSource resource:

  • backupdr.bvdataSources.setInternalStatus

For more information, see the IAM documentation.