CliQr is now part of Cisco Learn More About Cisco

Sync Cloud Region Image Mappings

Details

API Details
Name

Sync Cloud Region Image Mappings

Description
MethodPOST
URI

v1/tenants/tenantId/clouds/cloudId/regions/cloudRegionId/syncImageMappings

CloudCenter Release
  • Introduced in CloudCenter 4.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.
  • A successful response returns a HTTP 200.
  • This API is only applicable:
    • For Public Clouds and currently only available for AWS and SoftLayer.
ESB Headeraction: create.tenants.tenantId.clouds.cloudId.regions.cloudRegionId.syncImageMappings

Example

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"

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

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
    • 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

    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 Track Cloud Costs 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