// removed jquery ui css and js

Create Cloud

Details

API Details
Name

Create Cloud

Description

Creates a new cloud representation in the specified tenant.

MethodPOST
URIv1/tenants/tenantId/clouds
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Enhanced in CloudCenter 4.9.0 to include the cloudFamilyType attribute and deprecate the publicCloud attribute.
Notes

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

ESB Header

action: create.tenants.tenantId.clouds

Example

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds"

Request Body

{
    "name": "CreateCloud",
    "description": "description",
    "cloudFamily": "Amazon",
    "tenantId": 1
}

Response

{
  "id": "10",
  "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/",
  "perms": [],
  "name": "CreateCloud",
  "cloudFamily": "Amazon",
  "description": "description",
  "publicCloud": true,
  "tenantId": "1",
  "detail": null
}

Request Attributes

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

  • Type: String

Required

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

cloudFamily                                                                                                                                                                                
  • Description: The cloud provider name.                     
  • Type: String

Required

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


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 for additional details)
name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

cloudFamily                                                                                                                                                                                
  • Description: The cloud provider name.                     
  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

publicCloud (Deprecated)
  • Description: Indicates if this is a public cloud. This attribute is useful to identify datacenters and private clouds as features like sync storage and add storage type is not applicable to public clouds.
  • Type: Boolean
    • true = This is a public cloud. See the Public Clouds section for the relevant release for a complete list.
    • false = This is not a public cloud. See the Datacenters and Private Clouds section for the relevant release for a complete list.

cloudFamilyType
  • Description: Indicates if this is a public cloud, a private cloud/datacenter, or a container cloud. This attribute is useful to identify features that are not available in all cloud environments. For example, sync storage and add storage type are not applicable to public clouds.
  • Type: Enumeration

    EnumerationDescription
    PublicAny cloud listed in the Public Clouds section for the applicable release.
    PrivateAny cloud listed in the Datacenters and Private Clouds section for the applicable release.
    ContainerAny cloud listed in the Container Clouds section for the applicable release.

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

detail (click for additional details)

If the request URL does not have a detail query parameter with the value=true, then this field displays null.



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