View Image

Details

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

Updates an existing image for the specified tenant

Allowed Role(s)WM_USER
MethodGET
URI
  • v1/tenants/tenantId/images
  • v1/tenants/tenantId/images?detail=true
  • v1/tenants/tenantId/images/imageId
  • v1/tenants/tenantId/images/imageId?detail=true
  • cloudcenter-ccm-backend/api/v1/tenants/tenantId/images
  • cloudcenter-ccm-backend/api/v1/tenants/tenantId/images?detail=true
  • cloudcenter-ccm-backend/api/v1/tenants/tenantId/images/imageId
  • cloudcenter-ccm-backend/api/v1/tenants/tenantId/images/imageId?detail=true
Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/images"
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/tenants/1/images"
Release

Introduced in CloudCenter 4.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.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.tenants.tenantId.images
  • action: get.tenants.tenantId.images
    actionparam: detail=true
  • action: get.tenants.tenantId.images.imageId
  • action: get.tenants.tenantId.images.imageId
    actionparam: detail=true

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

Not applicable

Sample Response 1 – v1/tenants/tenantId/images

{
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/images",
    "size": 17,
    "pageNumber": 0,
    "totalElements": 17,
    "totalPages": 1,
    "images": [
        {
            "id": "2",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/2",
            "perms": [],
            "name": "Ubuntu 12.04",
            "internalImageName": "CloudWorker-Ubuntu12.04",
            "description": "Ubuntu 12.04",
            "visibility": "PUBLIC",
            "imageType": "CLOUD_WORKER",
            "osName": "LINUX",
            "tags": [],
            "numOfNics": 1,
            "tenantId": 1,
            "enabled": true,
            "systemImage": true,
            "detail": null,
            "count": 3
        },
        {
            "id": "4",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/4",
            "perms": [],
            "name": "CentOS 6.x",
            "internalImageName": "CloudWorker-CentOS6.x",
            "description": "CentOS 6.x",
            "visibility": "PUBLIC",
            "imageType": "CLOUD_WORKER",
            "osName": "LINUX",
            "tags": [],
            "numOfNics": 1,
            "tenantId": 1,
            "enabled": true,
            "systemImage": true,
            "detail": null,
            "count": 3
        },
        ...
        {
            "id": "24",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/24",
            "perms": [],
            "name": "Testing Ubuntu 1204",
            "internalImageName": "e96ee9bd-9227-4bd8-8212-13da9447c541",
            "description": "Testing Ubuntu 12.04",
            "visibility": "PUBLIC",
            "imageType": "CLOUD_WORKER",
            "osName": "LINUX",
            "tags": [],
            "numOfNics": 1,
            "tenantId": 1,
            "enabled": true,
            "systemImage": false,
            "detail": null,
            "count": 1
        }
    ]
}

Example 2 – v1/tenants/tenantId/images?detail=true

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB
"https://<HOST>:<PORT>/v1/tenants/1/images?detail=true"

Response

{
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/images?detail=true",
    "size": 17,
    "pageNumber": 0,
    "totalElements": 17,
    "totalPages": 1,
    "images": [
        {
            "id": "2",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/2",
            "perms": [],
            "name": "Ubuntu 12.04",
            "internalImageName": "CloudWorker-Ubuntu12.04",
            "description": "Ubuntu 12.04",
            "visibility": "PUBLIC",
            "imageType": "CLOUD_WORKER",
            "osName": "LINUX",
            "tags": [],
            "numOfNics": 1,
            "tenantId": 1,
            "enabled": true,
            "systemImage": true,
            "detail": {
                "count": 3,
                "cloudImages": [
                    {
                        "id": "9",
                        "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/9",
                        "perms": [],
                        "regionId": "2",
                        "cloudProviderImageId": "ami-f3d2a384",
                        "launchUserName": "ubuntu",
                        "imageId": "2",
                        "grantAndRevoke": false,
                        "imageCloudAccountId": 0,
                        "resources": [],
                        "mappings": [
                            {
                                "id": "187",
                                "cloudInstanceType": {
                                    "id": "46",
                                    "resource": "https://<HOST>:<PORT>/v1/tenants
/1/clouds/1/regions/1/instanceTypes/187",
                                    "perms": [],
                                    "name": "d2.2xlarge",
                                    "description": "Memory Optimized - Current Gen",
                                    "type": "d2.2xlarge",
                                    "regionId": "2",
                                    "costPerHour": 1.47,
                                    "memorySize": 62464,
                                    "numOfCpus": 8,
                                    "numOfNics": 1,
                                    "localStorageSize": 12000,
                                    "supportsCuda": false,
                                    "supportsSsd": false,
                                    "supports32Bit": false,
                                    "supports64Bit": true
                                },
                                "costOverride": 0,
                                "cloudProviderImageIdOverride": "ami-3928534e"
                            },
                            ...
                            {
                                "id": "178",
                                "cloudInstanceType": {
                                    "id": "16",
                                    "resource": "https://<HOST>:<PORT>/v1/tenants
/1/clouds/1/regions/1/instanceTypes/178",
                                    "perms": [],
                                    "name": "c4.8xlarge",
                                    "description": "Compute Optimized - Current Gen",
                                    "type": "c4.8xlarge",
                                    "regionId": "2",
                                    "costPerHour": 2.112,
                                    "memorySize": 61440,
                                    "numOfCpus": 36,
                                    "numOfNics": 1,
                                    "localStorageSize": 10,
                                    "supportsCuda": false,
                                    "supportsSsd": false,
                                    "supports32Bit": false,
                                    "supports64Bit": true
                                },
                                "costOverride": 0,
                                "cloudProviderImageIdOverride": "ami-3928534e"
                            }
                        ]
                    },
                    {
                        "id": "22",
                        "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/22",
                        "perms": [],
                        "regionId": "3",
                        "cloudProviderImageId": "ami-82904082",
                        "launchUserName": "ubuntu",
                        "imageId": "2",
                        "grantAndRevoke": false,
                        "imageCloudAccountId": 0,
                        "resources": [],
                        "mappings": [
                            {
                                "id": "486",
                                "cloudInstanceType": {
                                    "id": "106",
                                    "resource": "https://<HOST>:<PORT>/v1/tenants
/1/clouds/1/regions/1/instanceTypes/486",
                                    "perms": [],
                                    "name": "d2.xlarge",
                                    "description": "Memory Optimized - Current Gen",
                                    "type": "d2.xlarge",
                                    "regionId": "3",
                                    "costPerHour": 0.844,
                                    "memorySize": 31232,
                                    "numOfCpus": 4,
                                    "numOfNics": 1,
                                    "localStorageSize": 6000,
                                    "supportsCuda": false,
                                    "supportsSsd": false,
                                    "supports32Bit": false,
                                    "supports64Bit": true
                                },
                                "costOverride": 0,
                                "cloudProviderImageIdOverride": "ami-baf02aba"
                            },
                            {
                                "id": "493",
                                "cloudInstanceType": {
                                    "id": "80",
                                    "resource": "https://<HOST>:<PORT>/v1/tenants
/1/clouds/1/regions/1/instanceTypes/493",
                                    "perms": [],
                                    "name": "g2.2xlarge",
                                    "description": "Compute Opt - Current Gen(g2.2xL)",
                                    "type": "g2.2xlarge",
                                    "regionId": "3",
                                    "costPerHour": 0.898,
                                    "memorySize": 15000,
                                    "numOfCpus": 8,
                                    "numOfNics": 1,
                                    "localStorageSize": 60,
                                    "supportsCuda": false,
                                    "supportsSsd": false,
                                    "supports32Bit": false,
                                    "supports64Bit": true
                                },
                                "costOverride": 0,
                                "cloudProviderImageIdOverride": "ami-baf02aba"
                            },
                            ...
                            {
                                "id": "6",
                                "cloudInstanceType": {
                                    "id": "2",
                                    "resource": "https://<HOST>:<PORT>/v1/tenants
/1/clouds/1/regions/1/instanceTypes/6",
                                    "perms": [],
                                    "name": "m1.small",
                                    "description": null,
                                    "type": "00487266-7ba9-4652-8ad9-f57c78c2b073",
                                    "regionId": "1",
                                    "costPerHour": 0.2,
                                    "memorySize": 2048,
                                    "numOfCpus": 1,
                                    "numOfNics": 1,
                                    "localStorageSize": 20,
                                    "supportsCuda": false,
                                    "supportsSsd": false,
                                    "supports32Bit": true,
                                    "supports64Bit": true
                                },
                                "costOverride": 0,
                                "cloudProviderImageIdOverride": null
                            },
                            {
                                "id": "4",
                                "cloudInstanceType": {
                                    "id": "4",
                                    "resource": "https://<HOST>:<PORT>/v1/tenants
/1/clouds/1/regions/1/instanceTypes/4",
                                    "perms": [],
                                    "name": "m1.large",
                                    "description": null,
                                    "type": "c7a73497-df9b-4a82-b433-88932d325e1a",
                                    "regionId": "1",
                                    "costPerHour": 0.6,
                                    "memorySize": 8192,
                                    "numOfCpus": 4,
                                    "numOfNics": 1,
                                    "localStorageSize": 30,
                                    "supportsCuda": false,
                                    "supportsSsd": false,
                                    "supports32Bit": true,
                                    "supports64Bit": true
                                },
                                "costOverride": 0,
                                "cloudProviderImageIdOverride": null
                            }
                        ]
                    }
                ]
            },
            "count": 3
        },
        ...
        {
            "id": "24",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/24",
            "perms": [],
            "name": "Testing Ubuntu 1204",
            "internalImageName": "e96ee9bd-9227-4bd8-8212-13da9447c541",
            "description": "Testing Ubuntu 12.04",
            "visibility": "PUBLIC",
            "imageType": "CLOUD_WORKER",
            "osName": "LINUX",
            "tags": [],
            "numOfNics": 1,
            "tenantId": 1,
            "enabled": true,
            "systemImage": false,
            "detail": {
                "count": 1,
                "cloudImages": [
                    {
                        "id": "39",
                        "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/39",
                        "perms": [],
                        "regionId": "1",
                        "cloudProviderImageId": "73a55133-749f-4cde-b80e-332781ae9b99",
                        "launchUserName": "centos",
                        "imageId": "24",
                        "grantAndRevoke": false,
                        "imageCloudAccountId": 0,
                        "resources": [],
                        "mappings": [
                            {
                                "id": "710",
                                "cloudInstanceType": {
                                    "id": "6",
                                    "resource": "https://<HOST>:<PORT>/v1/tenants
/1/clouds/1/regions/1/instanceTypes/710",
                                    "perms": [],
                                    "name": "m3.small",
                                    "description": null,
                                    "type": "bdfbfd3e-c979-430e-b242-8dd3678d7466",
                                    "regionId": "1",
                                    "costPerHour": 0.4,
                                    "memorySize": 4096,
                                    "numOfCpus": 1,
                                    "numOfNics": 1,
                                    "localStorageSize": 30,
                                    "supportsCuda": false,
                                    "supportsSsd": false,
                                    "supports32Bit": true,
                                    "supports64Bit": true
                                },
                                "costOverride": 0,
                                "cloudProviderImageIdOverride": null
                            },
                            {
                                "id": "711",
                                "cloudInstanceType": {
                                    "id": "2",
                                    "resource": "https://<HOST>:<PORT>/v1/tenants
/1/clouds/1/regions/1/instanceTypes/2",
                                    "perms": [],
                                    "name": "m1.small",
                                    "description": null,
                                    "type": "00487266-7ba9-4652-8ad9-f57c78c2b073",
                                    "regionId": "1",
                                    "costPerHour": 0.2,
                                    "memorySize": 2048,
                                    "numOfCpus": 1,
                                    "numOfNics": 1,
                                    "localStorageSize": 20,
                                    "supportsCuda": false,
                                    "supportsSsd": false,
                                    "supports32Bit": true,
                                    "supports64Bit": true
                                },
                                "costOverride": 0,
                                "cloudProviderImageIdOverride": "73a55133-749f-4cde-b80e-332781ae9b98"
                            }
                        ]
                    }
                ]
            },
            "count": 1
        }
    ]
}

Example 3 – v1/tenants/tenantId/images/imageId

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB
"https://<HOST>:<PORT>/v1/tenants/1/images/24"

Response

{
    "id": "24",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/24",
    "perms": [],
    "name": "Testing Ubuntu 1204",
    "internalImageName": "e96ee9bd-9227-4bd8-8212-13da9447c541",
    "description": "Testing Ubuntu 12.04",
    "visibility": "PUBLIC",
    "imageType": "CLOUD_WORKER",
    "osName": "LINUX",
    "tags": [],
    "numOfNics": 1,
    "tenantId": 1,
    "enabled": true,
    "systemImage": false,
    "detail": null,
    "count": 1
}

Example 4 – v1/tenants/tenantId/images/imageId?detail=true

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB
"https://<HOST>:<PORT>/v1/tenants/1/images/24?detail=true"

Response

{
    "id": "24",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/24?detail=true",
    "perms": [],
    "name": "Testing Ubuntu 1204",
    "internalImageName": "e96ee9bd-9227-4bd8-8212-13da9447c541",
    "description": "Testing Ubuntu 12.04",
    "visibility": "PUBLIC",
    "imageType": "CLOUD_WORKER",
    "osName": "LINUX",
    "tags": [],
    "numOfNics": 1,
    "tenantId": 1,
    "enabled": true,
    "systemImage": false,
    "detail": {
        "count": 1,
        "cloudImages": [
            {
                "id": "39",
                "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/39",
                "perms": [],
                "regionId": "1",
                "cloudProviderImageId": "73a55133-749f-4cde-b80e-332781ae9b99",
                "launchUserName": "centos",
                "imageId": "24",
                "grantAndRevoke": false,
                "imageCloudAccountId": 0,
                "resources": [],
                "mappings": [
                    {
                        "id": "710",
                        "cloudInstanceType": {
                            "id": "6",
                            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds
/1/regions/1/instanceTypes/6",
                            "perms": [],
                            "name": "m3.small",
                            "description": null,
                            "type": "bdfbfd3e-c979-430e-b242-8dd3678d7466",
                            "regionId": "1",
                            "costPerHour": 0.4,
                            "memorySize": 4096,
                            "numOfCpus": 1,
                            "numOfNics": 1,
                            "localStorageSize": 30,
                            "supportsCuda": false,
                            "supportsSsd": false,
                            "supports32Bit": true,
                            "supports64Bit": true
                        },
                        "costOverride": 0,
                        "cloudProviderImageIdOverride": null
                    },
                    {
                        "id": "711",
                        "cloudInstanceType": {
                            "id": "2",
                            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds
/1/regions/1/instanceTypes/2",
                            "perms": [],
                            "name": "m1.small",
                            "description": null,
                            "type": "00487266-7ba9-4652-8ad9-f57c78c2b073",
                            "regionId": "1",
                            "costPerHour": 0.2,
                            "memorySize": 2048,
                            "numOfCpus": 1,
                            "numOfNics": 1,
                            "localStorageSize": 20,
                            "supportsCuda": false,
                            "supportsSsd": false,
                            "supports32Bit": true,
                            "supports64Bit": true
                        },
                        "costOverride": 0,
                        "cloudProviderImageIdOverride": "73a55133-749f-4cde-b80e-332781ae9b98"
                    }
                ]
            }
        ]
    },
    "count": 1
}


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

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

Response Attributes

resource
  • Description: Unique URL to access this resource.
  • Type: String
See pageResource or Pagination for additional context

images
  • Description: Identifies details about each image
  • Type: Array of images

    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

    internalImageName
    • Description: The internal name for this image 
    • Type: String
    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    visibility
    • Description: Indicates the type of user to which this image is visible
    • Type: Enumeration

      EnumerationDescription
      PRIVATEThis image is visible only to the tenant owner admin
      PUBLICThis image is visible to all tenants and users.
      PUBLISHEDThis image is visible only to tenant users.
    imageType
    • Description: Identifies whether this image is for the CCO or the application VM
    • Type: Enumeration

      EnumerationDescription
      CLOUD_GATEWAYThe CCO image
      CLOUD_WORKERThe application VM image
    osName
    • Description: Type of operating system associated with this resource
    • Type: Enumeration

      EnumerationDescription
      LINUXThe associated resource is specific to the Linux operating system.
      WINDOWSThe associated resource is specific to the Windows operating system.
    tags
    • DescriptionTags associated with this resource. Each string represents a system tag. See the System Tags section for the relevant release for additional context.

      If you filter reports based on tags that you applied to VMs or jobs, then the report displays all the VMs or jobs that have this exact combination of tags.

    • Type: Array of strings

    enabled
    • Description: Indicates that this resource has been enabled. The default differs based on the resource.

      • true = The resource has been enabled (v2 aging and suspension policies are enabled by default).

      • false = The resource has not been enabled.

    • Type: Boolean

    systemImage
    • Description: Indicates whether this image is a predefined system image (see Manage Images for additional context):
      • true =  A predefined system image
      • false = Not a predefined system image
    • Type: Boolean 

    detail (click for more details)

    If the request URL does not have a detail query parameter with the value=true, then this field displays null.

    count
    • Description: The number of times that this phase bundle was added/attached.

      On successful image creation, this value will always remain 0.

    • TypeInteger

     




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