@digitalocean/dots - v1.0.1
    Preparing search index...

    Builds and executes requests for operations under /v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}/nodes/{node_id}

    interface WithNode_ItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<
                WithNode_ItemRequestBuilderDeleteQueryParameters,
            >,
        ): Promise<void>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<
                WithNode_ItemRequestBuilderDeleteQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): WithNode_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    • To delete a single node in a pool, send a DELETE request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID.Appending the skip_drain=1 query parameter to the request causes nodedraining to be skipped. Omitting the query parameter or setting its value to0 carries out draining prior to deletion.Appending the replace=1 query parameter to the request causes the node tobe replaced by a new one after deletion. Omitting the query parameter orsetting its value to 0 deletes without replacement.

      Parameters

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To delete a single node in a pool, send a DELETE request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID.Appending the skip_drain=1 query parameter to the request causes nodedraining to be skipped. Omitting the query parameter or setting its value to0 carries out draining prior to deletion.Appending the replace=1 query parameter to the request causes the node tobe replaced by a new one after deletion. Omitting the query parameter orsetting its value to 0 deletes without replacement.

      Parameters

      Returns RequestInformation