Migrate Deployment

Details

API Details
NameMigrate Deployment
DescriptionMigrates a CloudCenter Deployment from one cloud to another after shutting down the old deployment.
MethodPUT
URIv1/jobs/jobid?action=migrate
CloudCenter ReleaseCloudCenter 3.x and 4.x
Notes

For additional context on <PORT> usage in the following example(s), see Base URI Format.

ESB Headeraction: update.jobs.jobid
actionparam: action=migrate

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>v1/jobs/22604?action=migrate" 

Request Body

 {
    "serviceTierId": "WordPress1-5254",
    "appVersion": "3.8",
    "name": "WP_TengUvik_20160113_002-02",
    "environment": "Azure",
    "parameters": {
        "appParams": [{
            "name": "cliqrIgnoreAppFailure",
            "value": "false"
        }],
        "cloudParams": {
            "cloud": "Azure-us-east"
        }
    },
    "jobs": [{
        "serviceTierId": "mysql-5257",
        "parameters": {
            "cloudParams": {
                "cloud": "Azure-us-east",
                "instance": "Medium",
                "cloudProperties": [{
                    "name": "vnId",
                    "value": "cliqrsaas"
                }]
            }
        },
        "nicInfo": [{
            "networkID": "Subnet-1",
            "order": 1,
            "nicNetworkType": "NETWORK",
            "publicIpAllocate": true
        }],
        "volumeInfos": [{
            "size": "30"
        }]
    }, {
        "serviceTierId": "apache2-5256",
        "parameters": {
            "cloudParams": {
                "cloud": "Azure-us-east",
                "instance": "Small",
                "cloudProperties": [{
                    "name": "vnId",
                    "value": "cliqrsaas"
                }]
            },
            "appParams": [{
                "name": "GREET",
                "value": "HELLOWORLD"
            }]
        },
        "nicInfo": [{
            "networkID": "Subnet-1",
            "order": 1,
            "nicNetworkType": "NETWORK",
            "publicIpAllocate": true
        }]
    }, {
        "serviceTierId": "nginx-5255",
        "parameters": {
            "cloudParams": {
                "cloud": "Azure-us-east",
                "instance": "Small",
                "cloudProperties": [{
                    "name": "vnId",
                    "value": "cliqrsaas"
                }]
            }
        },
        "nicInfo": [{
            "networkID": "Subnet-1",
            "order": 1,
            "nicNetworkType": "NETWORK",
            "publicIpAllocate": true
        }]
    }]
}

Request Attributes

jobId
  • DescriptionUnique, system-generated identifier for the job
  • Type: String
action
  • Description: Identifies the supported action for each deployment. See supportedActions for a list of actions. This API requires the MIGRATE action.
  • Type: Enumeration
serviceTierId
  • Description: Unique, system-generated identifier for the service tier within the application. You can obtain the value for this ID by issuing the Get Job Details API (for example, Loadbalancer, database, AppCluster, or other tiers). This value is a concatenation of the Application Profile Type Name and the App ID.
  • 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
name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

environment
  • Description: The name of the deployment environment.
  • Type: String
parameters
  • Description: Information about the types of parameters used to start this job.
  • Type: Sequence of parameter types

    cloudParams
    • Description: Cloud specific job parameters (not required for SaaS deployments) – information about the cloud where new job is started
    • Type: Object

      cloud
      • Description: The user-assigned name for the cloud region where the new job is started.
      • Type: String
      instance
      • Description: The name of the cloud Instance type that is used to start the new job. See Manage Instance Types for additional context.
      • Type: String

      storage
      • Description: Identifies storage-related cloud information
      • Type: Array of mapped attributes

        regionId
        • DescriptionUnique, system-generated identifier for the cloud region 
        • Type: String
        cloudAccountId
        • Description: Unique, system-generated identifier for the cloudAccount
        • Type: String
        size
        • Description: Total number of records that any list page should contain. The default is: 

          • v1 APIs = 20 records

          • v2 APIs:

            • Prior to 4.8.0: All elements are returned and the page value is ignored.

            • Effective 4.8.0: 50 records
        • Type: Integer
        numNodes
        • DescriptionThe number of nodes in this storage configuration
        • Type: Integer
        cloudSpecificSettings
        • Description: Settings for this cloud provider
        • Type: Name-Value Pair (array)
        address
        • Description: The DNS name or the IP address of the resource VM (for example, CCO, storage)
        • Type: String

      rootVolumeSize
      • Description: Root volume size (in GB) if you need to expand root disk when you launch a VM. The size must be bigger than the size defined by the instance type. This is required for OpenStack, but optional for AWS.

        Optional for AWS

        To provide a larger size for root volume for an AWS deployment, use the newer generation of CloudCenter instance types. The older generation of instance types like the t1, m1 series do not support the resizing of root volume. To use the older generation of instance types, configure the root volume size as 0. This configuration, by default, uses the AMI's  root volume size. See Multiple Volumes for additional context.

      • Type: String
      cloudProperties
      • Description: Information about the cloud region configuration. See Application Deployment for a use case.
      • Type: Array of name-value pairs

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

        • Type: String

        value
        • Description: Indicates the set value for this property
        • Type: Float

      • Availability Set Examples: If using CloudCenter 4.5.6 or later, see Availability Sets and Zones for a feature explanation or the following cloud-specific attributes:
    appParams
    • Description: Information about the application property
    • Type: Array of name-value pairs

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

      • Type: String

      value
      • Description: Indicates the set value for this property
      • Type: Float

    envParams
    • Description: Information about the application property
    • Type: Array of name-value pairs

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

      • Type: String

      value
      • Description: Indicates the set value for this property
      • Type: Float

jobs(v1) (Click for additional details)

Response Attributes

None.