List compatible RDS option groups

Retrieves a list of RDS option groups which are superset of persistent and permanent options present in the backup snapshot for a given environment.

Path Parameters

backup_id string required
Performs the operation on the backup with the specified ID.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page token used to browse the collection. Leave this parameter empty to get the first page. Other pages can be traversed using HATEOAS links.
filter string
Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

Field Filter Condition Description
environment_id $eq The Clumio-assigned ID of the AWS environment.
For more information about filtering, refer to the Filtering section of this guide.

Field	Filter Condition	Description
environment_id	$eq	The Clumio-assigned ID of the AWS environment.

Responses

200
default

Success

application/api.clumio.backup-aws-rds-resources=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_embedded object
Embedded responses related to the resource.
_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.
engine string
The AWS database engine at the time of backup.
engine_version string
The AWS database engine version at the time of backup.
has_additional_non_permanent_options boolean
Determines whether this option group contains additional non-permanent options apart from the non-permanent options at the time of backup.
has_additional_non_persistent_options boolean
Determines whether this option group contains additional non-persistent options apart from the non-persistent options at time of backup.
has_additional_permanent_options boolean
Determines whether this option group contains additional permanent options apart from the permanent options at the time of backup.
has_additional_persistent_options boolean
Determines whether this option group contains additional persistent options apart from the persistent options at the time of backup.
is_compatible boolean
Compatibility of the Option Group
minimum_required_minor_engine_version string
Minimum required minor engine version for this option-group to be applicable.
name string
Name of the option group
options object[]
List of options configurations.
is_permanent boolean
Determines whether or not the option is permanent.
is_persistent boolean
Determines whether or not the option is persistent.
is_required_for_restore boolean
Determines whether the option is required to restore from a given backup.
name string
The AWS-assigned name of the RDS option.
option_setting object[]
List of option settings.
description string
The AWS-assigned description of the RDS option setting.
name string
The AWS-assigned name of the RDS option setting.
value string
Value of the option setting
option_version string
Option version of the option.
_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.
current_count int64
The number of items listed on the current page.
filter_applied string
The filter used in the request. The filter includes both manually-specified and system-generated filters.
limit int64
The maximum number of items displayed per page in the response.
start string
The page token used to get this response.

{
  "_embedded": {
    "items": [
      {
        "_embedded": {},
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "engine": "string",
        "engine_version": "string",
        "has_additional_non_permanent_options": true,
        "has_additional_non_persistent_options": true,
        "has_additional_permanent_options": true,
        "has_additional_persistent_options": true,
        "is_compatible": true,
        "minimum_required_minor_engine_version": "string",
        "name": "string",
        "options": [
          {
            "is_permanent": true,
            "is_persistent": true,
            "is_required_for_restore": true,
            "name": "string",
            "option_setting": [
              {
                "description": "string",
                "name": "string",
                "value": "string"
              }
            ],
            "option_version": "string"
          }
        ]
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "filter_applied": "string",
  "limit": 0,
  "start": "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/option-groups

Authorization

Request

Click Edit to configure Base URL

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

Bearer Token

backup_id — path required

limit — query

start — query

filter — query

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/option-groups' \
-H 'Accept: application/api.clumio.backup-aws-rds-resources=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/option-groups' \
-H 'Accept: application/api.clumio.backup-aws-rds-resources=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/option-groups' \
-H 'Accept: application/api.clumio.backup-aws-rds-resources=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/option-groups' \
-H 'Accept: application/api.clumio.backup-aws-rds-resources=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/option-groups' \
-H 'Accept: application/api.clumio.backup-aws-rds-resources=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/option-groups' \
-H 'Accept: application/api.clumio.backup-aws-rds-resources=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/aws/rds-resources/:backup_id/option-groups' \
-H 'Accept: application/api.clumio.backup-aws-rds-resources=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

List compatible RDS option groups​

Authorization

Request

List compatible RDS option groups