databaseSnapshots

Run Query

Runs a SQL query against a database snapshot.

This method is asynchronous. It returns a query ID that you can use to check the status of the query. You can then use the query ID to call Get Query Status and Get Query Result.

When the query is complete, the results are saved as a CSV to the location you specify in your restore account.

If the request fails, see Troubleshooting Queries for possible errors and how to resolve them.

post/v1/projects/{projectId}/snapshots/{snapshotId}/databases/query

Request

  • Base URL: https://%7Baccount-domain%7D.console.eon.io/api
  • URL: https://%7Baccount-domain%7D.console.eon.io/api/v1/projects/{projectId}/snapshots/{snapshotId}/databases/query
  • Auth: HTTP bearer

Path parameters

projectIdstring uuid required

ID of the project that contains the database snapshot you want to retrieve. You can see your project ID in the API Credentials page in your global management console.

snapshotIdstring uuid required

ID of the database snapshot you want to query. Snapshot must belong to an RDS resource.

Request body

databaseNamestring required

Name of the database to query.

querystring required

SQL query to run against the database. Support is limited to Athena SELECT queries.

restoreAccountIdstring required

Eon-assigned ID of the restore account.

Response

Querying database.

queryIdstring required

Query ID. Can be used to call Get Query Status and Get Query Result.

Changes

No recorded changes to this operation across all 1 revision of this API.