POST /config/tiered_storage/policies/{id}
Update a tiered storage policy
Update a tiered storage policy
| MIME Type |
|---|
application/json |
| Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
id |
path |
Required |
Number (Integer) |
text/plain |
The ID of the tiered storage policy. |
period |
query |
Optional |
Number (Integer) |
text/plain |
Optional - The time period in milliseconds after which data will age out. |
enabled |
query |
Optional |
Boolean |
text/plain |
Optional - Set to true for the policy to be applied to the tiered storage process. |
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. |
| HTTP Response Code | Unique Code | Description |
|---|---|---|
200 |
The tiered storage policy was updated. |
|
403 |
1002 |
The user is forbidden from retrieving the tiered storage policy |
404 |
1001 |
The tiered storage policy could not be found |
422 |
1005 |
A request parameter is not valid |
500 |
1003 |
An error occurred while retrieving the tiered storage policy |
Response Description
- 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
}