tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyClusterNodePool

Last updated: 2024-11-14 14:52:41

    1. API Description

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

    This API is used to edit a node pool.

    A maximum of 20 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: ModifyClusterNodePool.
    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
    NodePoolId Yes String Node pool ID
    Name No String Name
    MaxNodesNum No Integer Maximum number of nodes
    MinNodesNum No Integer Minimum number of nodes
    Labels.N No Array of Label Labels
    Taints.N No Array of Taint Taints
    Annotations.N No Array of AnnotationValue Node Annotation List
    EnableAutoscale No Boolean Indicates whether auto scaling is enabled.
    OsName No String Operating system name
    OsCustomizeType No String Image tag, DOCKER_CUSTOMIZE (container customized tag), GENERAL (general tag, default value)
    GPUArgs No GPUArgs GPU driver version, CUDA version, cuDNN version and wether to enable MIG
    UserScript No String Base64-encoded custom script
    IgnoreExistedNode No Boolean Ignore existing nodes when update Label and Taint
    ExtraArgs No InstanceExtraArgs Node custom parameter
    Tags.N No Array of Tag Resource tag
    Unschedulable No Integer Sets whether the added node is schedulable. 0 (default): schedulable; other values: unschedulable. After node initialization is completed, you can run kubectl uncordon nodename to enable this node for scheduling.
    DeletionProtection No Boolean Whether Deletion Protection is enabled
    DockerGraphPath No String Specified value of dockerd --graph. Default value: /var/lib/docker
    PreStartUserScript No String Base64-encoded custom script

    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 Editing a node pool

    Input Example

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

{
    "ClusterId": "cls-xxxxxx",
    "NodePoolId": "np-xxx"
}

    Output Example

    {
    "Response": {
        "RequestId": "xxxxxx"
    }
}

    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.ComponentClientHttp Internal HTTP client error.
    FailedOperation.RecordNotFound Record not found.
    InternalError.Db DB error.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter.Param Invalid parameter.
    OperationDenied Operation denied.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.AsAsgNotExist The scaling group does not exist.
    UnsupportedOperation.CaEnableFailed Failed to enable CA because AS is disabled.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy