Update Exported Application Status

Details

API Details
Name

Update Exported Application Status

Description

Aborts the current status for an application export that is in progress. See Deployment Export/Import for additional context.

MethodPUT
URI

v1/exports/exportId

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.
ESB Header

action: get.exports.exportId      

Example

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

Request Body

{
   "id":"36",
   "status":"ABORTED"
}

Response

{
   "id":"36",
   "resource":"https://<HOST>:<PORT>/v1/exports/36",
   "perms":[],
   "jobId":"50",
   "name":"Joomla_import_1129_1_test1_run_1",
   "password":"===redacted===",
   "repositoryId":"1",
   "pathValue":"NOV30/CC",
   "specifications":[],
   "childJobPortSpecs":[
      {
         "id":"37",
         "resource":"https://<HOST>:<PORT>/v1/exports/36/37",
         "perms":[],
         "jobId":"52",
         "name":null,
         "password":null,
         "repositoryId":null,
         "pathValue":null,
         "specifications":[
            {
               "id":"79",
               "resource":null,
               "perms":[],
               "specType":"VM_SNAPSHOT",
               "value":"true"
            }
         ],
         "childJobPortSpecs":[],
         "createDate":1480532347000,
         "status":null,
         "workflowInstance":null,
         "deleted":"false",
         "appName":null,
         "appVersion":null,
         "appId":null
      },
      {
         "id":"38",
         "resource":"https://<HOST>:<PORT>/v1/exports/36/38",
         "perms":[],
         "jobId":"51",
         "name":null,
         "password":null,
         "repositoryId":null,
         "pathValue":null,
         "specifications":[
            {
               "id":"81",
               "resource":null,
               "perms":[],
               "specType":"BASE_IMAGE",
               "value":"true"
            },
            {
               "id":"80",
               "resource":null,
               "perms":[],
               "specType":"APP_DATA_BACKUP",
               "value":"true"
            },
            {
               "id":"83",
               "resource":null,
               "perms":[],
               "specType":"SERVICE_DEFINITION",
               "value":"true"
            },
            {
               "id":"82",
               "resource":null,
               "perms":[],
               "specType":"APP_DEFINITION",
               "value":"true"
            }
         ],
         "childJobPortSpecs":[],
         "createDate":1480532347000,
         "status":null,
         "workflowInstance":null,
         "deleted":"false",
         "appName":null,
         "appVersion":null,
         "appId":null
      }
   ],
   "createDate":1480532347000,
   "status":"ABORTED",
   "workflowInstance":{
      "workflowId":"exportWorkflow",
      "name":"Export Application Deployment",
      "description":"Export Application Deployment",
      "startTime":1480532347422,
      "endTime":null,
      "state":"RUNNING",
      "activityExecution":{
         "activityId":"exportDeploymentActivity",
         "name":"Export Deployment",
         "description":"Export Deployment",
         "startTime":1480532347422,
         "endTime":null,
         "state":"RUNNING",
         "progress":null,
         "next":null,
         "subExecutions":[],
         "id":"89a6fb24-1ac0-40ad-86a1-a3e004e93de8"
      },
      "id":"1e044b17-65f1-4637-8028-797b69866ccc"
   },
   "deleted":"false",
   "appName":"Joomla_import_1129_1",
   "appVersion":"3.3.6",
   "appId":"66"
}

Request Attributes

exportId
  • Description: Unique, system-generated identifier for the exported application.

  • Type: String

Required

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

  • Type: String

Required

status
  • Description: Identifies the state of the executed workflow or activity.

  • Status: Enumeration

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

Required ("status":"ABORTED")

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   

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

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

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

 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: Identifies the state of the executed workflow or activity.

  • Status: Enumeration

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

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

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