GET /config/tiered_storage/policies/{id}

Edit online

Retrieve a specific tiered storage policy

Retrieve a specific tiered storage policy

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

application/json

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

id

path

Required

Number (Integer)

text/plain

null

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/{id} response codes
HTTP Response Code Unique Code Description

200

The tiered storage policy has been retrieved

403

1002

The user is forbidden from retrieving the tiered storage policy

404

1001

The tiered storage policy could not be found

500

1003

An error occurred while retrieving the tiered storage policy

Response Description

The tiered storage policy. 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
}