Retrieve table columns from an RDS backup

Returns a list of columns within the specified table.

Path Parameters

backup_id string required
Performs the operation on tables within the specified backup.
database_name string required
Performs the operation on the database with the specified name.
table_id string required
Performs the operation on the RDS database table with the specified ID.

Responses

200
default

Success

application/api.clumio.backup-aws-rds-resource-database-tables=v1+json

Schema
Example (from schema)

Schema

_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
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.
_next object
The HATEOAS link to the next page of results.
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.
_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.
columns object[]
The columns of the table with the specified ID.
name string
The name of the column.
type string
The Hive data type of the column. Possible values include int, bigint, string, and boolean.

{
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "columns": [
    {
      "name": "string",
      "type": "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"
    }
  ]
}

GET /backups/aws/rds-resources/:backup_id/databases/:database_name/tables/:table_id/columns

Authorization

Request

Click Edit to configure Base URL

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

Bearer Token

backup_id — path required

database_name — path required

table_id — path required

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases/:database_name/tables/:table_id/columns' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-database-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases/:database_name/tables/:table_id/columns' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-database-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases/:database_name/tables/:table_id/columns' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-database-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases/:database_name/tables/:table_id/columns' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-database-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases/:database_name/tables/:table_id/columns' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-database-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases/:database_name/tables/:table_id/columns' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-database-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/databases/:database_name/tables/:table_id/columns' \
-H 'Accept: application/api.clumio.backup-aws-rds-resource-database-tables=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

Retrieve table columns from an RDS backup​

Authorization

Request

Retrieve table columns from an RDS backup