View Cloud Storage Type

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView Cloud Storage Type(s)
Description

Displays information for each storage type for the specified cloud region

Allowed Role(s)

WM_USER, WM_ADMIN

MethodGET
URI
  • v1/tenants/tenantId/clouds/cloudId/regions/cloudRegionId/storageTypes
  • v1/tenants/tenantId/clouds/cloudId/regions/cloudRegionId/storageTypes/storageTypeId


  • cloudcenter-cloud-setup/api/v1/tenants/tenantId/clouds/cloudId/regions/cloudRegionId/storageTypes
  • cloudcenter-cloud-setup/api/v1/tenants/tenantId/clouds/cloudId/regions/cloudRegionId/storageTypes/storageTypeId
Sample Request
curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/storageTypes"
curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-cloud-setup/api/v1/tenants/1/clouds/1/regions/1/storageTypes"
Release

Introduced in CloudCenter 4.7.0

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.

  • If you include a storageTypeId to identify a cloud storage, the response includes information for that cloud storage only.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.tenants.tenantId.clouds.cloudId.regions.cloudRegionId.storageTypes
  • action: get.tenants.tenantId.clouds.cloudId.regions.cloudRegionId.storageTypes.storageTypeId

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

Not applicable

Sample Response

{
   "resource":"https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/storageTypes",
   "size":5,
   "pageNumber":0,
   "totalElements":5,
   "totalPages":1,
   "cloudStorageTypes":[
      {
         "id":"1",
         "resource":"https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/storageTypes/1",
         "name":"Cold HDD",
         "description":"Lowest cost HDD volume designed for less frequently accessed workloads",
         "type":"sc1",
         "regionId":"1",
         "costPerMonth":0.025,
         "minVolumeSize":500,
         "maxVolumeSize":16000,
         "maxIOPS":250,
         "maxThroughput":250,
         "provisionedIOPS":false,
         "iopsCostPerMonth":0.0
      },
      {
         "id":"2",
         "resource":"https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/storageTypes/2",
         "name":"Provisioned IOPS SSD",
         "description":"Highest performance SSD volume designed for latency-sensitive transactional workloads",
         "type":"io1",
         "regionId":"1",
         "costPerMonth":0.125,
         "minVolumeSize":4,
         "maxVolumeSize":16000,
         "maxIOPS":20000,
         "maxThroughput":320,
         "provisionedIOPS":true,
         "iopsCostPerMonth":0.065
      },
      {
         "id":"3",
         "resource":"https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/storageTypes/3",
         "name":"Throughput Optimized HDD",
         "description":"Low cost HDD volume designed for frequently accessed, throughput intensive workloads",
         "type":"st1",
         "regionId":"1",
         "costPerMonth":0.045,
         "minVolumeSize":500,
         "maxVolumeSize":16000,
         "maxIOPS":500,
         "maxThroughput":500,
         "provisionedIOPS":false,
         "iopsCostPerMonth":0.0
      },
      {
         "id":"4",
         "resource":"https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/storageTypes/4",
         "name":"General Purpose SSD",
         "description":"General Purpose SSD volume for a wide variety of transactional workloads",
         "type":"gp2",
         "regionId":"1",
         "costPerMonth":0.1,
         "minVolumeSize":1,
         "maxVolumeSize":16000,
         "maxIOPS":10000,
         "maxThroughput":160,
         "provisionedIOPS":false,
         "iopsCostPerMonth":0.0
      },
      {
            "id": "5",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/storageTypes/5",
            "name": "Storage Type 01",
            "description": "Storage Type 01",
            "type": "st3",
            "regionId": "1",
            "costPerMonth": 1.33,
            "minVolumeSize": 1,
            "maxVolumeSize": 1600,
            "maxIOPS": 1000,
            "maxThroughput": 100,
            "provisionedIOPS": true,
            "iopsCostPerMonth": 0.34
       }
   ]
}

Example 2: A Specific Storage Type

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

Request Body

None.

Response

{
    "id": "5",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/storageTypes/1",
    "name": "Storage Type 01",
    "description": "Storage Type 01",
    "type": "st3",
    "regionId": "1",
    "costPerMonth": 1.32,
    "minVolumeSize": 1,
    "maxVolumeSize": 1600,
    "maxIOPS": 1000,
    "maxThroughput": 100,
    "provisionedIOPS": true,
    "iopsCostPerMonth": 0.34
}

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

  • Type: String

Required

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

  • Type: String

Required

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

Required

storageTypeId
  • DescriptionUnique, system-generated identifier for the configured storage device. See the Configure Cloud Storage section for the relevant release for additional context).
  • Type: String

Response Attributes

resource
  • Description: Unique URL to access this resource.
  • Type: String
See pageResource or Pagination for additional context
cloudStorageTypes
  • Description: Identifies details about each cloud storage type
  • Type: Array of cloudStorageTypes

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

    • Type: String

    resource
    • Description: Unique URL to access this resource.
    • Type: String
    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
    type
    • DescriptionThe type of resource
    • Type: String
    regionId
    • DescriptionUnique, system-generated identifier for the cloud region 

    • Type: String

     costPerMonth 
    • Description: Identifies the monthly billing cost for the storage type.
    • Type: Float
    minVolumeSize
    • Description: Identifies the minimum supported volume size for the storage type. The minimum acceptable storage size when configuring this attribute is 1GB.
    • Type: Integer
    maxVolumeSize
    • Description: Identifies the maximum supported volume size for the storage type. The maximum acceptable storage size when configuring this attribute is 4TB.
    • Type: Integer
    maxIOPS
    • Description: Identifies the maximum number of Input/Output Operations Per Second (allowed IOPS limit). If provisionedIOPS = true, then you must provide this limit for the storage type.
    • Type: Integer
    maxThroughput
    • Description: Identifies maximum throughput rate for the storage device. It is a property of the storage type and is not used in the storage cost calculation.
    • Type: Integer
    provisionedIOPS
    • Description: Identifies if the storage type supports IOPS.
    • Type: Boolean
      • true = The storage type supports IOPS.
      • false = Default. The storage type does not support IOPS.
     iopsCostPerMonth  
    • Description: Identifies the monthly billing IOPS cost for the storage type. Storage has two costs associated with it:
      • The storage size cost
      • The IOPS dependency cost — if provisionedIOPS = true, then based on the provisioned IOPS cost is calculated.
    • Type: Float



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