CliQr is now part of Cisco Learn More About Cisco

View Imported Applications

Details

API Details
Name

View Imported Application(s)

Description

View the current status of all imported applications See Application Export/Import for additional context.

MethodGET
URI
  • v1/imports/importId

  • v1/imports?importedAppId
  • v1/imports?liveStatusCheck=true
  • v1/imports/

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.imports
  •  action: get.imports.importId   
  • action: get.imports.
    actionparam: importedAppId=importedAppId 
  • action: get.imports. 
    actionparam: liveStatusCheck=true

Example 1: v1/imports/importId

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

Response

 Click here to expand...

Example 2: v1/imports?importedAppId=56

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

Respons

 Click here to expand...

Example 3: v1/imports?liveStatusCheck=true

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

Response

 Click here to expand...

Example 4: v1/imports

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

Response

 Click here to expand...

Request Attributes

importId
  • Description: Unique, system-generated identifier for the imported application.

  • Type: String

 

Optional

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

  • Type: String

Optional

liveStatusCheck
  • Description: Displays the current status of exported and imported applications.
  • Type: Boolean
    • true = Displays the current status of the job from the CCO.
    • false = (Default) Displays the current status of the job from the database.

Optional

Response Attributes

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

jobImportRequests

 Click here to expand...

jobImportRequests
  • Description: Identifies the details for an import request.
    Type: Sequence of import 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 additional context)
    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 for additional details)
    childJobPortSpecs (click for additional details)
    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 for additional details)
    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
    tierName    
    • Description:  The name of the tier that was exported in the application profile 
    • Type: String
    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
     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 for additional context)
     importedAppId   
    • Description: Unique, system-generated identifier for the application that was imported.

    • Type: String