按需节点转包年/包月 - BatchChangeNodeToPeriod
功能介绍
该API用于将节点从按需计费模式转成包周期计费模式。
集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即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"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示按需节点转包年/包月订单下发成功。 |
错误码
请参见错误码。