按需节点转包年/包月 - BatchChangeNodeToPeriod
功能介绍
该API用于将节点从按需计费模式转成包周期计费模式。
按需节点池中的节点转成包年/包月时,需要将集群升级到v1.19.16-r40、v1.21.11-r0、v1.23.9-r0、v1.25.4-r0以及其他更高版本的集群。
当按需节点池中的节点转成包年/包月后,该节点不支持弹性缩容。
按需计费节点绑定的资源(弹性公网IP)可能不支持同步变更计费模式,详情请参见弹性云服务器ECS按需转包年/包月说明。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/toperiod
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
| cluster_id | 是 | String | 参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。 约束限制: GET方法不做校验 取值范围: 不涉及 默认取值: 不涉及 |
| X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| kind | 否 | String | 参数解释: API类型 约束限制: 该值不可修改 取值范围: 不涉及 默认取值: Node |
| apiVersion | 否 | String | 参数解释: API版本 约束限制: 该值不可修改 取值范围: 不涉及 默认取值: v3 |
| nodeList | 是 | Array of strings | 参数解释: 要进行按需转包的CCE节点ID列表,示例如下: "nodeList": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| periodOrderParam | 是 | periodOrderParam object | 参数解释: 转包周期订单参数 |
| includeResources | 否 | Array of strings | 参数解释: 需要一起转包周期的资源类型列表,示例如下: "includeResources": ["eip"] 约束限制: 当前仅支持eip(弹性公网IP)资源 取值范围: 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| isAutoPay | 否 | Boolean | 参数解释: 是否自动支付订单费用 约束限制: 不涉及 取值范围: 默认取值: false |
| isAutoRenew | 否 | Boolean | 参数解释: 是否自动续费 约束限制: 不涉及 取值范围: 默认取值: false |
| periodNum | 是 | Integer | 参数解释: 包周期时间长度,不同局点、不同产品规格支持的范围可能不同,大部分局点支持:1-9月,1-3年,具体以接口返回为准。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| periodType | 是 | String | 参数解释: 包周期单位 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| orderId | String | 参数解释: 提交订单成功后返回的订单ID 取值范围: 不涉及 |
请求示例
将一个节点从按需计费转为包周期计费,周期为1个月。
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"
}
} 响应示例
状态码:200
表示按需节点转包年/包月订单下发成功。
{
"orderId" : "CS260XXXXX1B3NPG"
} SDK代码示例
SDK代码示例如下。
将一个节点从按需计费转为包周期计费,周期为1个月。
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()); } } } |
将一个节点从按需计费转为包周期计费,周期为1个月。
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) |
将一个节点从按需计费转为包周期计费,周期为1个月。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示按需节点转包年/包月订单下发成功。 |
错误码
请参见错误码。