Exports metadata from a service.

HTTP request


Path parameters



Required. The relative resource name of the metastore service to run export, in the following form:


Authorization requires the following IAM permission on the specified resource service:


Request body

The request body contains data with the following structure:

JSON representation
  "requestId": string,
  "databaseDumpType": enum (Type),

  // Union field destination can be only one of the following:
  "destinationGcsFolder": string
  // End of list of possible types for union field destination.


Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.

For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.

The request ID must be a valid UUID. A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.


enum (Type)

Optional. The type of the database dump. If unspecified, defaults to MYSQL.

Union field destination. Required. Destination that metadata is exported to. destination can be only one of the following:


A Cloud Storage URI of a folder, in the format gs://<bucket_name>/<path_inside_bucket>. A sub-folder <export_folder> containing exported files will be created below it.

Response body

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

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.