Create Image

Details

API Details
Name

Create Image

Description

Creates a new image for the specified tenant.

MethodPOST
URIv1/tenants/tenantId/images
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
Notes
ESB Headeraction: create.tenants.tenantId.images

Example

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

Request Body

{
    "name": "Testing Ubuntu 1204 2",
    "description": "Testing Ubuntu 12.04",
    "visibility": "PUBLIC",
    "numOfNics": "1",
    "osName": "LINUX",
    "enabled": true,
    "imageType": "CLOUD_WORKER"
}

 

Response

{
    "id": "25",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/25",
    "perms": [],
    "name": "Testing Ubuntu 1204",
    "internalImageName": "7b29391b-b960-4793-b4fe-7a16fa745073",
    "description": "Testing Ubuntu 12.04",
    "visibility": "PUBLIC",
    "imageType": "CLOUD_WORKER",
    "osName": "LINUX",
    "tags": [],
    "numOfNics": 1,
    "tenantId": 1,
    "enabled": true,
    "systemImage": false,
    "detail": null,
    "count": 0
}

 

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

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

Required

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

Required

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.

Required

numOfNics
  • Description: The number of Network Interface Cards (NICs) attached to this instance type or cloud image.

  • Type: Integer
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.
enabled
  • Description: Indicates that this resource has been enabled.

    • true = resource has been enabled
    • false = resource has not been enabled (default)
  • Type: Boolean
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

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 more 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.

    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 JSONs

numOfNics
  • Description: The number of Network Interface Cards (NICs) attached to this instance type or cloud image.

  • Type: Integer

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

enabled
  • Description: Indicates that this resource has been enabled.

    • true = resource has been enabled
    • false = resource has not been enabled (default)
  • 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 query string does not have a parameter with the value=true in the request URL, 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