1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
本接口(DescribeBlueprintBundles)用于查询镜像所对应的套餐。当前仅支持查询镜像类型为游戏专区的镜像ID。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeBlueprintBundles。 |
| Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| BlueprintId | 是 | String | 镜像ID。可以通过DescribeBlueprints接口返回的BlueprintId获取。当前仅支持传入镜像类型为游戏专区(“GAME_PORTAL”)的镜像Id。 示例值:lhbp-cvxd37ml |
| BundleIds.N | 否 | Array of String | 套餐ID列表。可以通过DescribeBlueprintBundles接口返回的BundleId获取。 示例值:["bundle_game_mc_gen_04"] |
| Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。 示例值:30 |
| Offset | 否 | Integer | 偏移量,默认为 0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BlueprintBundleSet | Array of BlueprintBundle | 镜像套餐详细信息列表。 |
| TotalCount | Integer | 符合要求的套餐总数,用于分页展示。 示例值:10 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询镜像实例
查询镜像实例
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBlueprintBundles
<公共请求参数>
{
"BlueprintId": "lhbp-5e886mc4"
}
输出示例
{
"Response": {
"BlueprintBundleSet": [
{
"BundleId": "bundle_game_mc_gen_03",
"CPU": 2,
"Memory": 8,
"SystemDiskType": "CLOUD_SSD",
"SystemDiskSize": 50,
"InternetMaxBandwidthOut": 6,
"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
"MonthlyTraffic": 500,
"Price": {
"InstancePrice": {
"Currency": "CNY",
"OriginalBundlePrice": 80,
"OriginalPrice": 80,
"Discount": 100,
"DiscountPrice": 80
}
},
"SupportLinuxUnixPlatform": true,
"SupportWindowsPlatform": true,
"BundleType": "GAME_PORTAL_BUNDLE",
"BundleTypeDescription": "游戏专区",
"BundleTypePriority": 110,
"BundleSalesState": "AVAILABLE",
"BundleDisplayLabel": "NORMAL",
"SupportSlot": 4
}
],
"TotalCount": 1,
"RequestId": "a04dba8e-efb7-4c9b-ac19-2b5b779b3e1b"
}
}
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.DescribeBlueprintBundlesFailed | 查询镜像套餐失败,请稍后重新操作。 |
| InvalidParameterValue.InvalidBlueprintType | 镜像类型不合法。 |
| InvalidParameterValue.InvalidBundle | 非法的套餐参数。 |
| ResourceNotFound.BlueprintNotFound | 指定的镜像不存在。请检查镜像的BlueprintId是否正确。 |