Create Cloud Region

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameCreate Cloud Region
Description

Creates a new cloud region for the specified tenant on the supported cloud

Allowed Role(s)

ADMIN, WM_ADMIN, and CO_RL_ADMIN

MethodPOST
URI

v1/tenants/tenantId/clouds/cloudId/regions

cloudcenter-cloud-setup/api/v1/tenants/tenantId/clouds/cloudId/regions

Sample Request
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds/9/regions"
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-cloud-setup/api/v1/tenants/1/clouds/9/regions"
Release
  • Introduced in CloudCenter 4.0
  • Enhanced in CloudCenter 4.5.1 to include the externalActions and externalBundleLocation attributes so you can configure External Service Deployment Lifecycle actions (Pre-VM start, Pre-VM stop, and so forth) at the cloud region level
  • Enhanced in CloudCenter 4.8.0 to ensure that the enabled parameter is set to true if you do not specify it in the payload
  • Updated to deprecate the publicCloud attribute in CloudCenter 4.9.0 and later

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.

Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: create.tenants.tenantId.clouds.cloudId/.regions

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Request Body

If you do not specify the "enabled":true flag in the request body, the CloudCenter platform automatically changes the setting to true for this flag and API.

The displayName is optional.

{ 
   "cloudId":9,
   "importRegion":{ 
      "name":"us-west",
      "displayName":"US West (California)"
   },
   "enabled":true,
}


Response

{
    "resource": "https://<host>:<port>/v1/tenants/1/clouds/9/regions",
    "size": 1,
    "pageNumber": 0,
    "totalElements": 1,
    "totalPages": 1,
    "cloudRegions": [{
        "id": "6",
        "resource": null,
        "perms": [],
        "cloudId": "9",
        "displayName": "US West (California)",
        "regionName": "MyAzure-us-west",
        "description": "Microsoft Azure",
        "importRegion": null,
        "gateway": {
            "address": null,
            "dnsName": null,
            "status": null,
            "cloudId": null,
            "cloudAccountId": null
        },
        "storage": null,
        "enabled": true,
        "activated": false,
		"publicCloud": true,
        "numUsers": 0,
        "status": "STOPPED",
        "statusDetail": "GATEWAY_NOT_ACTIVATED",
        "regionProperties": [{
            "name": "AzureLinuxCustomScriptExtensionVersion",
            "value": "1.2"
        }, {
            "name": "AzureBlobPath",
            "value": "blob.core.windows.net/vhd-store/"
        }, {
            "name": "AzureStorageAccount",
            "value": "cliqrwest"
        }, {
            "name": "AzureWindowsCustomScriptExtensionVersion",
            "value": "1.3"
        }, {
            "name": "AzureCloudDomain",
            "value": ".cloudapp.net"
        }, {
            "name": "AzureMetadataServer",
            "value": "mds.cliqrtech.com"
        }, {
            "name": "AzureNetwork",
            "value": "cliqr-west1"
        }, {
            "name": "AzureAffinityGroup",
            "value": "432eeb32-8930-469f-ba60-bc2dc7759325"
        }, {
            "name": "AzureCloudEndpoint",
            "value": "https://management.core.windows.net"
        }]
    }],
    "externalActions": [],
    "externalBundleLocation": null
}


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 the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

  • Type: String

Required

cloudId
  • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

  • Type: String

Required

importRegion
  • Description: Identified the cloud region details
  • Type: Sequence of attributes

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

    • Type: String

    displayName
    • DescriptionA descriptive name for this CloudCenter resource.
    • Type: String

enabled
  • Description: Indicates that this resource has been enabled. The default differs based on the resource.

    • true = The resource has been enabled (v2 aging and suspension policies are enabled by default).

    • false = The resource has not been enabled.

  • Type: Boolean

Response Attributes

Unable to render {include} The included page could not be found.
See pageResource or Pagination for additional context
Unable to render {include} The included page could not be found.



© 2017-2019 Cisco Systems, Inc. All rights reserved