Update Cloud Image Mapping

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameUpdate Cloud Image Mapping
Description

Updates the specified image mapping for the identified cloud region

Allowed Role(s)

WM_USER, WM_ADMIN

MethodPUT
URI

v1/tenants/tenantId/clouds/cloudId/regions/regionId/images/cloudImageId


cloudcenter-cloud-setup/api/v1/v1/tenants/tenantId/clouds/cloudId/regions/regionId/images/cloudImageId

Sample Request
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/images/1"
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-cloud-setup/api/v1/tenants/1/clouds/1/regions/1/images/1"
Release
  • Introduced in CloudCenter 4.0
  • The supportsCuda and cudaSupport attributes are deprecated in CloudCenter 4.7.2
  • The grantAndRevoke attribute is deprecated in CloudCenter 4.9.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 cloudImageId to identify a cloud image, the response includes information for that cloud image only.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: update.tenants.tenantId.clouds.cloudId.regions.regionId.images.cloudImageId

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

Not applicable

Sample Request Body

Update the launchUserName from cloudcenter to CloudCenter:

{
  "id": "1",
  "resource": "https://<HOST:><PORT>/v1/tenants/1/clouds/1/regions/1/images/1",
  "perms": [],
  "regionId": "1",
  "cloudProviderImageId": "ami-43201873",
  "launchUserName": "cloudcenter",
  "imageId": "15",
  "grantAndRevoke": false,
  "imageCloudAccountId": 0,
  "resources": [],
  "mappings": [
    {
      "id": "12",
      "cloudInstanceType": {
        "id": "45",
        "resource": null,
        "perms": [],
        "name": "m2.4xlarge",
        "description": "High-memory Quadruple Extra Large Instance",
        "type": "m2.4xlarge",
        "regionId": "1",
        "costPerHour": 0.98,
        "memorySize": 68400,
        "numOfCPUs": 8,
        "numOfNICs": 1,
        "localStorageSize": 1690,
        "supportsCuda": false,
        "supportsSsd": false,
        "supports32Bit": false,
        "supports64Bit": true
      },
      "costOverride": 2.976,
      "cloudProviderImageIdOverride": null
    }
  ]
}

Response

{
  "id": "1",
  "resource": "https://<HOST>:>PORT>/v1/tenants/1/clouds/1/regions/1/images/1",
  "perms": [],
  "regionId": "1",
  "cloudProviderImageId": "ami-43201873",
  "launchUserName": "CloudCenter",
  "imageId": "15",
  "grantAndRevoke": false,
  "imageCloudAccountId": 0,
  "resources": [],
  "mappings": [
    {
      "id": "12",
      "cloudInstanceType": {
        "id": "45",
        "resource": null,
        "perms": [],
        "name": "m2.4xlarge",
        "description": "High-memory Quadruple Extra Large Instance",
        "type": "m2.4xlarge",
        "regionId": "1",
        "costPerHour": 0.98,
        "memorySize": 68400,
        "numOfCPUs": 8,
        "numOfNICs": 1,
        "localStorageSize": 1690,
        "supportsCuda": false,
        "supportsSsd": false,
        "supports32Bit": false,
        "supports64Bit": true
      }
    "costOverride": 2.976,
    "cloudProviderImageIdOverride": null
    }
  ]
}


Request Attributes

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

  • Type: String

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

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

Required

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)

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

  • Type: String

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

launchUserName
  • Description: User name associated with an image
  • Type: String

imageId
  • DescriptionUnique, system-generated identifier for a logically mapped image (see Manage Images for additional context).
  • Type: String

grantAndRevoke (Deprecated in CloudCenter 4.9.0)
  • 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.
    • true =Grant permission (default)
    • false = Revoke permission
  • Type: Boolean

imageCloudAccountId
  • DescriptionUnique, system-generated identifier for the image cloud account
  • Type: Integer

resources
  • Description: Properties for this image.
  • Type: Name-Value Pair (array)

mappings
  • Description: Information about the image mapping.
  • Type: Array of mapped data types

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

    • Type: String

    cloudInstanceType (click for additional details)

    costOverride
    • DescriptionProvides the ability to control and override prices. See the Track Cloud Costs section for the relevant release for additional details.
    • Type: Float
    cloudProviderImageIdOverride
    • Description: Alternative unique identifier for the cloud provider image. If specified, this value overrides the valued specified by cloudProviderImageId.
    • Type: String


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