tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteCluster

Last updated: 2024-11-14 14:50:59

    1. API Description

    Domain name for API request: tke.tencentcloudapi.com.

    This API is used to delete a cluster. (Cloud API v3).

    A maximum of 50 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DeleteCluster.
    Version Yes String Common Params. The value used for this API: 2018-05-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ClusterId Yes String Cluster ID
    InstanceDeleteMode Yes String Policy used to delete an instance in the cluster: terminate (terminates the instance. Only available for instances on pay-as-you-go CVMs); retain (only removes it from the cluster. The instance will be retained.)
    ResourceDeleteOptions.N No Array of ResourceDeleteOption Specifies the policy to deal with resources in the cluster when the cluster is deleted. It only supports CBS now. The default policy is to retain CBS disks.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Deleting a cluster

    This example shows you how to delete a cluster.

    Input Example

    POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteCluster
<Common request parameters>

{
    "InstanceDeleteMode": "terminate",
    "ClusterId": "cls-etu4tjip"
}

    Output Example

    {
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.CamNoAuth Not authorized to access this API
    FailedOperation.ClusterForbiddenToDelete The cluster cannot be deleted.
    FailedOperation.ClusterNotFound The cluster is not found.
    FailedOperation.ClusterState Cluster status error.
    FailedOperation.ComponentClientCommon Internal client error.
    FailedOperation.ComponentClientHttp Internal HTTP client error.
    FailedOperation.CvmCommon Failed to create the node due to a CVM error
    FailedOperation.Param Invalid parameter.
    FailedOperation.TagCommon Tag error
    FailedOperation.VpcCommon VPC error.
    InternalError Internal error.
    InternalError.CamNoAuth You do not have permissions.
    InternalError.ClusterNotFound Cluster not found.
    InternalError.ClusterState Cluster status error.
    InternalError.ComponentClinetHttp Error while requesting (HTTP) other Tencent Cloud services
    InternalError.Param Parameter error.
    InternalError.PublicClusterOpNotSupport Cluster does not support the current operation.
    InternalError.UnexceptedInternal Internal error.
    InvalidParameter Parameter error.
    OperationDenied.ClusterInDeletionProtection The cluster is under deletion protection and cannot be deleted.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable Resource is unavailable
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy