View Cloud Instances

Details

API Details
Name

View Cloud Instances

Description
MethodGET
URI

v2/regions/cloudRegiondId/instances?depEnvId=depEnvId&appId=appId

CloudCenter Release
  • Introduced in CloudCenter 4.6.0
  • The supportsCuda and cudaSupport attributes are deprecated in CloudCenter 4.7.2.
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 Header
  • action: get.regions.cloudRegiondId.instances
    actionparams: depEnvId=depEnvId&appId=appId

Example

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/regions/1/instances?depEnvId=1&appId=34"
 Response
{
    "resource": "https://10.0.0.116/v2/regions/1/instances?depEnvId=1&appId=34",
    "size": 7,
    "pageNumber": 0,
    "totalElements": 7,
    "totalPages": 1,
    "cloudInstanceTypes": [{
        "id": "7",
        "instanceType": "5618874f-ab5d-45a4-a8a3-0d40fb64b6f1",
        "instanceName": "m1.large",
        "hardwareSpec": {
            "memorySize": 8192,
            "cpu": 2,
            "storageSize": 40,
            "storageCount": 1,
            "cudaSupport": false,
            "ssdSupport": false
        },
        "softwareSpec": {
            "supports32Bit": true,
            "supports64Bit": true,
            "supports32BitOn64Bit": false,
            "osName": ""
        },
        "description": "",
        "costPerHour": 1,
        "costPerMonth": 0,
        "supportsMonthlyBilling": false,
        "vendorMultiplier": 0
    }, {
        "id": "3",
        "instanceType": "37ea4c37-7301-4689-8431-9ce89e55068f",
        "instanceName": "m1.xlarge",
        "hardwareSpec": {
            "memorySize": 16384,
            "cpu": 4,
            "storageSize": 40,
            "storageCount": 1,
            "cudaSupport": false,
            "ssdSupport": false
        },
        "softwareSpec": {
            "supports32Bit": true,
            "supports64Bit": true,
            "supports32BitOn64Bit": false,
            "osName": ""
        },
        "description": "",
        "costPerHour": 1,
        "costPerMonth": 0,
        "supportsMonthlyBilling": false,
        "vendorMultiplier": 0
    }, {
        "id": "4",
        "instanceType": "351d53fd-c015-4d75-ab81-2db4bde36ddf",
        "instanceName": "m1.mgmt",
        "hardwareSpec": {
            "memorySize": 4096,
            "cpu": 2,
            "storageSize": 20,
            "storageCount": 1,
            "cudaSupport": false,
            "ssdSupport": false
        },
        "softwareSpec": {
            "supports32Bit": true,
            "supports64Bit": true,
            "supports32BitOn64Bit": false,
            "osName": ""
        },
        "description": "",
        "costPerHour": 1,
        "costPerMonth": 0,
        "supportsMonthlyBilling": false,
        "vendorMultiplier": 0
    }, {
        "id": "5",
        "instanceType": "429e5806-f041-44bd-95fb-93a6daf97c48",
        "instanceName": "m1.tiny",
        "hardwareSpec": {
            "memorySize": 512,
            "cpu": 1,
            "storageSize": 10,
            "storageCount": 1,
            "cudaSupport": false,
            "ssdSupport": false
        },
        "softwareSpec": {
            "supports32Bit": true,
            "supports64Bit": true,
            "supports32BitOn64Bit": false,
            "osName": ""
        },
        "description": "",
        "costPerHour": 1,
        "costPerMonth": 0,
        "supportsMonthlyBilling": false,
        "vendorMultiplier": 0
    }, {
        "id": "1",
        "instanceType": "1da5bcf0-0c52-476e-b841-394eea73a903",
        "instanceName": "m1.small",
        "hardwareSpec": {
            "memorySize": 2048,
            "cpu": 1,
            "storageSize": 20,
            "storageCount": 1,
            "cudaSupport": false,
            "ssdSupport": false
        },
        "softwareSpec": {
            "supports32Bit": true,
            "supports64Bit": true,
            "supports32BitOn64Bit": false,
            "osName": ""
        },
        "description": "",
        "costPerHour": 1,
        "costPerMonth": 0,
        "supportsMonthlyBilling": false,
        "vendorMultiplier": 0
    }, {
        "id": "2",
        "instanceType": "fc0b462a-2927-46bc-b923-0e2b974fde69",
        "instanceName": "m1.win",
        "hardwareSpec": {
            "memorySize": 2048,
            "cpu": 1,
            "storageSize": 30,
            "storageCount": 1,
            "cudaSupport": false,
            "ssdSupport": false
        },
        "softwareSpec": {
            "supports32Bit": true,
            "supports64Bit": true,
            "supports32BitOn64Bit": false,
            "osName": ""
        },
        "description": "",
        "costPerHour": 1,
        "costPerMonth": 0,
        "supportsMonthlyBilling": false,
        "vendorMultiplier": 0
    }, {
        "id": "6",
        "instanceType": "ba8a6a26-25c2-4338-a59f-aa747f3a315f",
        "instanceName": "m1.medium",
        "hardwareSpec": {
            "memorySize": 4096,
            "cpu": 1,
            "storageSize": 20,
            "storageCount": 0,
            "cudaSupport": false,
            "ssdSupport": false
        },
        "softwareSpec": {
            "supports32Bit": true,
            "supports64Bit": true,
            "supports32BitOn64Bit": false,
            "osName": ""
        },
        "description": "",
        "costPerHour": 2,
        "costPerMonth": 0,
        "supportsMonthlyBilling": false,
        "vendorMultiplier": 0
    }]
}

Request Attributes

cloudRegionId
  • Description: Unique, system-generated identifier for a cloud region
  • Type: String

Required

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

Required

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

  • Type: String

Required

Response Attributes

resource
  • Description: Unique URL to access this resource.
  • Type: String
size
  • Description: Total number of records that any list page should contain. The default is: 

    • v1 APIs = 20 records

    • v2 APIs:

      • Prior to 4.8.0: All elements are returned and the page value is ignored.

      • Effective 4.8.0: 50 records
  • Type: Integer
See pageResource or Pagination for additional context
totalElements
  • Description: The number resources that an API call returns
  • Type: Long
totalPages
  • Description: The number of pages in a response 
  • Type: Integer
cloudInstanceTypes
  • Description: Identifies details about each cloud instance type
    Type: Array of cloudInstanceTypes

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

    • Type: String

    type
    • DescriptionThe type of resource
    • Type: String

    The instanceType attribute specifies the type for the instance resource.

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

    • Type: String

    The instanceName specifies the name for the instance resource.

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    hardwareSpec
    • Description: Identifies the configured hardware specification details for this instance type.
      Type: Sequence of hardware details

      memorySize
      • DescriptionThe RAM size in MB for this Instance Type (see Map Images)
      • Type: Integer
      minNumberOfCpus
      • DescriptionThe minimum number of CPUs for this instance type or cloud Image.
      • Type: Integer
      storageSize
      • Description: Identifies the size of the shared storage. Displays null if shared storage is not configured.
      • Type: Integer
      storageCount
      • Description: Identifies the number of the shared storage options. Displays null if shared storage is not configured. See Shared Artifact Repositories for additional context.
      • Type: Long
      cudaSupport (deprecated)
      • Description: Indicates whether CUDA is supported for this instance type. This attribute is the same as the supportsCuda attribute

      • Type: Boolean
        • true = CUDA is supported for this instance type
        • false = CUDA is not supported for this instance type
      ssdSupport
      • Description: Indicates whether SSD is supported for this instance type. This attribute is the same as the supportsSsd attribute.

      • Type: Boolean

        • true = SSD is supported for this instance type
        • false = SSD is not supported for this instance type
    softwareSpec
    • Description: Identifies the configured software specification details for this instance type.
    • Type: Sequence of software details

      supports32Bit
      • Description: Indicates whether 32-bit architecture is supported for this instance type

        • true = 32-bit architecture is supported for this instance type
        • false = 32-bit architecture is not supported for this instance type
      • Type: Boolean
      supports64Bit
      • Description: Indicates whether 64-bit architecture is supported for this instance type

        • true = 64-bit architecture is supported for this instance type
        • false = 64-bit architecture is not supported for this instance type
      • Type: Boolean
      supports32BitOn64Bit
      • Description: Indicates support for both 32-bit and 64-bit architectures for this instance type

        • true = Both 32-bit and 64-bit architectures are supported for this instance type
        • false = Both 32-bit and 64-bit architectures are not supported for this instance type
      • Type: Boolean
      osName
      • Description: Type of operating system associated with this resource
      • Type: Enumeration

        EnumerationDescription
        LINUXThe associated resource is specific to the Linux operating system.
        WINDOWSThe associated resource is specific to the Windows operating system.
    costPerHour
    • Description:  The dollar price per hour to use this service. Only the user who created this service (service owner) can set this value (once) for all users using this service.
    • Type: Float
     supportsMonthlyBilling 
    • Description: Indicates whether monthly billing is supported for this tenant. See Tenant Billing for additional context.
      • true = Supports monthly billing for this tenant
      • false = Does not support monthly billing for this tenant
    • Type: Boolean
    vendorMultiplier
    • Description: The run time hour multiplier for run time (hrs) Usage Plan used to update the instance type price. This attribute is the same as the multiplier attribute.
    • Type: Float