Remove Zones Cluster Associations
Removes the mapping between the specified consumption-domain zone and vSphere clusters. If a cluster or a subset of specified clusters are not members of the specified zone, then the result is a success for those clusters. In order to remove the mapping between a zone and a cluster, there must not be any workload running in that zone because removing the mapping between a zone and a cluster could result in undefined behavior for the entities depending on this mapping to be present. This operation supports partial success, i.e., it is possible that the mapping gets successfully removed for a subset of the clusters but fails for another subset of the clusters. The returned result will contain the details about only those clusters for which the operation failed. if you do not have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.
Request
URLURL
https://{api_host}/api/vcenter/consumption-domains/zones/cluster/{zone}/associations?action=remove
Path Parameters
Path Parameters
string
zone
Required
Identifier of the zone for which the mapping needs to be removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.
string
clusters
Required
Set of identifiers of vSphere clusters which need to be removed from the mapping. The parameter must contain identifiers for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
ConsumptionDomainsZonesClusterAssociationsStatus
of type application/json
Status see #Status. If the operation failed, returns the reason of failures. There will be an error message indicating the identifier of the cluster for which the association removal failed and the reason of failure.
{
"failed_clusters": {},
"success": false
}
map of
object
failed_clusters
Required
Associations between the identifiers of the clusters for which the operation failed and the reason of the failure. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: ClusterComputeResource.
boolean
success
Required
This is true if the complete operation succeeded without any errors. Otherwise, it is false if all or some operations have failed.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if there is a workload running in the specified zone and depends on this zone’s cluster associations to be present.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zones.Manage privilege. - Each resource of ClusterComputeResource referenced by the parameter clusters requires Zone.ObjectAttachable privilege.
404
com.vmware.vapi.std.errors.not_found : if the specified zone is not known to this vCenter server.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-RemoveZoneAssociations -Zone "MyZone" -Clusters "MyClusters"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/consumption-domains/zones/cluster/{zone}/associations?action=remove
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: remove
Availability
Added in 8.0.0.1
