1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
本接口(DescribeBundles)用于查询套餐信息。
默认接口请求频率限制:5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeBundles。 |
| Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| BundleIds.N | 否 | Array of String | 套餐 ID 列表。每次请求批量套餐的上限为 100。可通过DescribeBundles接口返回值中的BundleId获取。 示例值:["bundle_ntp_small1_500"] |
| Offset | 否 | Integer | 偏移量,默认为 0。关于 示例值:0 |
| Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。关于 示例值:20 |
| Filters.N | 否 | Array of Filter | 过滤器列表。 |
| Zones.N | 否 | Array of String | 可用区列表。默认为全部可用区。 示例值:["ap-guangzhou-1","ap-guangzhou-2"] |
| BlueprintId | 否 | String | 镜像ID。可以通过DescribeBlueprints接口返回的BlueprintId获取。 示例值:lhbp-etg1zbmm |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BundleSet | Array of Bundle | 套餐详细信息列表。 |
| TotalCount | Integer | 符合要求的套餐总数,用于分页展示。 示例值:2 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询套餐-成功返回
查询套餐-成功返回
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBundles
<公共请求参数>
{
"BundleIds": [
"bundle_ntp_small1_500",
"bundle_bw_small1_1"
]
}
输出示例
{
"Response": {
"BundleSet": [
{
"BundleId": "bundle2022_gen_02",
"CPU": 2,
"Memory": 2,
"SystemDiskType": "CLOUD_SSD",
"SystemDiskSize": 50,
"InternetMaxBandwidthOut": 5,
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"MonthlyTraffic": 500,
"Price": {
"InstancePrice": {
"Currency": "CNY",
"OriginalBundlePrice": 60,
"OriginalPrice": 60,
"Discount": 66.229933,
"DiscountPrice": 39.74
}
},
"SupportLinuxUnixPlatform": true,
"SupportWindowsPlatform": true,
"BundleType": "GENERAL_BUNDLE",
"BundleTypeDescription": "通用型",
"BundleSalesState": "AVAILABLE",
"BundleDisplayLabel": "NORMAL"
}
],
"TotalCount": 1,
"RequestId": "b2563b1d-e93f-4e05-9c6f-096e0c403add"
}
}
示例2 查询套餐时指定镜像
查询套餐时指定镜像
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBundles
<公共请求参数>
{
"BundleIds": [
"bundle_starter_mc_med2_01"
],
"BlueprintId": "lhbp-etg1zbmm"
}
输出示例
{
"Response": {
"BundleSet": [
{
"BundleDisplayLabel": "NORMAL",
"BundleId": "bundle_starter_mc_med2_01",
"BundleSalesState": "SOLD_OUT",
"BundleType": "STARTER_BUNDLE",
"BundleTypeDescription": "入门型",
"CPU": 2,
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"InternetMaxBandwidthOut": 3,
"Memory": 2,
"MonthlyTraffic": 200,
"Price": {
"InstancePrice": {
"Currency": "CNY",
"Discount": 100,
"DiscountPrice": 40,
"OriginalBundlePrice": 40,
"OriginalPrice": 40
}
},
"SupportLinuxUnixPlatform": true,
"SupportWindowsPlatform": true,
"SystemDiskSize": 40,
"SystemDiskType": "CLOUD_SSD",
"TrafficUnlimited": false
}
],
"TotalCount": 1,
"RequestId": "34069df6-5f6c-4a7e-9895-6bd266d67e7d"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.DescribeBundlesFailed | 查询套餐失败。 |
| FailedOperation.RequestError | 请求错误。 |
| FailedOperation.TradeGetPriceFailed | 计费询价失败。 |
| InternalError.InvalidCommandNotFound | 命令无法找到。 |
| InternalError.RequestError | 请求出现错误。 |
| InternalError.TradeGetPriceFailed | 价格获取失败。 |
| InvalidParameter.BundleIdNotFound | 产品未定义的套餐 ID。 |
| InvalidParameter.Conflict | 参数冲突。 |
| InvalidParameter.FilterValueLimitExceeded | 参数非法,Filter 参数中的 Values 取值数量超过允许的最大数量。 |
| InvalidParameter.InvalidFilter | 参数非法,Filter 参数非法。 |
| InvalidParameter.InvalidFilterInvalidKey | 参数非法,Filter 参数中的 Name 取值非法。 |
| InvalidParameter.InvalidFilterInvalidNameNotStr | 参数非法,Filter 参数中的 Name 取值不是字符串。 |
| InvalidParameter.InvalidFilterNotDict | 参数非法,Filter 参数不是字典。 |
| InvalidParameter.InvalidFilterNotSupportedName | 参数非法,Filter 参数中有不支持的 Name。 |
| InvalidParameter.ParameterConflict | 参数非法,参数冲突。 |
| InvalidParameterValue.Duplicated | 参数值非法,不允许包含重复的值。 |
| InvalidParameterValue.InvalidBlueprintPlatformType | 镜像操作系统类型不合法。 |
| InvalidParameterValue.InvalidConsoleDisplayTypes | 控制台显示类型不合法。 |
| InvalidParameterValue.InvalidZone | 参数Zone的取值不合法。 |
| InvalidParameterValue.LimitExceeded | 参数值非法,参数值的数量超过最大限制。 |
| InvalidParameterValue.Negative | 参数值非法,不能为负值。 |
| InvalidParameterValue.OutOfRange | 参数值非法,不在合法范围内。 |
| InvalidParameterValue.ZoneInvalid | 非法的可用区。 |
| UnsupportedOperation.SystemBusy | 系统忙。 |