Method: projects.locations.instances.exportData

Copies data from Parallelstore to Cloud Storage.

HTTP request

POST https://parallelstore.googleapis.com/v1/{name=projects/*/locations/*/instances/*}:exportData

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the resource.

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestId": string,
  "serviceAccount": string,

  // Union field source can be only one of the following:
  "sourceParallelstore": {
    object (SourceParallelstore)
  }
  // End of list of possible types for union field source.

  // Union field destination can be only one of the following:
  "destinationGcsBucket": {
    object (DestinationGcsBucket)
  }
  // End of list of possible types for union field destination.
}
Fields
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 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).

serviceAccount

string

Optional. User-specified Service Account (SA) credentials to be used when performing the transfer. Use one of the following formats:

  • {EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}

If unspecified, the Parallelstore service agent is used: service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com

Union field source. The Parallelstore instance to export from. source can be only one of the following:
sourceParallelstore

object (SourceParallelstore)

Parallelstore source.

Union field destination. The Cloud Storage bucket to export to. destination can be only one of the following:
destinationGcsBucket

object (DestinationGcsBucket)

Cloud Storage destination.

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 name resource:

  • parallelstore.instances.exportData

For more information, see the IAM documentation.

SourceParallelstore

Parallelstore as the source of a data transfer.

JSON representation
{
  "path": string
}
Fields
path

string

Optional. Root directory path to the Paralellstore filesystem, starting with /. Defaults to / if unset.

DestinationGcsBucket

Cloud Storage as the destination of a data transfer.

JSON representation
{
  "uri": string
}
Fields
uri

string

Required. URI to a Cloud Storage bucket in the format: gs://<bucket_name>/<path_inside_bucket>. The path inside the bucket is optional.