1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
本接口(DescribeModifyInstanceBundles)用于查询实例可变更套餐列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeModifyInstanceBundles。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例 ID。可通过 DescribeInstances 接口返回值中的 InstanceId 获取。 示例值:lhins-f4s3n38h |
Filters.N | 否 | Array of Filter | 过滤器列表。 类型:String 必选:否 可通过 DescribeBundles 接口返回值中的 BundleId 获取。 取值: LINUX_UNIX(Linux/Unix系统);WINDOWS(Windows 系统) 类型:String 必选:否 取值:GENERAL_BUNDLE (通用型套餐); STORAGE_BUNDLE(存储型套餐);ENTERPRISE_BUNDLE( 企业型套餐);EXCLUSIVE_BUNDLE(专属型套餐);BEFAST_BUNDLE(蜂驰型套餐); 类型:String 必选:否 取值: ‘ONLINE’(在线); ‘OFFLINE’(下线); 类型:String 必选:否 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 5。 |
Offset | 否 | Integer | 偏移量,默认为 0。关于Offset 的更进一步介绍请参考 API 简介中的相关小节。示例值:0 |
Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的套餐数量。 示例值:3 |
ModifyBundleSet | Array of ModifyBundle | 变更套餐详细信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例可修改套餐列表
查询实例可修改套餐列表
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeModifyInstanceBundles
<公共请求参数>
{
"InstanceId": "lhins-p6xbekdt"
}
输出示例
{
"Response": {
"ModifyBundleSet": [
{
"Bundle": {
"BundleDisplayLabel": "NORMAL",
"BundleId": "bundle_gen_mc_med2_02",
"BundleSalesState": "AVAILABLE",
"BundleType": "GENERAL_BUNDLE",
"BundleTypeDescription": "通用型",
"CPU": 2,
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 5,
"Memory": 2,
"MonthlyTraffic": 500,
"Price": {
"InstancePrice": {
"Currency": "CNY",
"Discount": 100,
"DiscountPrice": 65,
"OriginalBundlePrice": 65,
"OriginalPrice": 65
}
},
"SupportLinuxUnixPlatform": true,
"SupportWindowsPlatform": true,
"SystemDiskSize": 70,
"SystemDiskType": "CLOUD_PREMIUM"
},
"ModifyBundleState": "AVAILABLE",
"ModifyPrice": {
"InstancePrice": {
"Currency": "CNY",
"Discount": 100,
"DiscountPrice": 10,
"OriginalBundlePrice": 65,
"OriginalPrice": 10
}
},
"NotSupportModifyMessage": ""
}
],
"RequestId": "651060b7-b781-4ed9-898c-a06b8c5c51dc",
"TotalCount": 1
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.DescribeInstanceStatus | 查询实例状态错误。 |
FailedOperation.DescribeInstancesModificationError | 查询实例变配套餐失败。 |
FailedOperation.RequestError | 请求错误。 |
FailedOperation.TradeGetPriceFailed | 计费询价失败。 |
InternalError.DescribeInstanceStatus | 查询实例状态失败,请稍后重试。 |
InternalError.DescribeInstancesModification | 查询实例是否可变配失败。 |
InternalError.DescribeInstancesModificationError | 查询实例是否可变配失败。 |
InternalError.InvalidBundlePrice | 套餐价格错误。 |
InternalError.InvalidCommandNotFound | 命令无法找到。 |
InternalError.RequestError | 请求出现错误。 |
InternalError.TradeGetPriceFailed | 价格获取失败。 |
InvalidParameter.BundleIdNotFound | 产品未定义的套餐 ID。 |
InvalidParameter.FilterValueLimitExceeded | 参数非法,Filter 参数中的 Values 取值数量超过允许的最大数量。 |
InvalidParameter.InvalidFilter | 参数非法,Filter 参数非法。 |
InvalidParameter.InvalidFilterInvalidKey | 参数非法,Filter 参数中的 Name 取值非法。 |
InvalidParameter.InvalidFilterInvalidNameNotStr | 参数非法,Filter 参数中的 Name 取值不是字符串。 |
InvalidParameter.InvalidFilterNotDict | 参数非法,Filter 参数不是字典。 |
InvalidParameter.InvalidFilterNotSupportedName | 参数非法,Filter 参数中有不支持的 Name。 |
InvalidParameterValue.InstanceIdMalformed | 参数值非法,实例 ID 格式非法。 |
InvalidParameterValue.InvalidBlueprintPlatformType | 镜像操作系统类型不合法。 |
InvalidParameterValue.InvalidConsoleDisplayTypes | 控制台显示类型不合法。 |
InvalidParameterValue.LimitExceeded | 参数值非法,参数值的数量超过最大限制。 |
InvalidParameterValue.Negative | 参数值非法,不能为负值。 |
InvalidParameterValue.OutOfRange | 参数值非法,不在合法范围内。 |
OperationDenied.BundleNotSupportModify | 该实例不支持升级套餐操作。 |
ResourceNotFound.InstanceIdNotFound | 实例 ID 不存在。 |
UnauthorizedOperation.NoPermission | 无权限。 |
UnsupportedOperation.InstanceExpired | 实例已到期,不支持该操作。 |
UnsupportedOperation.InvalidInstanceState | 不支持的操作,实例状态不合法。 |