Start an RDS backup logical query.

Start a database backup query with the query statement provided in user input. If the query preview flag is set in the input then the result will be returned in the response otherwise the query will run in background and a task id will be returned.

Query Parameters

embed string
Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

Embeddable Link Description
read-task Embeds the associated task in the response. For example, ?embed=read-task
For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

Embeddable Link	Description
read-task	Embeds the associated task in the response. For example, `?embed=read-task`

application/json

Request Body

source object required
The RDS database backup to be queried.
backup_id string required
Performs the operation on a database within the specified backup. Use the GET /backups/aws/rds-resources endpoint to fetch valid values.
database_name string required
Performs the operation on the database with the specified name. Use the GET /backups/aws/rds-resources endpoint to fetch valid values.
target object required
The query to perform on the source RDS database.
preview boolean
Determines whether the query is preview only. If true, a preview of the query results will be provided in the response immediately. If false or omitted, a task will be queued to make the result of the query available for asynchronous download.
query_statement string required
The SQL statement that is to be executed on the target database. For example, "SELECT * FROM employee WHERE id > 100"

Responses

200
202
default

Preview Success

application/api.clumio.aws-rds-resource-restored-records=v1+json

Schema
Example (from schema)

Schema

_links object
HateoasCommonLinks are the common fields for HATEOAS response.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
preview_result object
The preview of the query result, if preview:true in the request. If preview was not set to true in the request, then the result of the query will be available for download asynchronously.
columns object[]
The columns of the previewed query result.
name string
The name of the column.
type string
The Hive data type of the column. Possible values include int, bigint, string, and boolean.
rows array[]
The rows of the previewed query result.

{
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "preview_result": {
    "columns": [
      {
        "name": "string",
        "type": "string"
      }
    ],
    "rows": [
      [
        "string"
      ]
    ]
  }
}

Success

application/api.clumio.aws-rds-resource-restored-records=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
read-task Embeds the associated task of a resource in the response if requested using the `embed` query parameter.
Embeds the associated task of a resource in the response if requested using the embed query parameter.
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
read-task object
A HATEOAS link to the task associated with this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
task_id string
The Clumio-assigned ID of the task generated by this request. The requested records will be available for asynchronous download when the Task completes. Use the GET /restores/aws/rds-resources/records endpoint to list the records available for download.
If "preview":true was set in the request, then a preview of the result will be given instead of a Task ID.

{
  "_embedded": {},
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "read-task": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "task_id": "string"
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

POST /restores/aws/rds-resources/records

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

embed — query

Body

{
  "source": {
    "backup_id": "string",
    "database_name": "string"
  },
  "target": {
    "preview": true,
    "query_statement": "string"
  }
}

Accept

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/rds-resources/records' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-rds-resource-restored-records=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "database_name": "string"
  },
  "target": {
    "preview": true,
    "query_statement": "string"
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/rds-resources/records' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-rds-resource-restored-records=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "database_name": "string"
  },
  "target": {
    "preview": true,
    "query_statement": "string"
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/rds-resources/records' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-rds-resource-restored-records=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "database_name": "string"
  },
  "target": {
    "preview": true,
    "query_statement": "string"
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/rds-resources/records' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-rds-resource-restored-records=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "database_name": "string"
  },
  "target": {
    "preview": true,
    "query_statement": "string"
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/rds-resources/records' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-rds-resource-restored-records=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "database_name": "string"
  },
  "target": {
    "preview": true,
    "query_statement": "string"
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/rds-resources/records' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-rds-resource-restored-records=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "database_name": "string"
  },
  "target": {
    "preview": true,
    "query_statement": "string"
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/rds-resources/records' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-rds-resource-restored-records=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "database_name": "string"
  },
  "target": {
    "preview": true,
    "query_statement": "string"
  }
}'

Start an RDS backup logical query.​

Authorization

Request

Start an RDS backup logical query.