Delete Cloud Region

Details

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

Effective 4.7.0: You can delete cloud regions – even after jobs have been run on this region.

  • You can now delete Cloud Regions even after the CCO has been registered.

  • Cloud owners can delete regions if there are no running deployments and no association of the region in a Deployment Environment – If there are any, remove them first before trying this operation.

  • Ensure that all the jobs submitted in this region have already been terminated.


Allowed Roles(s)ADMIN, WM_ADMIN, and CO_RL_ADMIN
MethodDELETE
URI

v1/tenants/tenantId/clouds/cloudId/regions/cloudRegionId


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

Sample Request
curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds/2/regions/3"
curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-cloud-setup/api/v1/tenants/1/clouds/2/regions/3"
Release

Introduced in CloudCenter 4.2

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

ESB Header

action: delete.tenants.tenantId.clouds.cloudId.regions.cloudRegionId

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

Not applicable

Sample Response

The server responds with the HTTP Response code 204 No Content if the deletion of the cloud region is successful.

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

cloudRegionId
  • Description: Unique, system-generated identifier for a cloud region
  • Type: String

Required

Response Attributes

None


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