Sync Cloud Region Image Mappings

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameSync Cloud Region Image Mappings
Description

Syncs cloud image mappings from the Package Store – allows administrators to sync information when they see a change in the cloud provider image mapping definition 

Allowed Role(s)

WM_USER, WM_ADMIN

MethodPUT
URI

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


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

Sample Request
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds/1/regions/1/syncImageMappings"
curl -k -X POST -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/syncImageMappings"
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.
  • This API can only be invoked for one cloud region at a time; not all cloud regions belonging to a cloud.
  • A successful response returns a HTTP 200.
  • This API is only applicable:
    • For public clouds and currently only available for AWS and SoftLayer. See the Supported Public Clouds section for the relevant release for additional context.
    • For system images on supported clouds.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: update.tenants.tenantId.clouds.cloudId.regions.cloudRegionId.syncImageMappings

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/syncImageMappings",
  "size": 24,
  "pageNumber": 0,
  "totalElements": 24,
  "totalPages": 1,
  "cloudImages": [
    {
      "id": "1",
      "resource": null,
      "perms": [],
      "regionId": "1",
      "cloudProviderImageId": "ami-43201873",
      "launchUserName": "cloudcenter",
      "imageId": "15",
      "grantAndRevoke": false,
      "imageCloudAccountId": 0,
      "resources": [],
      "mappings": [
        {
          "id": "16",
          "cloudInstanceType": {
            "id": "24",
            "resource": null,
            "perms": [],
            "name": "i2.8xlarge",
            "description": "Storage Optimized - Current Generation(i2.8xlarge)",
            "type": "i2.8xlarge",
            "regionId": "1",
            "costPerHour": 6.82,
            "memorySize": 244000,
            "numOfCpus": 32,
            "numOfNics": 1,
            "localStorageSize": 6400,
            "supportsCuda": false,
            "supportsSsd": false,
            "supports32Bit": false,
            "supports64Bit": true
          },
          "costOverride": 9.836,
          "cloudProviderImageIdOverride": null
        },
        ...
        {
          "id": "1932",
          "cloudInstanceType": {
            "id": "35",
            "resource": null,
            "perms": [],
            "name": "Elastic Load Balancer",
            "description": "Elastic Load Balancer Instance",
            "type": "ELB",
            "regionId": "1",
            "costPerHour": 0.025,
            "memorySize": 0,
            "numOfCpus": 0,
            "numOfNics": 0,
            "localStorageSize": 0,
            "supportsCuda": false,
            "supportsSsd": false,
            "supports32Bit": false,
            "supports64Bit": false
          },
          "costOverride": 0,
          "cloudProviderImageIdOverride": null
        }
      ]
    }
  ]
}


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

Response Attributes

resource
  • Description: Unique URL to access this resource.
  • Type: String

See pageResource or Pagination for additional context

cloudImages
  • Description: Information about this cloud image
  • Type: Array of cloud image

    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