Update Cloud

Details

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

Update the configured details for cloud specified by the Cloud ID within a tenant specified by the Tenant ID

Allowed Role(s)

ADMIN, WM_ADMIN, and CO_RL_ADMIN

MethodPUT
URI

v1/tenants/tenantId/clouds/cloudId

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

Sample Request
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds/4"
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-cloud-setup/api/v1/tenants/1/clouds/4"
Release
  • Introduced in CloudCenter 4.0
  • Enhanced in CloudCenter 4.9.0 to include the cloudFamilyType attribute and deprecate the publicCloud attribute

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.
  • If you include a cloudId to identify a cloud, the response only includes information for that cloud.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: update.tenants.tenantId.clouds.cloudId

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

Not applicable

Sample Request 

{
    "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 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

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 (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