View Capacity Management Status

Details

API Details
NameView Capacity Management Status
DescriptionAllows you to verify if capacity management is enabled for specific clouds for the entire region. See the Capacity Management section for the relevant release for additional context.
MethodGET
URI
  • v1/capacity/regions
  • v1/capacity/regions?regionId=regionId
  • v1/capacity/regions?cloudId=cloudId
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
  • action: get.capacity.regions
    actionparam: regionId=regionId
  • action: get.capacity
    actionparam: cloudId=cloudId

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


Example 1 – All Regions

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

Response

[
    {
        "regionId": 3,
        "cloudId": 1,
        "regionName": "IDC-R2",
        "enabled": true,
        "configured": true,
        "allocateNetwork": true
    },
    {
        "regionId": 4,
        "cloudId": 1,
        "regionName": "IDC-R3",
        "enabled": true,
        "configured": true,
        "allocateNetwork": false
    },
    {
        "regionId": 1,
        "cloudId": 2,
        "regionName": "vmware",
        "enabled": true,
        "configured": true,
        "allocateNetwork": true
    }
]

Example 1 – Specific Region

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>//v1/capacity/regions?regionId=4"

Response

[
    {
        "regionId": 4,
        "cloudId": 1,
        "regionName": "IDC-R3",
        "enabled": true,
        "configured": true,
        "allocateNetwork": false
    }
]

Example 3 – Specific Cloud

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

Response

[
    {
        "regionId": 3,
        "cloudId": 1,
        "regionName": "IDC-R2",
        "enabled": true,
        "configured": true,
        "allocateNetwork": true
    },
    {
        "regionId": 4,
        "cloudId": 1,
        "regionName": "IDC-R3",
        "enabled": true,
        "configured": true,
        "allocateNetwork": false
    }
]

Request Attributes

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

  • Type: String

cloudId
  • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

  • Type: String

Response Attributes

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

  • Type: String

cloudId
  • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

  • Type: String

regionName
  • DescriptionThe name of this cloud region as listed in the Supported Public Clouds section for the relevant release.
  • 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

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