// removed jquery ui css and js

Import Application

Details

API Details
Name

Import Application.

Description

Import an application that has been successfully exported. See Deployment Export/Import for additional context.

MethodPOST
URI

v1/imports/request (initial request)
v1/imports (subsequent request)

CloudCenter ReleaseIntroduced in CloudCenter 4.5.7
Notes
  • Available in CloudCenter 4.5.7.
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The repositoryId, pathValue, and password attributes are used in both stages of the import process.

  • The attributes in each stage are marked Required in the related Request Attributes section.

    Above attributes are required in 2nd stage as well.

ESB Header
  • action: create.imports.request (initial request)
  • action: create.imports (subsequent request)

Example

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/imports"

Initial Request Body

{
    "repositoryId": "1",
    "pathValue": "NOV28/Tap/13",
    "password": "===redacted==="
}

Initial Response

{
    "id": "0",
    "resource": "https://<HOST>:<PORT>/v1/imports/request",
    "perms": [],
    "password": "===redacted===",
    "depEnvId": null,
    "specifications": [],
    "childJobPortSpecs": [{
        "id": "1",
        "resource": "https://<HOST>:<PORT>/v1/imports/request/1",
        "perms": [],
        "password": null,
        "depEnvId": null,
        "specifications": [{
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "SERVICE_DEFINITION",
            "value": "true"
        }, {
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "APP_DATA_BACKUP",
            "value": "true"
        }, {
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "APP_DEFINITION",
            "value": "true"
        }],
        "childJobPortSpecs": [],
        "createDate": null,
        "status": null,
        "workflowInstance": null,
        "repositoryId": null,
        "cloudAccountId": null,
        "pathValue": null,
        "artifactRepositoryId": null,
        "artifactPathValue": null,
        "cloudType": null,
        "appName": null,
        "appVersion": null,
        "exportedServiceName": "CentOS",
        "tierName": "CentOS_3",
        "mappedServiceName": null,
        "exportedImageName": "CentOS 6.x",
        "exportedImageId": "ami-08ff9768",
        "importService": false,
        "exportedImageMappings": [{
            "importImage": false,
            "mappedImageName": null,
            "exportedImageName": "CentOS 5.x",
            "exportedImageId": null
        }, {
            "importImage": false,
            "mappedImageName": null,
            "exportedImageName": "CentOS 6.x",
            "exportedImageId": null
        }, {
            "importImage": false,
            "mappedImageName": null,
            "exportedImageName": "CentOS 7.x",
            "exportedImageId": null
        }],
        "importedAppId": null
    }, {
        "id": "2",
        "resource": "https://<HOST>:<PORT>/v1/imports/request/2",
        "perms": [],
        "password": null,
        "depEnvId": null,
        "specifications": [{
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "APP_DEFINITION",
            "value": "true"
        }, {
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "SERVICE_DEFINITION",
            "value": "true"
        }, {
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "APP_DATA_BACKUP",
            "value": "true"
        }],
        "childJobPortSpecs": [],
        "createDate": null,
        "status": null,
        "workflowInstance": null,
        "repositoryId": null,
        "cloudAccountId": null,
        "pathValue": null,
        "artifactRepositoryId": null,
        "artifactPathValue": null,
        "cloudType": null,
        "appName": null,
        "appVersion": null,
        "exportedServiceName": "CentOS",
        "tierName": "CentOS_2",
        "mappedServiceName": null,
        "exportedImageName": "CentOS 5.x",
        "exportedImageId": "ami-a9611dc9",
        "importService": false,
        "exportedImageMappings": [{
            "importImage": false,
            "mappedImageName": null,
            "exportedImageName": "CentOS 5.x",
            "exportedImageId": null
        }, {
            "importImage": false,
            "mappedImageName": null,
            "exportedImageName": "CentOS 6.x",
            "exportedImageId": null
        }, {
            "importImage": false,
            "mappedImageName": null,
            "exportedImageName": "CentOS 7.x",
            "exportedImageId": null
        }],
        "importedAppId": null
    }],
    "createDate": null,
    "status": null,
    "workflowInstance": null,
    "repositoryId": "1",
    "cloudAccountId": null,
    "pathValue": "NOV28/Tap/13",
    "artifactRepositoryId": null,
    "artifactPathValue": null,
    "cloudType": null,
    "appName": "2Tier_IMP",
    "appVersion": "5.8",
    "exportedServiceName": null,
    "tierName": null,
    "mappedServiceName": null,
    "exportedImageName": null,
    "exportedImageId": null,
    "importService": false,
    "exportedImageMappings": [],
    "importedAppId": null
}

Subsequent Request Body

{
    "id": "0",
    "resource": "https://<HOST>:<PORT>/v1/imports/request",
    "perms": [],
    "password": "===redacted===",
    "depEnvId": "1",
    "specifications": [],
    "childJobPortSpecs": [{
        "id": "1",
        "resource": "https://<HOST>:<PORT>/v1/imports/request/1",
        "perms": [],
        "password": null,
        "depEnvId": null,
        "specifications": [{
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "SERVICE_DEFINITION",
            "value": true
        }, {
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "APP_DEFINITION",
            "value": true
        }, {
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "APP_DATA_BACKUP",
            "value": true
        }],
        "childJobPortSpecs": [],
        "createDate": null,
        "status": null,
        "workflowInstance": null,
        "repositoryId": null,
        "cloudAccountId": null,
        "pathValue": null,
        "artifactRepositoryId": null,
        "artifactPathValue": null,
        "cloudType": null,
        "appName": null,
        "appVersion": null,
        "exportedServiceName": "CentOS",
        "tierName": "CentOS_3",
        "mappedServiceName": "testname",
        "exportedImageName": "CentOS6. x ",
        "exportedImageId ": "ami - 08 ff9768 ",
        "importService ": true,
        "exportedImageMappings ": [{
            "importImage ": false,
            "mappedImageName ": null,
            "exportedImageName ": "CentOS 5. x ",
            "exportedImageId ": null
        }, {
            "importImage ": false,
            "mappedImageName ": null,
            "exportedImageName ": "CentOS 6. x ",
            "exportedImageId ": null
        }, {
            "importImage ": false,
            "mappedImageName ": null,
            "exportedImageName ": "CentOS 7. x ",
            "exportedImageId ": null
        }],
        "importedAppId ": null
    }, {
        "id ": "2 ",
        "resource ": "https: //<HOST>:<PORT>/v1/imports/request/2",
        "perms": [],
        "password": null,
        "depEnvId": null,
        "specifications": [{
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "APP_DEFINITION",
            "value": true
        }, {
            "id": "0",
            "resource": null,
            "perms": [],
            "specType": "APP_DATA_BACKUP",
            "value": true
        }],
        "childJobPortSpecs": [],
        "createDate": null,
        "status": null,
        "workflowInstance": null,
        "repositoryId": null,
        "cloudAccountId": null,
        "pathValue": null,
        "artifactRepositoryId": null,
        "artifactPathValue": null,
        "cloudType": null,
        "appName": null,
        "appVersion": null,
        "exportedServiceName": "CentOS",
        "tierName": "CentOS_2",
        "mappedServiceName": "CentOS",
        "exportedImageName": "CentOS 5.x",
        "exportedImageId ": "ami - a9611dc9 ",
        "importService ": false,
        "exportedImageMappings ": [{
            "importImage ": false,
            "mappedImageName ": null,
            "exportedImageName ": "CentOS 5. x ",
            "exportedImageId ": null
        }, {
            "importImage ": false,
            "mappedImageName ": null,
            "exportedImageName ": "CentOS 6. x ",
            "exportedImageId ": null
        }, {
            "importImage ": false,
            "mappedImageName ": null,
            "exportedImageName ": "CentOS 7. x ",
            "exportedImageId ": null
        }],
        "importedAppId ": null
    }],
    "createDate ": null,
    "status ": null,
    "workflowInstance ": null,
    "repositoryId ": "1 ",
    "cloudAccountId ": "1 ",
    "pathValue ": "NOV28 / Tap / 13 ",
    "artifactRepositoryId ": "1 ",
    "artifactPathValue ": "Import / Tap ",
    "cloudType ": "AWSCloud - us - west - 1 ",
    "appName ": "Tap ",
    "appVersion ": "5.8 ",
    "exportedServiceName ": null,
    "tierName ": null,
    "mappedServiceName ": null,
    "exportedImageName ": null,
    "exportedImageId ": null,
    "importService ": false,
    "exportedImageMappings ": [],
    "importedAppId ": null
}

Subsequent Response – Example 1

{
    "id": "4",
    "resource": "https://<HOST>:<PORT>/v1/imports",
    "perms": [],
    "password": "===redacted===",
    "depEnvId": 1,
    "specifications": [],
    "childJobPortSpecs": [{
        "id": "5",
        "resource": "https://<HOST>:<PORT>/v1/imports/5",
        "perms": [],
        "password": null,
        "depEnvId": null,
        "specifications": [{
            "id": "5",
            "resource": null,
            "perms": [],
            "specType": "APP_DATA_BACKUP",
            "value": "true"
        }, {
            "id": "6",
            "resource": null,
            "perms": [],
            "specType": "SERVICE_DEFINITION",
            "value": "true"
        }, {
            "id": "7",
            "resource": null,
            "perms": [],
            "specType": "APP_DEFINITION",
            "value": "true"
        }],
        "childJobPortSpecs": [],
        "createDate": 1480380662000,
        "status": null,
        "workflowInstance": null,
        "repositoryId": null,
        "cloudAccountId": null,
        "pathValue": null,
        "artifactRepositoryId": null,
        "artifactPathValue": null,
        "cloudType": null,
        "appName": null,
        "appVersion": null,
        "exportedServiceName": "CentOS",
        "tierName": "CentOS_3",
        "mappedServiceName": "testname",
        "exportedImageName": "CentOS 6.x",
        "exportedImageId": null,
        "importService": true,
        "exportedImageMappings": [],
        "importedAppId": null
    }, {
        "id": "6",
        "resource": "https://<HOST>:<PORT>/v1/imports/6",
        "perms": [],
        "password": null,
        "depEnvId": null,
        "specifications": [{
            "id": "9",
            "resource": null,
            "perms": [],
            "specType": "APP_DATA_BACKUP",
            "value": "true"
        }, {
            "id": "8",
            "resource": null,
            "perms": [],
            "specType": "APP_DEFINITION",
            "value": "true"
        }],
        "childJobPortSpecs": [],
        "createDate": 1480380662000,
        "status": null,
        "workflowInstance": null,
        "repositoryId": null,
        "cloudAccountId": null,
        "pathValue": null,
        "artifactRepositoryId": null,
        "artifactPathValue": null,
        "cloudType": null,
        "appName": null,
        "appVersion": null,
        "exportedServiceName": "CentOS",
        "tierName": "CentOS_2",
        "mappedServiceName": "CentOS",
        "exportedImageName": "CentOS 5.x",
        "exportedImageId": null,
        "importService": false,
        "exportedImageMappings": [],
        "importedAppId": null
    }],
    "createDate": 1480380661000,
    "status": "RUNNING",
    "workflowInstance": {
        "workflowId": "importWorkflow",
        "name": "Import Application Deployment",
        "description": "Import Application Deployment",
        "startTime": 1480380661803,
        "endTime": null,
        "state": "RUNNING",
        "activityExecution": {
            "activityId": "processMetadataActivity",
            "name": "Process Application Metadata",
            "description": "Process Application Metadata",
            "startTime": 1480380661803,
            "endTime": null,
            "state": "RUNNING",
            "progress": null,
            "next": null,
            "subExecutions": [],
            "id": "f61c90d7-16c6-4e16-b57b-81d18a985386"
        },
        "id": "4ca99413-2769-4c93-a4a1-be5f94359909"
    },
    "repositoryId": "1",
    "cloudAccountId": "1",
    "pathValue": "NOV28/Tap/13",
    "artifactRepositoryId": "1",
    "artifactPathValue": "Import/Tap",
    "cloudType": "AWSCloud-us-west-1",
    "appName": "Tap",
    "appVersion": "5.8",
    "exportedServiceName": null,
    "tierName": null,
    "mappedServiceName": null,
    "exportedImageName": null,
    "exportedImageId": null,
    "importService": false,
    "exportedImageMappings": [],
    "importedAppId": null
}

Subsequent Response – Example 2 (with an imported image for one of the tiers)

{
    "id": "7",
    "resource": "https://<HOST>:<PORT>/v1/imports",
    "perms": [],
    "password": "===redacted===",
    "depEnvId": 1,
    "specifications": [],
    "childJobPortSpecs": [{
        "id": "8",
        "resource": "https://<HOST>:<PORT>/v1/imports/8",
        "perms": [],
        "password": null,
        "depEnvId": null,
        "specifications": [{
            "id": "11",
            "resource": null,
            "perms": [],
            "specType": "APP_DEFINITION",
            "value": "true"
        }, {
            "id": "10",
            "resource": null,
            "perms": [],
            "specType": "SERVICE_DEFINITION",
            "value": "true"
        }, {
            "id": "12",
            "resource": null,
            "perms": [],
            "specType": "APP_DATA_BACKUP",
            "value": "true"
        }],
        "childJobPortSpecs": [],
        "createDate": 1480381272000,
        "status": null,
        "workflowInstance": null,
        "repositoryId": null,
        "cloudAccountId": null,
        "pathValue": null,
        "artifactRepositoryId": null,
        "artifactPathValue": null,
        "cloudType": null,
        "appName": null,
        "appVersion": null,
        "exportedServiceName": "CentOS",
        "tierName": "CentOS_1",
        "mappedServiceName": "CentOsImport",
        "exportedImageName": "CentOS 6.x",
        "exportedImageId": null,
        "importService": true,
        "exportedImageMappings": [],
        "importedAppId": null
    }],
    "createDate": 1480381272000,
    "status": "RUNNING",
    "workflowInstance": {
        "workflowId": "importWorkflow",
        "name": "Import Application Deployment",
        "description": "Import Application Deployment",
        "startTime": 1480381271777,
        "endTime": null,
        "state": "RUNNING",
        "activityExecution": {
            "activityId": "processMetadataActivity",
            "name": "Process Application Metadata",
            "description": "Process Application Metadata",
            "startTime": 1480381271777,
            "endTime": null,
            "state": "RUNNING",
            "progress": null,
            "next": null,
            "subExecutions": [],
            "id": "3cca2183-06cb-4db5-a95a-3de3f7312086"
        },
        "id": "656e9e88-b908-4155-964d-49fb9823643a"
    },
    "repositoryId": "1",
    "cloudAccountId": "1",
    "pathValue": "NOV28/CENTOS_1/16",
    "artifactRepositoryId": "1",
    "artifactPathValue": "NOV28/CENTOS_1/Import",
    "cloudType": "AWSCloud-us-west-1",
    "appName": "CENTOS_BaseImage",
    "appVersion": "4.0",
    "exportedServiceName": null,
    "tierName": null,
    "mappedServiceName": null,
    "exportedImageName": null,
    "exportedImageId": null,
    "importService": false,
    "exportedImageMappings": [{
        "importImage": false,
        "mappedImageName": "CentOS 7.x",
        "exportedImageName": "CentOS 7.x",
        "exportedImageId": null
    }, {
        "importImage": true,
        "mappedImageName": "CentOs6Imported",
        "exportedImageName": "CentOS 6.x",
        "exportedImageId": null
    }, {
        "importImage": false,
        "mappedImageName": "CentOS 5.x",
        "exportedImageName": "CentOS 5.x",
        "exportedImageId": null
    }],
    "importedAppId": null
} 

Initial Request Attributes

repositoryId
  • Description: Unique, system-generated identifier for the repository.  See Artifact Repository and Share Artifact Repositories for additional context. This ID refers to the location where the exported CloudCenter ZIP file is stored.
  • Type: String

Required.

pathValue
  • Description: The username credentials expected by the CloudCenter platform when you export applications. Provide a valid path on the repository. If the folder does not exist in this path, CloudCenter attempts to create the folder provided you have the appropriate permissions for this repository. This field does not accept email addresses.
  • Type: String

Required.

password
  • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
  • Type: String

Required.

Subsequent Request Attributes

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

  • Type: String

Required

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

perms

 Click here to expand...

perms
  • Description: The permissions for a CloudCenter Resource managed by ACLs.

  • Type: Array of strings

    resourceName Permissions →

    Enumeration ↓

    read
    write
    create
    delete
    administration
    executemove_in
    move_out
    access
    approve
    authorize
    managenotify

    POLICY

    YesYes   

    ACTION_POLICY

    Yes    

    PUBLISHED_APP

    Yes    

    DEPLOYMENT_ENVIRONMENT 

    YesYesYesYes 

    APPLICATION

    Yes

    Yes

       

    REPOSITORY

    Yes    

    CLOUD_ACCOUNT 

    Yes    

    SYSTEM_TAG

    Yes    

    SECURITY_PROFILE

    Yes    

    SERVICE

    Yes    

    CUSTOM_ACTION

    Yes  Yes 
    PROJECTYes   Yes
    IMAGEYes    
    MANAGE_EXPORTYesYes   
    MANAGE_IMPORTYesYes   

password
  • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
  • Type: String

Required.

depEnvId
  • DescriptionUnique, system-generated identifier for the deployment environment. See Deployment Environments for additional details. This attribute is the same as the environmentId attribute.
  • Type: String

Required.

specifications
  • Description: Identifies the approach used to export applications for each tier. See Application Export/Import for additional context.
  • Type: Array of specification types

    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)

    specType
    • Description: Identifies the option(s) used to export applications. See Deployment Export/Import for additional context.
    • Type: Enumeration

      EnumerationDescription
      APP_DEFINITIONThe default component-based approach to export applications. Suitable for multi-tier applications and cross-cloud environments (requires knowledge of the CloudCenter application configuration procedures and processes).
      If you set this option to true, you cannot configure the VM_SNAPSHOT option as true.
      BASE_IMAGE Only available for the APP_DEFINITION  approach. If specified, the images that the services depend on are also exported.
      SERVICE_DEFINITION 
      Only available for the APP_DEFINITION  approach. If specified, the CloudCenter service definition is exported. If you additionally select the Base Image option, the corresponding image is also exported.
      APP_DATA_BACKUPOnly available for the APP_DEFINITION  approach. if specified, the data backup script is run and the backup data is persisted in the repository for future restoration.
      VM_SNAPSHOT The alternate approach to export applications. Only possible if the application is tightly coupled with the underlying OS.
      If you set this option to true, you cannot configure the APP_DEFINITION option as true.
    value
    • Description: Identifies the value setting for this specType property.
    • Type: Boolean
      • true: This setting is configured.
      • false: (Default) This setting is not configured.

Required

 Click here to expand...

childJobPortSpecs
  • Description: Identifies the approach used to export applications for each tier. See Application Export/Import for additional context.
  • Type: Array of specification types

    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)

    jobId
    • DescriptionUnique, system-generated identifier for the job
    • Type: String

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

    • Type: String

    specifications
    • Description: Identifies the approach used to export applications for each tier. See Application Export/Import for additional context.
    • Type: Array of specification types

      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)

      specType
      • Description: Identifies the option(s) used to export applications. See Deployment Export/Import for additional context.
      • Type: Enumeration

        EnumerationDescription
        APP_DEFINITIONThe default component-based approach to export applications. Suitable for multi-tier applications and cross-cloud environments (requires knowledge of the CloudCenter application configuration procedures and processes).
        If you set this option to true, you cannot configure the VM_SNAPSHOT option as true.
        BASE_IMAGE Only available for the APP_DEFINITION  approach. If specified, the images that the services depend on are also exported.
        SERVICE_DEFINITION 
        Only available for the APP_DEFINITION  approach. If specified, the CloudCenter service definition is exported. If you additionally select the Base Image option, the corresponding image is also exported.
        APP_DATA_BACKUPOnly available for the APP_DEFINITION  approach. if specified, the data backup script is run and the backup data is persisted in the repository for future restoration.
        VM_SNAPSHOT The alternate approach to export applications. Only possible if the application is tightly coupled with the underlying OS.
        If you set this option to true, you cannot configure the APP_DEFINITION option as true.
      value
      • Description: Identifies the value setting for this specType property.
      • Type: Boolean
        • true: This setting is configured.
        • false: (Default) This setting is not configured.

    childJobPortSpecs (at the child level)

    createDate
    • DescriptionIndicates when the account was created for this trial user
    • Type: Long
    status
    • Description: Status of the job/deployment. See Deployment and VM States for additional context.
    • Type: Enumeration

      EnumerationDescription
      allAll jobs or deployments in this CloudCenter instance.
      runningRunning (successful) jobs or deployments in this CloudCenter instance.
      activeActive (any live state, in addition to the running state) jobs or deployments in this CloudCenter instance.
    workflowInstance
    • Description: Identifies detailed information about the executed workflow activity.
    • Type: Sequence of workflow attributes

       workflowId 
      • DescriptionUnique, system-generated identifier for the benchmark.
      • Type: String
      name
      • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

      • Type: String

      description
      • DescriptionA brief description for this CloudCenter Resource.

      • Type: String
      startTime
      endTime
      state
      • Description: Identifies the state of the executed workflow or activity.

      • Status: Enumeration

        EnumerationDescription
        NOT_STARTEDThe executed workflow or activity has not started.
        RUNNING The executed workflow or activity is successfully running.
        FINISHED  
        The executed workflow or activity is complete.
        ERROR 
        The executed workflow or activity encountered an error during execution.
        ABORTEDThe executed workflow or activity was cancelled.
        WAITING The executed workflow or activity is pending the completion of another agent/component/activity.
      activityExecution (click for additional details)
      id
      • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

      • Type: String
    deleted
    • Description: Identifies if this resource is deleted in the CloudCenter platform.
    • Type: Boolean
      • true = The resource is deleted.
      • false = The resource is not deleted.
    appName
    • Description: The name of the application in use.
    • Type: String
    appVersion
    • Description: The application build version with which a new job is started. If the appVersion is not specified, the latest application build version is used.

    • Type: String
    appId
    • Description: Unique, system-generated identifier for the application profile. You can provide multiple application profile IDs as input parameters.

    • Type: String

createDate
  • DescriptionIndicates when the account was created for this trial user
  • Type: Long
status
  • Description: Status of the job/deployment. See Deployment and VM States for additional context.
  • Type: Enumeration

    EnumerationDescription
    allAll jobs or deployments in this CloudCenter instance.
    runningRunning (successful) jobs or deployments in this CloudCenter instance.
    activeActive (any live state, in addition to the running state) jobs or deployments in this CloudCenter instance.

workflowInstance 

 Click here to expand...

workflowInstance
  • Description: Identifies detailed information about the executed workflow activity.
  • Type: Sequence of workflow attributes

     workflowId 
    • DescriptionUnique, system-generated identifier for the benchmark.
    • Type: String
    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    startTime
    endTime
    state
    • Description: Identifies the state of the executed workflow or activity.

    • Status: Enumeration

      EnumerationDescription
      NOT_STARTEDThe executed workflow or activity has not started.
      RUNNING The executed workflow or activity is successfully running.
      FINISHED  
      The executed workflow or activity is complete.
      ERROR 
      The executed workflow or activity encountered an error during execution.
      ABORTEDThe executed workflow or activity was cancelled.
      WAITING The executed workflow or activity is pending the completion of another agent/component/activity.
    activityExecution (click for additional details)
    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String

repositoryId
  • Description: Unique, system-generated identifier for the repository.  See Artifact Repository and Share Artifact Repositories for additional context. This ID refers to the location where the exported CloudCenter ZIP file is stored.
  • Type: String

Required

cloudAccountId
  • Description: Unique, system-generated identifier for the cloudAccount
  • Type: String

Required

pathValue
  • Description: The username credentials expected by the CloudCenter platform when you export applications. Provide a valid path on the repository. If the folder does not exist in this path, CloudCenter attempts to create the folder provided you have the appropriate permissions for this repository. This field does not accept email addresses.
  • Type: String

Required

artifactRepositoryId
  • Description: Unique, system-generated identifier for the artifact repository. See Artifact Repository and Share Artifact Repositories for additional context. It is the location where the imported artifacts are stored and the imported CloudCenter resources such as application profiles and services point to this repository.
  • Type: String

Required

artifactPathValue
  • Description: The username credential expected by the CloudCenter platform for the artifact location when you export/import applications. If this value is an email address, provide the email as shown in the request and response examples.
  • Type: String

Required

cloudType
  • Description: The type of associated cloud
  • Type: String

Required

appName
  • Description: The name of the application in use.
  • Type: String

Required

appVersion
  • Description: The application build version with which a new job is started. If the appVersion is not specified, the latest application build version is used.

  • Type: String

Required

exportedServiceName  
  • Description:  The name of the CloudCenter service that was exported from another CloudCenter instance.

  • Type: String

Required

tierName    
  • Description:  The name of the tier that was exported in the application profile 
  • Type: String

Required

mappedServiceName  
  • Description: A mapped service name can be one of two options:

    • The name of the service to which an exported service is mapped or

    • The name of a new service if importService = true

  • Type: String

Required

 exportedImageName   
  • Description: The name of the image that was exported using the Export Application feature.

  • Type: String

Required

 exportedImageId   
  • Description: Unique, system-generated identifier for the image that is contained in the exported ZIP file. This ID may be null if the base image was not exported

  • Type: String

Required

 importService 
  • Description: Identifies if this exported service must be imported.
  • Type: Boolean
    • true = This exported service must be imported.
    • false = (Default) This exported service must not be imported.

Required

exportedImageMappings – Required

 Click here to expand...

exportedImageMappings
  • Description: Identifies details for exported CloudCenter images.
    • In the initial request (1st stage request), this information (exported images mapped to tier) is required at the childJobPortSpecs level.
    • In the subsequent request (2nd stage request), only parent-level exportedImageMappings information is considered. At this level, the details about the remap image or import image are required only if you have already exported the base image and if you use the remap service option. See Deployment Export/Import for additional details.
  • Type: Sequence of image maps

     importImage 
    • Description: Identifies if an exported image must be imported.
    • Type: Boolean
      • true = This exported image should be imported.
      • false = (Default) This exported image should not be imported.
     mappedImageName 
    • Description: A mapped image name can be one of two options:
      • The name of the image to which an exported image is mapped or

      • The name of a new image if importImage = true

    • Type: String

     exportedImageName   
    • Description: The name of the image that was exported using the Export Application feature.

    • Type: String

     exportedImageId   
    • Description: Unique, system-generated identifier for the image that is contained in the exported ZIP file. This ID may be null if the base image was not exported

    • Type: String

 importedAppId   
  • Description: Unique, system-generated identifier for the application that was imported.

  • 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 here to expand...

perms
  • Description: The permissions for a CloudCenter Resource managed by ACLs.

  • Type: Array of strings

    resourceName Permissions →

    Enumeration ↓

    read
    write
    create
    delete
    administration
    executemove_in
    move_out
    access
    approve
    authorize
    managenotify

    POLICY

    YesYes   

    ACTION_POLICY

    Yes    

    PUBLISHED_APP

    Yes    

    DEPLOYMENT_ENVIRONMENT 

    YesYesYesYes 

    APPLICATION

    Yes

    Yes

       

    REPOSITORY

    Yes    

    CLOUD_ACCOUNT 

    Yes    

    SYSTEM_TAG

    Yes    

    SECURITY_PROFILE

    Yes    

    SERVICE

    Yes    

    CUSTOM_ACTION

    Yes  Yes 
    PROJECTYes   Yes
    IMAGEYes    
    MANAGE_EXPORTYesYes   
    MANAGE_IMPORTYesYes   

password
  • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
  • Type: String
depEnvId
  • DescriptionUnique, system-generated identifier for the deployment environment. See Deployment Environments for additional details. This attribute is the same as the environmentId attribute.
  • Type: String

specifications

 Click here to expand...

specifications
  • Description: Identifies the approach used to export applications for each tier. See Application Export/Import for additional context.
  • Type: Array of specification types

    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)

    specType
    • Description: Identifies the option(s) used to export applications. See Deployment Export/Import for additional context.
    • Type: Enumeration

      EnumerationDescription
      APP_DEFINITIONThe default component-based approach to export applications. Suitable for multi-tier applications and cross-cloud environments (requires knowledge of the CloudCenter application configuration procedures and processes).
      If you set this option to true, you cannot configure the VM_SNAPSHOT option as true.
      BASE_IMAGE Only available for the APP_DEFINITION  approach. If specified, the images that the services depend on are also exported.
      SERVICE_DEFINITION 
      Only available for the APP_DEFINITION  approach. If specified, the CloudCenter service definition is exported. If you additionally select the Base Image option, the corresponding image is also exported.
      APP_DATA_BACKUPOnly available for the APP_DEFINITION  approach. if specified, the data backup script is run and the backup data is persisted in the repository for future restoration.
      VM_SNAPSHOT The alternate approach to export applications. Only possible if the application is tightly coupled with the underlying OS.
      If you set this option to true, you cannot configure the APP_DEFINITION option as true.
    value
    • Description: Identifies the value setting for this specType property.
    • Type: Boolean
      • true: This setting is configured.
      • false: (Default) This setting is not configured.

childJobPortSpecs – Tier based attributed that is only populated at the parent level

 Click here to expand...

childJobPortSpecs
  • Description: Identifies the approach used to export applications for each tier. See Application Export/Import for additional context.
  • Type: Array of specification types

    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)

    jobId
    • DescriptionUnique, system-generated identifier for the job
    • Type: String

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

    • Type: String

    specifications
    • Description: Identifies the approach used to export applications for each tier. See Application Export/Import for additional context.
    • Type: Array of specification types

      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)

      specType
      • Description: Identifies the option(s) used to export applications. See Deployment Export/Import for additional context.
      • Type: Enumeration

        EnumerationDescription
        APP_DEFINITIONThe default component-based approach to export applications. Suitable for multi-tier applications and cross-cloud environments (requires knowledge of the CloudCenter application configuration procedures and processes).
        If you set this option to true, you cannot configure the VM_SNAPSHOT option as true.
        BASE_IMAGE Only available for the APP_DEFINITION  approach. If specified, the images that the services depend on are also exported.
        SERVICE_DEFINITION 
        Only available for the APP_DEFINITION  approach. If specified, the CloudCenter service definition is exported. If you additionally select the Base Image option, the corresponding image is also exported.
        APP_DATA_BACKUPOnly available for the APP_DEFINITION  approach. if specified, the data backup script is run and the backup data is persisted in the repository for future restoration.
        VM_SNAPSHOT The alternate approach to export applications. Only possible if the application is tightly coupled with the underlying OS.
        If you set this option to true, you cannot configure the APP_DEFINITION option as true.
      value
      • Description: Identifies the value setting for this specType property.
      • Type: Boolean
        • true: This setting is configured.
        • false: (Default) This setting is not configured.

    childJobPortSpecs (at the child level)

    createDate
    • DescriptionIndicates when the account was created for this trial user
    • Type: Long
    status
    • Description: Status of the job/deployment. See Deployment and VM States for additional context.
    • Type: Enumeration

      EnumerationDescription
      allAll jobs or deployments in this CloudCenter instance.
      runningRunning (successful) jobs or deployments in this CloudCenter instance.
      activeActive (any live state, in addition to the running state) jobs or deployments in this CloudCenter instance.
    workflowInstance
    • Description: Identifies detailed information about the executed workflow activity.
    • Type: Sequence of workflow attributes

       workflowId 
      • DescriptionUnique, system-generated identifier for the benchmark.
      • Type: String
      name
      • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

      • Type: String

      description
      • DescriptionA brief description for this CloudCenter Resource.

      • Type: String
      startTime
      endTime
      state
      • Description: Identifies the state of the executed workflow or activity.

      • Status: Enumeration

        EnumerationDescription
        NOT_STARTEDThe executed workflow or activity has not started.
        RUNNING The executed workflow or activity is successfully running.
        FINISHED  
        The executed workflow or activity is complete.
        ERROR 
        The executed workflow or activity encountered an error during execution.
        ABORTEDThe executed workflow or activity was cancelled.
        WAITING The executed workflow or activity is pending the completion of another agent/component/activity.
      activityExecution (click for additional details)
      id
      • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

      • Type: String
    deleted
    • Description: Identifies if this resource is deleted in the CloudCenter platform.
    • Type: Boolean
      • true = The resource is deleted.
      • false = The resource is not deleted.
    appName
    • Description: The name of the application in use.
    • Type: String
    appVersion
    • Description: The application build version with which a new job is started. If the appVersion is not specified, the latest application build version is used.

    • Type: String
    appId
    • Description: Unique, system-generated identifier for the application profile. You can provide multiple application profile IDs as input parameters.

    • Type: String

createDate
  • DescriptionIndicates when the account was created for this trial user
  • Type: Long
status
  • Description: Status of the job/deployment. See Deployment and VM States for additional context.
  • Type: Enumeration

    EnumerationDescription
    allAll jobs or deployments in this CloudCenter instance.
    runningRunning (successful) jobs or deployments in this CloudCenter instance.
    activeActive (any live state, in addition to the running state) jobs or deployments in this CloudCenter instance.

workflowInstance 

 Click here to expand...

workflowInstance
  • Description: Identifies detailed information about the executed workflow activity.
  • Type: Sequence of workflow attributes

     workflowId 
    • DescriptionUnique, system-generated identifier for the benchmark.
    • Type: String
    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    startTime
    endTime
    state
    • Description: Identifies the state of the executed workflow or activity.

    • Status: Enumeration

      EnumerationDescription
      NOT_STARTEDThe executed workflow or activity has not started.
      RUNNING The executed workflow or activity is successfully running.
      FINISHED  
      The executed workflow or activity is complete.
      ERROR 
      The executed workflow or activity encountered an error during execution.
      ABORTEDThe executed workflow or activity was cancelled.
      WAITING The executed workflow or activity is pending the completion of another agent/component/activity.
    activityExecution (click for additional details)
    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String

repositoryId
  • Description: Unique, system-generated identifier for the repository.  See Artifact Repository and Share Artifact Repositories for additional context. This ID refers to the location where the exported CloudCenter ZIP file is stored.
  • Type: String
cloudAccountId
  • Description: Unique, system-generated identifier for the cloudAccount
  • Type: String
pathValue
  • Description: The username credentials expected by the CloudCenter platform when you export applications. Provide a valid path on the repository. If the folder does not exist in this path, CloudCenter attempts to create the folder provided you have the appropriate permissions for this repository. This field does not accept email addresses.
  • Type: String
artifactRepositoryId
  • Description: Unique, system-generated identifier for the artifact repository. See Artifact Repository and Share Artifact Repositories for additional context. It is the location where the imported artifacts are stored and the imported CloudCenter resources such as application profiles and services point to this repository.
  • Type: String
artifactPathValue
  • Description: The username credential expected by the CloudCenter platform for the artifact location when you export/import applications. If this value is an email address, provide the email as shown in the request and response examples.
  • Type: String
cloudType
  • Description: The type of associated cloud
  • Type: String
appName
  • Description: The name of the application in use.
  • Type: String
appVersion
  • Description: The application build version with which a new job is started. If the appVersion is not specified, the latest application build version is used.

  • Type: String
exportedServiceName  
  • Description:  The name of the CloudCenter service that was exported from another CloudCenter instance.

  • Type: String
 exportedImageName   
  • Description: The name of the image that was exported using the Export Application feature.

  • Type: String
 exportedImageId   
  • Description: Unique, system-generated identifier for the image that is contained in the exported ZIP file. This ID may be null if the base image was not exported

  • Type: String
 importService 
  • Description: Identifies if this exported service must be imported.
  • Type: Boolean
    • true = This exported service must be imported.
    • false = (Default) This exported service must not be imported.

exportedImageMappings

 Click here to expand...

exportedImageMappings
  • Description: Identifies details for exported CloudCenter images.
    • In the initial request (1st stage request), this information (exported images mapped to tier) is required at the childJobPortSpecs level.
    • In the subsequent request (2nd stage request), only parent-level exportedImageMappings information is considered. At this level, the details about the remap image or import image are required only if you have already exported the base image and if you use the remap service option. See Deployment Export/Import for additional details.
  • Type: Sequence of image maps

     importImage 
    • Description: Identifies if an exported image must be imported.
    • Type: Boolean
      • true = This exported image should be imported.
      • false = (Default) This exported image should not be imported.
     mappedImageName 
    • Description: A mapped image name can be one of two options:
      • The name of the image to which an exported image is mapped or

      • The name of a new image if importImage = true

    • Type: String

     exportedImageName   
    • Description: The name of the image that was exported using the Export Application feature.

    • Type: String

     exportedImageId   
    • Description: Unique, system-generated identifier for the image that is contained in the exported ZIP file. This ID may be null if the base image was not exported

    • Type: String

 importedAppId   
  • Description: Unique, system-generated identifier for the application that was imported.

  • Type: String
© 2017 Cisco Systems