Method: projects.locations.instances.export

Export Redis instance data into a Redis RDB format file in Cloud Storage.

Redis will continue serving during this operation.

The returned operation is automatically deleted after a few hours, so there is no need to call operations.delete.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Redis instance resource name using the form: projects/{projectId}/locations/{locationId}/instances/{instanceId} where locationId refers to a GCP region.

Request body

The request body contains data with the following structure:

JSON representation
{
  "outputConfig": {
    object (OutputConfig)
  }
}
Fields
outputConfig

object (OutputConfig)

Required. Specify data to be exported.

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.

OutputConfig

The output content

JSON representation
{

  // Union field destination can be only one of the following:
  "gcsDestination": {
    object (GcsDestination)
  }
  // End of list of possible types for union field destination.
}
Fields
Union field destination. Required. Specify destination location of output data destination can be only one of the following:
gcsDestination

object (GcsDestination)

Google Cloud Storage destination for output content.

GcsDestination

The Cloud Storage location for the output content

JSON representation
{
  "uri": string
}
Fields
uri

string

Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten.