Help Center/ Cloud Container Engine/ API Reference/ APIs/ Node Management/ Changing the Billing Mode of a Node to Yearly/Monthly
Updated on 2026-09-08 GMT+08:00

Changing the Billing Mode of a Node to Yearly/Monthly

Function

This API is used to change the billing mode of a node from pay-per-use to yearly/monthly.

The URL for cluster management is in the format of https://Endpoint/uri, in which uri indicates the resource path, that is, the path for API access.

To change the billing mode of a node in a pay-per-use node pool to yearly/monthly, you need to upgrade the cluster to v1.19.16-r40, v1.21.11-r0, v1.23.9-r0, v1.25.4-r0, or later.

After a node in a pay-per-use node pool is changed to a yearly/monthly node, the node does not support auto scale-in.

The billing mode of resources (EIPs) associated with the pay-per-use node may not be changed synchronously. For details, see Pay-per-Use to Yearly/Monthly.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    cce:node:toperiod

    Write

    cluster *

    -

    -

    -

    -

    • cce:ClusterId

    • g:EnterpriseProjectId

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/toperiod

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Details:

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Project IDs of the account

Default value:

N/A

cluster_id

Yes

String

Details:

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Cluster IDs

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition:

Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any.

Constraints:

GET requests are not validated.

Range:

N/A

Default Value:

N/A

X-Auth-Token

Yes

String

Details:

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

kind

No

String

Definition

API type

Constraints

The value cannot be changed.

Range

N/A

Default Value

Node

apiVersion

No

String

Definition

API version

Constraints

The value cannot be changed.

Range

N/A

Default Value

v3

nodeList

Yes

Array of strings

Definition

List of CCE node IDs that need to have their billing modes changed from pay-per-use to yearly/monthly. The following is an example:

"nodeList": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]

Constraints

N/A

Range

N/A

Default Value

N/A

periodOrderParam

Yes

periodOrderParam object

Definition

Parameter of the order for changing the billing mode to yearly/monthly

includeResources

No

Array of strings

Definition

List of resource types that need to have their billing modes changed to yearly/monthly. The following is an example:

"includeResources": ["eip"]

Constraints

Only EIPs are supported.

Range

  • eip: EIP

Default Value

N/A

Table 4 periodOrderParam

Parameter

Mandatory

Type

Description

isAutoPay

No

Boolean

Definition

Whether to automatically pay for an order

Constraints

N/A

Range

  • true: The order will be automatically paid.

  • false: The order will be manually paid.

Default Value

false

isAutoRenew

No

Boolean

Definition

Whether to enable auto renewal

Constraints

N/A

Range

  • true: Auto renewal is enabled.

  • false: Auto renewal is not enabled.

Default Value

false

periodNum

Yes

Integer

Definition

The duration of the yearly/monthly subscription. The supported duration varies depending on the region and product specifications. In most regions, the supported duration ranges from 1 to 9 months or from 1 to 3 years. The actual supported duration is subject to the response returned by the API.

Constraints

N/A

Range

N/A

Default Value

N/A

periodType

Yes

String

Definition

Billing cycle unit

Constraints

N/A

Range

  • month:

  • year

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

orderId

String

Definition

Order ID returned after an order is submitted

Range

N/A

Example Requests

Change the billing mode of a node to yearly/monthly. The billing period is one month.

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/toperiod

{
  "kind" : "Node",
  "apiVersion" : "v3",
  "nodeList" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ],
  "periodOrderParam" : {
    "isAutoPay" : true,
    "isAutoRenew" : false,
    "periodNum" : 1,
    "periodType" : "month"
  }
}

Example Responses

Status code: 200

The order for changing the billing mode of a pay-per-use node to yearly/monthly is submitted.

{
  "orderId" : "CS260XXXXX1B3NPG"
}

SDK Sample Code

The SDK sample code is as follows.

Change the billing mode of a node to yearly/monthly. The billing period is one month.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cce.v3.region.CceRegion;
import com.huaweicloud.sdk.cce.v3.*;
import com.huaweicloud.sdk.cce.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchChangeNodeToPeriodSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchChangeNodeToPeriodRequest request = new BatchChangeNodeToPeriodRequest();
        request.withClusterId("{cluster_id}");
        BatchChangeNodeToPeriodReqBody body = new BatchChangeNodeToPeriodReqBody();
        PeriodOrderParam periodOrderParambody = new PeriodOrderParam();
        periodOrderParambody.withIsAutoPay(true)
            .withIsAutoRenew(false)
            .withPeriodNum(1)
            .withPeriodType("month");
        List<String> listbodyNodeList = new ArrayList<>();
        listbodyNodeList.add("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
        body.withPeriodOrderParam(periodOrderParambody);
        body.withNodeList(listbodyNodeList);
        body.withApiVersion("v3");
        body.withKind("Node");
        request.withBody(body);
        try {
            BatchChangeNodeToPeriodResponse response = client.batchChangeNodeToPeriod(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Change the billing mode of a node to yearly/monthly. The billing period is one month.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcce.v3.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CceClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CceRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchChangeNodeToPeriodRequest()
        request.cluster_id = "{cluster_id}"
        periodOrderParambody = PeriodOrderParam(
            is_auto_pay=True,
            is_auto_renew=False,
            period_num=1,
            period_type="month"
        )
        listNodeListbody = [
            "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        ]
        request.body = BatchChangeNodeToPeriodReqBody(
            period_order_param=periodOrderParambody,
            node_list=listNodeListbody,
            api_version="v3",
            kind="Node"
        )
        response = client.batch_change_node_to_period(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Change the billing mode of a node to yearly/monthly. The billing period is one month.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := cce.CceClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := cce.NewCceClient(hcClient)

    request := &model.BatchChangeNodeToPeriodRequest{}
	request.ClusterId = "{cluster_id}"
	isAutoPayPeriodOrderParam:= true
	isAutoRenewPeriodOrderParam:= false
	periodOrderParambody := &model.PeriodOrderParam{
		IsAutoPay: &isAutoPayPeriodOrderParam,
		IsAutoRenew: &isAutoRenewPeriodOrderParam,
		PeriodNum: int32(1),
		PeriodType: "month",
	}
	var listNodeListbody = []string{
        "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    }
	apiVersionBatchChangeNodeToPeriodReqBody:= "v3"
	kindBatchChangeNodeToPeriodReqBody:= "Node"
	request.Body = &model.BatchChangeNodeToPeriodReqBody{
		PeriodOrderParam: periodOrderParambody,
		NodeList: listNodeListbody,
		ApiVersion: &apiVersionBatchChangeNodeToPeriodReqBody,
		Kind: &kindBatchChangeNodeToPeriodReqBody,
	}
	response, err := client.BatchChangeNodeToPeriod(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The order for changing the billing mode of a pay-per-use node to yearly/monthly is submitted.

Error Codes

See Error Codes.