Delete Clusters

This is a force operation which will delete the cluster even if there can be a data loss. Before calling this operation, all the VMs should be powered off.

Request

URI

DELETE

https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/clusters/{cluster}

COPY

Path Parameters

string

org

Required

Organization identifier

string

sddc

Required

Sddc identifier

string

cluster

Required

cluster identifier

Authentication

This operation uses the following authentication methods.

api_key

Responses

202

Accepted

Returns Task of type(s) application/json

This response body class contains all of the following: InlineTask0

{
    "updated": "string",
    "user_id": "string",
    "updated_by_user_id": "string",
    "created": "string",
    "version": 5,
    "updated_by_user_name": "string",
    "user_name": "string",
    "id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "status": "string",
    "localized_error_message": "string",
    "resource_id": "string",
    "parent_task_id": "string",
    "task_version": "string",
    "correlation_id": "string",
    "start_resource_entity_version": 0,
    "customer_error_message": "string",
    "sub_status": "string",
    "task_type": "string",
    "start_time": "string",
    "task_progress_phases": [
        {
            "id": "string",
            "name": "string",
            "progress_percent": 0
        }
    ],
    "error_message": "string",
    "org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "end_resource_entity_version": 5,
    "service_errors": [
        {
            "default_message": "string",
            "original_service": "string",
            "localized_message": "string",
            "original_service_error_code": "string"
        }
    ],
    "org_type": "string",
    "estimated_remaining_minutes": 4,
    "params": {},
    "progress_percent": 75,
    "phase_in_progress": "string",
    "resource_type": "string",
    "end_time": "string"
}

400

The sddc is not in a state that's valid for updates

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

integer

status

Required

HTTP status code

string

path

Required

Originating request URI

boolean

retryable

Required

If true, client should retry operation

string

error_code

Required

unique error code

array of string

error_messages

Required

localized error messages

401

Unauthorized

Operation doesn't return any data structure

403

Access not allowed to the operation for the current user

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

integer

status

Required

HTTP status code

string

path

Required

Originating request URI

boolean

retryable

Required

If true, client should retry operation

string

error_code

Required

unique error code

array of string

error_messages

Required

localized error messages

404

Cannot find the cluster with the given id

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

integer

status

Required

HTTP status code

string

path

Required

Originating request URI

boolean

retryable

Required

If true, client should retry operation

string

error_code

Required

unique error code

array of string

error_messages

Required

localized error messages

Code Samples

COPY

                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/vmc/api/orgs/{org}/sddcs/{sddc}/clusters/{cluster}

On This Page

Description

Request

Path Parameters

Authentication

Response

202 Response Body

Errors

Sddc Operations