1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
本接口(DescribeBlueprints)用于查询镜像信息。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBlueprints。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
BlueprintIds.N | 否 | Array of String | 镜像 ID 列表。 示例值:["lhbp-aaaabbbb"] |
Offset | 否 | Integer | 偏移量,默认为 0。关于Offset 的更进一步介绍请参考 API 简介中的相关小节。示例值:0 |
Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。示例值:1 |
Filters.N | 否 | Array of Filter | 过滤器列表。 类型:String 必选:否 取值:APP_OS(应用镜像 );PURE_OS(系统镜像);DOCKER(Docker容器镜像);PRIVATE(自定义镜像);SHARED(共享镜像)。 类型:String 必选:否 取值: LINUX_UNIX(Linux/Unix系统);WINDOWS(Windows 系统)。 类型:String 必选:否 类型:String 必选:否 类型:String 必选:否 类型:String 必选:否 每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 BlueprintIds 和 Filters 。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的镜像数量。 示例值:1 |
BlueprintSet | Array of Blueprint | 镜像详细信息列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询镜像信息
查询镜像信息
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBlueprints
<公共请求参数>
{
"BlueprintIds": [
"lhbp-lf6jlx98"
]
}
输出示例
{
"Response": {
"TotalCount": 1,
"BlueprintSet": [
{
"BlueprintId": "lhbp-lf6jlx98",
"DisplayTitle": "宝塔Linux面板",
"DisplayVersion": "8.1.0 腾讯云专享版",
"BlueprintName": "btpanel_exclusive",
"Description": "宝塔Linux面板(BT-Panel)是一款简单好用的服务器运维管理面板,支持一键LAMP/LNMP/集群/监控/网站/FTP/数据库/JAVA等100多项服务器管理功能,能够极大提升运维管理效率。宝塔面板腾讯云专享版由腾讯云与堡塔公司联合开发,与普通版相比,专享版默认集成腾讯云COSFS、CDN和DNS解析插件,让用户更便捷的使用宝塔面板对腾讯云产品进行管理和操作。该镜像基于OpenCloudOS 9操作系统。",
"OsName": "OpenCloudOS 9",
"Platform": "OPENCLOUDOS",
"PlatformType": "LINUX_UNIX",
"BlueprintType": "APP_OS",
"ImageUrl": "https://cloudcache.tencent-cloud.com/open_proj/proj_qcloud_v2/tc-console/tea-static-lighthouse/src/styles/slice/bt-panel.svg",
"RequiredSystemDiskSize": 20,
"RequiredMemorySize": 1,
"BlueprintState": "NORMAL",
"SupportAutomationTools": true,
"ImageId": "",
"CommunityUrl": "https://www.bt.cn",
"GuideUrl": "https://cloud.tencent.com/document/product/1207/47425",
"SceneIdSet": [
"lhsc-3bzsddow"
],
"DockerVersion": null,
"BlueprintShared": false,
"CreatedTime": "2024-05-08T03:43:06Z"
}
],
"RequestId": "817c4e56-36fc-47ff-bfb6-c4462816972b"
}
}
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.DescribeBlueprintsFailed | 查询镜像失败,请稍后再试。 |
InternalError.InvalidCommandNotFound | 命令无法找到。 |
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 | 参数取值过长,超过最大长度。 |
ResourceNotFound.RoleNotFound | 服务角色不存在, 请为账号添加这个角色。 |
ResourceNotFound.SceneIdNotFound | 未查询到场景ID |
UnauthorizedOperation.NoPermission | 无权限。 |
UnauthorizedOperation.TokenInvalid | 无权限进行此操作,请求中token不合法。 |