Edit NodePool
    • PDF

    Edit NodePool

    • PDF

    Article summary

    Available in VPC

    Change the number of pinned nodes in an already created node pool or set whether to use autoscaling.

    Requests

    The following describes the request format for the endpoint. The request format is as follows.

    MethodURI
    PATCH/clusters/{uuid}/node-pool/{instanceNo}

    Request headers

    For headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service common headers.

    Request path parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    uuidStringRequiredCluster's UUID
    instanceNoIntegerRequiredNodePool instance number

    Request syntax

    The request syntax is as follows.

    {
      "nodeCount": "integer",
      "autoscale": {
        "enabled": "boolean",
        "max": "integer",
        "min": "integer"
      }
    }
    

    Request body

    The following describes the request body.

    FieldTypeRequiredDescription
    nodeCountIntegerConditionalNumber of nodes
    • Required when autoscaling is not enabled
    autoscaleArrayOptionalAutoscale information
    autoscale.enabledBooleanConditionalAutoscale availability
    • true | false
      • true: use autoscale
      • false: not use autoscale
    autoscale.maxIntegerConditionalMaximum number of nodes available for autoscaling
    • Up to 250
    • Required when setting true
    autoscale.minIntegerConditionalMinimum number of nodes available for autoscaling
    • 1 or more
    • Required when setting true

    Request example

    The following is a sample request.

    curl --location --request PATCH 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo}' \
    --header 'x-ncp-apigw-timestamp: {timestamp}' \
    --header 'x-ncp-iam-access-key: {access key}' \
    --header 'x-ncp-apigw-signature-v2: {API gateway signature}' \
    --data '{
      "nodeCount": 1,
      "autoscale": {
        "enabled": false
      }
    }'
    

    Responses

    The following describes the response format.

    Response syntax

    The response syntax is as follows.

    {
        "uuid": "string",
        "instanceNo": "integer"
    }
    
    

    Response body

    The following describes the response body.

    FieldTypeRequiredDescription
    uuidString-UUID of the cluster
    instanceNoInteger-NodePool instance number

    Response status codes

    For response status codes common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service response status codes.

    Response example

    The following is a sample response.

    {
        "uuid": "1a1111a1-4d44-99b9-88c8-9e99a99e9e99",
        "instanceNo": 23323233
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.