// removed jquery ui css and js

View Capacity Thresholds for a Region

Details

API Details
Name

View Capacity Thresholds for a Region

Description
MethodGET
URI

v1/capacity/regions/regionId/thresholdConfigurations

CloudCenter ReleaseIntroduced in CloudCenter 4.8.2.
Notes

General:

  • For additional context on <PORT> usage in the following example(s), see Base URI Format.

API:

  • The capacity management feature is only available for VMware and OpenStack clouds.
  • To use this API, you must use an admin account or a privileged account with roles to execute Capacity Management APIs on the cloud region. This account should have cloud provider privileges with the capability of handling APIs in the cloud. Choose an account that has the privilege to access the capacity of every cluster or zone in the cloud.

ESB Header

action: get.capacity.regions.regionId.thresholdConfigurations

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

Example 1 – With Optional Parameters

curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/capacity/regions/1/thresholdConfigurations"

Response

{
   "id":1,
   "regionId":2,
   "cloudAccountId":2,
   "cpu":{
      "ratio":10,
      "threshold":90
   },
   "memory":{
      "ratio":2,
      "threshold":90
   },
   "scriptInfo":{
      "enabled":true,
      "autoSelectNetwork":true,
      "filePackage":"%REPO_ID_1%getresponse.sh",
      "scriptOrCommand":"%PACKAGE_DIR%sumit/cm1.zip"
   },
   "mailConfiguration":{
      "mailNotificationEnabled":true,
      "notificationThreshold":35,
      "to":"admin@cliqrtech.com",
      "bcc":""
   },
   "configured":false,
   "allocateNetwork":true
}

Request Attributes

regionId
  • DescriptionUnique, system-generated identifier for the cloud region 

  • Type: String

Required

Response Attributes

capacityManagementId
  • DescriptionUnique, system-generated identifier for the capacity management configuration

  • Type: String

regionId
  • DescriptionUnique, system-generated identifier for the cloud region 

  • Type: String

cloudAccountId
  • Description: Unique, system-generated identifier for the cloudAccount

  • Type: String

cpu
  • Description: Identifies the CPU utilization for VMs that are powered on and straddled. By default, CPU utilization has precedence over memory utilization.

  • Type: Float

    ratio
    • Description: The ratio of 1 (one) physical CPU to the manually-provided virtual CPU (vCPU) value. CPU over-subscription ratio (100 physical CPU available at a ratio of 1:3 would equal 300 vCPU).

    • Type: Float

    threshold
    • Description: Threshold for CPU capacity of a cluster/zone. Once the CPU utilization exceeds this threshold, the cluster/zone will not be available for new workloads.

    • Type: Long

memory
  • Description: Identifies the memory utilization for VMs that are powered on and straddled. By default, cpu utilization has precedence over memory utilization.

  • Type: Float

    ratio
    • Description: The ratio of the physical memory to virtual memory. If the cluster or zone has 100 GB of memory and the ratio is defined as 1:5, then this 100 GB will be treated as 150 GB of virtual memory.

    • Type: Float

    threshold
    • Description: Threshold for memory utilization of a cluster/zone. Once the memory utilization exceeds this threshold, the cluster/zpne will not be available for new workloads.

    • Type: Long

scriptInfo
  • Description: use a designated custom script to override the criteria that Capacity Management uses to select a VMware cluster or OpenStack zone. The script provides the set of clusters or zones that are not in maintenance and that have not exceeded the configured CPU and memory thresholds.
  • Type: Array of script details

    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

    autoSelectNetwork
    • Description: Identifies if a custom script is provided to auto-select a network based on the cluster (for VMware) or a Zone (for OpenStack).

    • Type: Boolean

      • true = The custom script is provided to auto-select a network.

      • false = Default. The custom script is not provided to auto-select a network. You must explicitly select the network in either the deployment environment or the deployment.

    filePackage
    • Description: Identifies the file or package that you specify for auto selection – in case a script bundle needs to be downloaded for the custom script.

    • Type: String

    scriptOrCommand
    • Description: Specifies a custom script that is used to override the criteria that CloudCenter platform uses to select a network for the deployment. The corresponding cluster or zone should be also returned by the script. If you enable autoSelectNetwork, the CloudCenter platform relies on the script to select the network as well as the cluster/zone.
    • Type:  String

mailConfiguration
  • Description: Identifies the details required to send email notifications to affected users once the capacity utilization reaches a configured threshold.

  • Type: Array of mail configuration details

    mailNotificationEnabled
    • Description: Identifies if the ability to notify by email is enabled for this resource.

    • Type: Boolean

      • true = Mail notification is enabled.

      • false = Default. Mail notification is disabled.

    notificationThreshold
    • Description: Percentage of the capacity threshold. Once utilization reaches this threshold, an email is sent as a warning to configured email addresses that the cluster may soon run out of resources.

    • Type: Long

    to
    • Description: Identifies the email address or addresses (comma-separated email addresses) to which a warning is sent to indicate that the cluster may soon run out of resources.

    • Type: String

    bcc
    • Description: Identifies the email address or addresses (comma-separated email addresses) to which a warning is sent as a Blind Carbon Copy (BCC) to indicate that the cluster may soon run out of resources.

    • Type: String

configured
  • Description: Identifies if the required configurations like cloud account and thresholds are defined in the system.

  • Type: Boolean

    • true = The required configurations are defined.

    • false = Default. The required configurations are not defined.

allocateNetwork
  • Description: Identifies if the network should be auto picked using the custom script that corresponds to the auto-selected cluster or zone.
  • Type: Boolean
    • true = The network should be auto picked using the custom script.
    • false = Default. The network should not be auto picked using the custom script.



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