GET /config/tiered_storage/policies

Retrieve all tiered storage policies

Retrieve all tiered storage policies

Table 1. GET /config/tiered_storage/policies resource details
MIME Type

application/json

Table 2. GET /config/tiered_storage/policies request parameter details
Parameter Type Optionality Data Type MIME Type Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /config/tiered_storage/policies response codes
HTTP Response Code Unique Code Description

200

All tiered storage policies have been retrieved

403

1001

The user is forbidden from retrieving the tiered storage policies

500

1002

An error occurred while retrieving the tiered storage policies

Response Description

An array of tiered storage policies. A tiered storage policy has the following fields:
  • id - Long - The ID of the tiered storage policy
  • name - String - The name of the tiered storage policy
  • database - String - The name of the Ariel database the tiered storage policy applies to
  • master_node_id - Long - The ID of the master node in the data cluster the tiered storage policy applies to
  • period - Long - The time period in milliseconds after which data will age out
  • enabled - Boolean - Whether the tiered storage policy is enabled

Response Sample


[
    {
        "database": "String",
        "enabled": true,
        "id": 42,
        "master_node_id": 42,
        "name": "String",
        "period": 42
    }
]