Update Cloud

Details

API Details
Name

Update Cloud

Description
MethodPUT
URIv1/tenants/tenantId/clouds/cloudId
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
Notes

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

ESB Headeraction: update.tenants.tenantId.clouds.cloudId

Example

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

Cloud Details before the Change

{
    "id": "4",
    "name": "MyAmazon",
    "cloudFamily": "Amazon",
    "description": "MyAmazon2",
    "tenantId": "1"
}

Response after the Change

{
    "id": "4",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/4",
    "perms": [],
    "name": "MyAmazon",
    "cloudFamily": "Amazon",
    "description": "MyAmazon2",
    "publicCloud": false,
    "tenantId": "1",
    "detail": 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 Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

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

  • Type: String

Required

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

  • Type: String
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

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
  • Description: Inticates 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

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 Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

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