REST endpoints: Tiering

REST

These ~~endpoints:~~endpoints ~~Tiering~~mirror the CLI commands described in T, 0. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

`POST /applications/tiers/policies/create`

Create an autotiering capacity policy for a tier pool.

CLI command: applications tiers policies create

Body fields (JSON)

Name Type Required Description TierPool string Yes The tier pool to create the policy for. MaxCapacityInBytes integer No The maximum capacity this pool can use for auto-tiering. Specified in bytes. SendProposalsOnly boolean Depends Only send recommendation notifications; do not automatically adjust the tiers on this pool. AutoAdjustTiers boolean Depends Automatically adjust the tiers on this pool based on recommendations. TierUsageStatesWeightInPercentage number No Weight given to the tier usage states. Default: 25%. Specified as a percentage. LowerAndUpperTierReadsRatioWeightInPercentage number No Weight given to the read ratio between the lower and upper tiers. Default: 25%. Specified as a percentage. EvacuationDurationWeightInPercentage number No Weight given to the evacuation duration. Default: 25%. Specified as a percentage. LatencyImpactDuringEvacuationWeightInPercentage number No Weight given to the latency impact during evacuation. Default: 25%. Specified as a percentage.

`DELETE /applications/tiers/policies/delete`

Delete an autotiering capacity policy.

CLI command: applications tiers policies delete

Query parameters

Name Type Required Description tierPool string Yes The tier pool to delete the policy from. force boolean No Skip the confirmation prompt.

`PUT /applications/tiers/policies/edit`

Edit an autotiering capacity policy.

CLI command: applications tiers policies edit

Query parameters

Name Type Required Description tierPool string Yes The tier pool to edit the policy on.

Body fields (JSON)

Name Type Required Description MaxCapacityInBytes integer No The new maximum capacity this pool can use for auto-tiering. Specified in bytes. SendProposalsOnly boolean No Only send recommendation notifications; do not automatically adjust the tiers on this pool. AutoAdjustTiers boolean No Automatically adjust the tiers on this pool based on recommendations. TierUsageStatesWeightInPercentage number No The new weight given to the tier usage states. Default: 25%. Specified as a percentage. LowerAndUpperTierReadsRatioWeightInPercentage number No The new weight given to the read ratio between the lower and upper tiers. Default: 25%. Specified as a percentage. EvacuationDurationWeightInPercentage number No The new weight given to the evacuation duration. Default: 25%. Specified as a percentage. LatencyImpactDuringEvacuationWeightInPercentage number No The new weight given to the latency impact during evacuation. Default: 25%. Specified as a percentage.

`GET /applications/tiers/policies/list`

List autotiering capacity policies.

CLI command: applications tiers policies list

This endpoint takes no parameters.

Response: a list of TieringPoolPolicyElement objects in Result.TieringPoolPolicyElement, each with: TierPool (string), MaxCapacityInBytes (integer), SendProposalsOnly (boolean), AutoAdjustTiers (boolean), TierUsageStatesWeightInPercentage (number), LowerAndUpperTierReadsRatioWeightInPercentage (number), EvacuationDurationWeightInPercentage (number), LatencyImpactDuringEvacuationWeightInPercentage (number).

`PUT /applications/tiers/suggestions/apply`

Apply tier suggestions generated from the tier policies.

CLI command: applications tiers suggestions apply

Body fields (JSON)

Name Type Required Description TierPool string Yes The tier pool the suggestions belong to. RecommendationIds array of integer Yes The IDs of the suggestions to apply. Force boolean No Skip the confirmation prompt.

`GET /applications/tiers/suggestions/list`

List tier suggestions generated from the tier policies.

CLI command: applications tiers suggestions list

Query parameters

Name Type Required Description tierPool string Yes The tier pool to view suggestions for.

Response: a list of TieringPoolPolicyRecommendationElement objects in Result.TieringPoolPolicyRecommendationElement, each with: TierPool (string), TierPolicyRecommendationId (integer), RecommendationTime (date-time), Description (string).