Get Supported Cloud Details

Details

API Details
NameGet Supported Cloud Details
DescriptionRetrieve details of supported cloud environments for the specified application(s) along with the instance types and properties
MethodGET
URI /v1/apps/appId/depEnvId/cloudConfigs/cloudId?version=appVersion
CloudCenter Release
  • CloudCenter 3.x and 4.x
  • Enhanced in 3.2.6.5 to include the depEnvId attribute
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
ESB Headeraction: get.apps.appId.depEnvId.cloudConfigs.cloudId
actionparam:
version=appVersion

Example

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/apps/64/1/cloudConfigs/Amazon-us-west-2?version=1.0"

Response

{
    "id": "Amazon-us-west-2",
    "resource": null,
    "perms": [],
    "name": "US West (Oregon)",
    "description": "Amazon EC2 US West Oregon Region",
    "cloudGroupName": "Amazon",
    "cloudFamily": "Amazon",
    "version": null,
    "publicCloud": true,
    "supported": true,
    "properties": [
        {
            "name": "StorageType",
            "value": "gluster"
        },
        {
            "name": "RegionEndPoint",
            "value": "ec2.us-west-2.amazonaws.com"
        }
    ],
    "gatewayAddress": "54.186.24.113",
    "cloudInstanceTypes": [
        {
            "id": "67",
            "resource": null,
            "perms": [],
            "instanceType": "m1.small",
            "name": "m1.small",
            "description": "Small Instance",
            "costPerHour": 0.075,
            "memorySize": 1700,
            "numOfCPUs": 1,
            "numOfNICs": 1,
            "localStorageSize": 160,
            "cudaSupport": false,
            "ssdSupport": false,
            "support32Bit": true,
            "support64Bit": true,
            "dummy": false,
            "deleted": false,
            "mutability": null
        },
        ...
        {
            "id": "250",
            "resource": null,
            "perms": [],
            "instanceType": "hs1.8xlarge",
            "name": "hs1.8xlarge",
            "description": "High Storage Instances",
            "costPerHour": 4.931,
            "memorySize": 119808,
            "numOfCPUs": 16,
            "numOfNICs": 1,
            "localStorageSize": 2048,
            "cudaSupport": false,
            "ssdSupport": false,
            "support32Bit": false,
            "support64Bit": true,
            "dummy": false,
            "deleted": false,
            "mutability": null
        },
        {
            "id": "252",
            "resource": null,
            "perms": [],
            "instanceType": "i2.8xlarge",
            "name": "i2.8xlarge",
            "description": "Storage Optimized - Current Generation(i2.8xlarge)",
            "costPerHour": 7.782,
            "memorySize": 244000,
            "numOfCPUs": 32,
            "numOfNICs": 1,
            "localStorageSize": 6400,
            "cudaSupport": false,
            "ssdSupport": false,
            "support32Bit": false,
            "support64Bit": true,
            "dummy": false,
            "deleted": false,
            "mutability": null
        }
    ]
} 

Request Attributes

appId
  • Description: Unique, system-generated identifier for the application profile. You can provide multiple application profile IDs as input parameters.

  • Type: String

depEnvId
  • DescriptionUnique, system-generated identifier for the deployment environment. See Deployment Environments for additional details. This attribute is the same as the environmentId attribute.
  • Type: String

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

  • Type: String

appVersion
  • Description: Application version
  • Type: String

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource
  • Type: String
perms (click for additional details)

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

  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

publicCloud
  • Description: Inticates if this is a public cloud. This attribute is useful to identify datacenters and private clouds as features like sync storage and add storage type is not applicable to public clouds.
  • Type: Boolean

cloudInstanceTypes.instanceType
  • Description: Instance type
  • Type: String
cloudInstanceTypes.description
  • Description: Instance description
  • Type: String
cloudInstanceTypes.costPerHour
  • Description: Hourly instance cost
  • Type: Float
cloudInstanceTypes.memorySize
  • Description: Size of memory
  • Type: Integer
cloudInstanceTypes.numOfCPUs
  • Description: Number of CPUs
  • Type: Integer
cloudInstanceTypes.numOfNICs
  • Description: Number of Network Interface Cards (NICs)
  • Type: Integer
cloudInstanceTypes.localStorageSize
  • Description: Amount of local storage
  • Type: Integer
cloudInstanceTypes.cudaSupport
  • Description: Use true to indicate CUDA support
  • Type: String
cloudInstanceTypes.ssdSupport
  • Description: Use true to indicate SSD support
  • Type: String
cloudInstanceTypes.support32Bit
  • Description: Use true to indicate 32 bit support
  • Type: String
cloudInstanceTypes.support64Bit
  • Description: Use true to indicate 64 bit support
  • Type: String
cloudInstanceTypes.mutability
  • Description: Mutable, updatable, or readonly
  • Type: String
properties
  • Description: List of cloud-specific properties
  • Type: list
properties.name
  • Description: Property name
  • Type: String
properties[].value
  • Description: Property value
  • Type: String