1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口 (ModifyInstancesChargeType) 用于切换实例的计费模式。
- 关机不收费的实例、
批量计算型BC1
和批量计算型BS1
机型族的实例、设置定时销毁的实例不支持该操作。 - 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyInstancesChargeType。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 是 | Array of String | 一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId 获取。每次请求批量实例的上限为30。示例值:["ins-r8hr2upy"] |
InstanceChargeType | 是 | String | 修改后实例计费类型。 示例值:PREPAID |
InstanceChargePrepaid | 否 | InstanceChargePrepaid | 修改后预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。
|
ModifyPortableDataDisk | 否 | Boolean | 是否同时切换弹性数据云盘计费模式。取值范围: 默认取值:false。 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 本示例将实例计费模式切换为按小时后付费模式。
本示例用于切换一个实例的计费模式。
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstancesChargeType
<公共请求参数>
{
"InstanceChargeType": "POSTPAID_BY_HOUR",
"InstanceIds": [
"ins-r8hr2upy"
]
}
输出示例
{
"Response": {
"RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
}
}
示例2 本示例将实例计费模式切换为预付费模式,且时长为1个月。
本示例用于切换一个实例的计费模式。
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstancesChargeType
<公共请求参数>
{
"InstanceChargeType": "PREPAID",
"InstanceIds": [
"ins-r8hr2upy"
],
"InstanceChargePrepaid": {
"Period": "1"
}
}
输出示例
{
"Response": {
"RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AccountQualificationRestrictions | 该请求账户未通过资格审计。 |
FailedOperation.InvalidInstanceApplicationRoleEmr | 请求不支持EMR 的实例ins-xxxxxxxx 。 |
FailedOperation.PromotionalPerioRestriction | 促销期内购买的实例不允许调整配置或计费模式。 |
InternalError.TradeUnknownError | 内部错误 |
InternalServerError | 操作内部错误。 |
InvalidAccount.InsufficientBalance | 账户余额不足。 |
InvalidAccount.UnpaidOrder | 账户有未支付订单。 |
InvalidInstance.NotSupported | 不被支持的实例。 |
InvalidInstanceId.Malformed | 无效实例ID 。指定的实例ID 格式错误。例如实例ID 长度错误ins-1122 。 |
InvalidInstanceId.NotFound | 没有找到相应实例。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InstanceIdMalformed | 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。 |
InvalidParameterValue.InvalidInstanceTypeUnderwrite | 指定机型不支持包销付费模式。 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
InvalidPeriod | 无效时长。目前只支持时长:[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36],单位:月。 |
InvalidPermission | 账户不支持该操作。 |
LimitExceeded.InstanceQuota | 当前配额不足够生产指定数量的实例 |
LimitExceeded.InstanceTypeBandwidth | 目标实例规格不支持当前规格的外网带宽上限,不支持调整。具体可参考公网网络带宽上限。 |
MissingParameter | 缺少参数错误。 |
OperationDenied.InstanceOperationInProgress | 实例正在执行其他操作,请稍后再试。 |
ResourceInsufficient.CloudDiskUnavailable | 云盘参数不符合规范 |
UnsupportedOperation.InstanceChargeType | 请求不支持该实例计费模式 |
UnsupportedOperation.InstanceMixedZoneType | 中心可用区和边缘可用区实例不能混用批量操作。 |
UnsupportedOperation.InstanceStateBanning | 该子机处于封禁状态,请联系相关人员处理。 |
UnsupportedOperation.InstanceStateFreezing | 操作不支持已冻结的实例。 |
UnsupportedOperation.InstanceStateRebooting | 请求不支持正在重启的实例 |
UnsupportedOperation.InstanceStateRescueMode | 请求不支持救援模式的实例 |
UnsupportedOperation.InstanceStateShutdown | 请求不支持隔离状态的实例 |
UnsupportedOperation.InstanceStateStopping | 请求不支持正在关机的实例 |
UnsupportedOperation.InstanceStateTerminating | 请求不支持正在销毁的实例 |
UnsupportedOperation.RedHatInstanceUnsupported | 请求不支持操作系统为RedHat的实例。 |
UnsupportedOperation.UnderwriteDiscountGreaterThanPrepaidDiscount | 包月转包销,不支持包销折扣高于现有包年包月折扣。 |
UnsupportedOperation.UnderwritingInstanceTypeOnlySupportAutoRenew | 该机型为包销机型,RenewFlag的值只允许设置为NOTIFY_AND_AUTO_RENEW。 |