Estimate Savings for a Suspension Policy

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameEstimate Savings for a Suspension Policy
Description

Get Estimated savings percentage for a suspension policy configuration – blackout periods are not considered for savings estimation

Allowed Role(s)WM_USER
MethodPOST
URI

v2/suspensionPolicies/estimateSavings

cloudcenter-ccm-backend/api/v2/suspensionPolicies/estimateSavings

Sample Request
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/suspensionPolicies/estimateSavings"
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v2/suspensionPolicies/estimateSavings"
Release

Introduced in CloudCenter 4.9.1

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • This policy is useful to conserve resources by taking a deployment out of Running state when it is not needed, or for preventing a deployment from running during times that it should not be accessed. It also can be useful to keep a deployment in a suspended state during a holiday or a holiday period.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: create.suspensionPolicies.estimateSavings

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Request

{
   "blockoutPeriods":[],
   "description":"",
   "enabled":"true",
   "name":"test-5",
   "schedules":[
      {
         "startTime":"08:00",
         "endTime":"17:00",
         "repeats":"1",
         "type":"DAILY",
         "days":[ ]
      }        ]
}

Response

{
  estimatedSavingsPercentage: 62.5
}


Request Attributes

blockoutPeriods

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

enabled
  • Description: Indicates that this resource has been enabled. The default differs based on the resource.

    • true = The resource has been enabled (v2 aging and suspension policies are enabled by default).

    • false = The resource has not been enabled.

  • Type: Boolean

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

schedules
  • Description: Schedule settings for this policy.

  • Type: Sequence of schedule details

    type
    • Description: Identifies the frequency of the suspension.

    • Type: Enumeration

      EnumerationDescription
      DAILYThe policy should put the deployment in the Running state every day during the designated start time through end time period.
      WEEKLYIdentifies specific days during the week when the policy should put the deployment in the Running state.

    days
    • Description: Identifies the frequency of the weekly suspension based on the identified day(s).

    • Type: Enumeration

      EnumerationDescription
      MONIdentifies that the policy should put the deployment in the Running state each Monday.
      TUEIdentifies that the policy should put the deployment in the Running state each Tuesday.
      WEDIdentifies that the policy should put the deployment in the Running state each Wednesday.
      THURIdentifies that the policy should put the deployment in the Running state each Thursday.
      FRIIdentifies that the policy should put the deployment in the Running state each Friday.
      SATIdentifies that the policy should put the deployment in the Running state each Saturday.
      SUNIdentifies that the policy should put the deployment in the Running state each Sunday.

    startTime

    endTime

    repeats
    • Description: Identifies the number of times to repeat requests in JMeter.
    • Type: Long

Response Attributes

estimatedSavingsPercentage
  • Description: Estimates the savings percentage and is updated whenever schedule type/scheduled days, start time/end time of schedule are changed. Blockout dates are not used in this calculation as the time frame is indeterminate.

  • Type: Float

  • No labels
© 2017-2019 Cisco Systems, Inc. All rights reserved