CliQr is now part of Cisco Learn More About Cisco

Create Cloud Image Mapping

Details

API Details
Name

Create Cloud Image Mapping

Description

Creates a new image mapping for the specified cloud region. See Manage Images  for additional context on mapping the logical image to ensure that this API call is successful.

MethodPOST
URIv1/tenants/tenantId/clouds/cloudId/regions/cloudRegionId/images
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Enhanced in CloudCenter 4.2 to include the supportHardwareProvision and the localStorageCount  attributes.
  • The supportsCuda and cudaSupport attributes are deprecated in CloudCenter 4.7.2.
Notes

API Notes:

Cloud Image Mapping Notes:

  • At least one valid entry in the mappings attribute is required for this API call to succeed.
  • The id attribute is required for each cloudInstanceType listed in the mappings array.
ESB Headeraction: create.tenants.tenantId.clouds.cloudId.regions.cloudRegionId.images

Example

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/images"

Request Body

Response

 

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 Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • 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

cloudProviderImageId
  • Description: Unique, system-generated identifier for a cloud provider image
  • Type: String

Required

launchUserName
  • Description: User name associated with an image
  • Type: String
mappings (click for additional details)
Icon

At least one cloudInstanceType and its corresponding ID are required for this API request to work.

As this API request only uses some mappings attributes, click to see all attributes.

grantAndRevoke
  • Description: Grants image permissions to permitted users on an as needed basis and revoke this access immediately after the permitted user has launched the image. See Grant Image Permissions for additional context.
    • true =Grant permission (default)
    • false = Revoke permission
  • Type: Boolean
regionId
  • DescriptionUnique, system-generated identifier for the cloud region 
  • Type: String
imageId
  • DescriptionUnique, system-generated identifier for a logically mapped image (see Manage Images for additional context).
  • 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
type
  • DescriptionThe type of resource
  • Type: String
regionId
  • DescriptionUnique, system-generated identifier for the cloud region 
  • Type: String
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
memorySize
  • DescriptionThe RAM size in MB for this Instance Type (see Map Images)
  • Type: Integer
numOfCpus
  • DescriptionThe number of CPUs for this instance type or cloud Image. This attribute is the same as the minNumberOfCpus attribute.
  • Type: Integer
numOfNics
  • Description: The number of Network Interface Cards (NICs) attached to this instance type or cloud image 

  • Type: Integer
localStorageSize
  • Description: The local storage size in GB
  • Type: Integer
supportsCuda (deprecated)
  • Description: Indicates whether CUDA is supported for this instance type. This attribute is the same as the cudaSupport attribute

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

  • Type: Boolean

    • true = SSD is supported for this instance type
    • false = SSD is not supported for this instance type
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
localStorageCount
  • Description: Enables a user to specify the number of additional instance stores (instance storage) that can attached to the Application VM. AWS use this concept of Instance Storage and CloudCenter enables users to create these additional stores using this attribute:
    • Default = 0
    • Minimum = 1
    • Maximum = 24
  • Type: Integer
supportsHardwareProvision 
  • Description: Identifies if hardware provisioning is supported (see Provision Bare Metal Hardware Servers for additional context:
    • true = Supports hardware provisioning
    • false = Does not support hardware provisioning
  • Type: Boolean