<h2 1. 接口描述
接口请求域名： lighthouse.tencentcloudapi.com 。
本接口（DescribeBlueprints）用于查询镜像信息。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
<h2 2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBlueprints。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BlueprintIds.N | 否 | Array of String | 镜像 ID 列表。 |
| Offset | 否 | Integer | 偏移量，默认为 0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。 |
| Limit | 否 | Integer | 返回数量，默认为 20，最大值为 100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。 |
| Filters.N | 否 | Array of Filter | 过滤器列表。
按照【镜像 ID】进行过滤。 按照【镜像类型】进行过滤。 按照【镜像平台类型】进行过滤。 按照【镜像名称】进行过滤。 按照【镜像状态】进行过滤。 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 5。参数不支持同时指定 BlueprintIds 和 Filters 。 |
<h2 3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的镜像数量。 |
| BlueprintSet | Array of Blueprint | 镜像详细信息列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
<h2 4. 示例
<h3 示例1 查询镜像信息
<h4 输入示例
https://lighthouse.tencentcloudapi.com/?Action=DescribeBlueprints &BlueprintIds.0=lhbp-5e8807sc &<公共请求参数><h4 输出示例
{ "Response": { "TotalCount": 1, "BlueprintSet": [ { "BlueprintId": "lhbp-5e8807sc", "DisplayTitle": "wordpress", "DisplayVersion": "5.3.2", "Description": "个人blog建站", "OsName": "CentOS-7.6-64bit", "Platform": "CENTOS", "PlatformType": "LINUX_UNIX", "BlueprintType": "APP_OS", "ImageUrl": "http://www.wordpress.com/image", "RequiredSystemDiskSize": 50, "BlueprintState": "NORMAL", "CreatedTime": "2020-04-28T03:46:09Z", "BlueprintName": "Wordpress", "SupportAutomationTools": true, "RequiredMemorySize": 1, "ImageId": "" } ], "RequestId": "3df9cd92-cec1-4864-a2a1-358084f41551" } }<h2 5. 开发者资源
<h3 腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
<h3 API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
<h3 SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
<h3 命令行工具
- Tencent Cloud CLI 3.0
<h2 6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.InvalidCommandNotFound | 命令 DescribeInstanceLoginKeyPair 无法找到。 |
| 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.BlueprintIdMalformed | 参数值非法，镜像 ID 格式非法。 |
| InvalidParameterValue.Duplicated | 参数值非法，不允许包含重复的值。 |
| InvalidParameterValue.InvalidBlueprintPlatformType | 镜像操作系统类型不合法。 |
| InvalidParameterValue.InvalidBlueprintState | 镜像状态取值非法。 |
| InvalidParameterValue.InvalidBlueprintType | 镜像类型不合法。 |
| InvalidParameterValue.LimitExceeded | 参数值非法，参数值的数量超过最大限制。 |
| InvalidParameterValue.Negative | 参数值非法，不能为负值。 |
| InvalidParameterValue.OutOfRange | 参数值非法，不在合法范围内。 |
| InvalidParameterValue.TooLong | 参数取值过长，超过最大长度。 |
发表回复