1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
查询镜像详细信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAssetImageDetail。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ImageID | 是 | String | 镜像id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ImageID | String | 镜像ID |
ImageName | String | 镜像名称 |
ImageDigest | String | 镜像摘要 |
CreateTime | String | 创建时间 |
Size | Integer | 镜像大小 |
HostCnt | Integer | 关联主机个数 注意:此字段可能返回 null,表示取不到有效值。 |
ContainerCnt | Integer | 关联容器个数 注意:此字段可能返回 null,表示取不到有效值。 |
ScanTime | String | 最近扫描时间 注意:此字段可能返回 null,表示取不到有效值。 |
VulCnt | Integer | 漏洞个数 注意:此字段可能返回 null,表示取不到有效值。 |
RiskCnt | Integer | 风险行为数 注意:此字段可能返回 null,表示取不到有效值。 |
SensitiveInfoCnt | Integer | 敏感信息数 注意:此字段可能返回 null,表示取不到有效值。 |
IsTrustImage | Boolean | 是否信任镜像 |
OsName | String | 镜像系统 |
AgentError | String | agent镜像扫描错误 注意:此字段可能返回 null,表示取不到有效值。 |
ScanError | String | 后端镜像扫描错误 注意:此字段可能返回 null,表示取不到有效值。 |
Architecture | String | 系统架构 注意:此字段可能返回 null,表示取不到有效值。 |
Author | String | 作者 注意:此字段可能返回 null,表示取不到有效值。 |
BuildHistory | String | 构建历史 注意:此字段可能返回 null,表示取不到有效值。 |
ScanVirusProgress | Integer | 木马扫描进度 注意:此字段可能返回 null,表示取不到有效值。 |
ScanVulProgress | Integer | 漏洞扫进度 注意:此字段可能返回 null,表示取不到有效值。 |
ScanRiskProgress | Integer | 敏感信息扫描进度 注意:此字段可能返回 null,表示取不到有效值。 |
ScanVirusError | String | 木马扫描错误 注意:此字段可能返回 null,表示取不到有效值。 |
ScanVulError | String | 漏洞扫描错误 注意:此字段可能返回 null,表示取不到有效值。 |
ScanRiskError | String | 敏感信息错误 注意:此字段可能返回 null,表示取不到有效值。 |
ScanStatus | String | 镜像扫描状态 注意:此字段可能返回 null,表示取不到有效值。 |
VirusCnt | Integer | 木马病毒数 注意:此字段可能返回 null,表示取不到有效值。 |
Status | Integer | 镜像扫描状态 注意:此字段可能返回 null,表示取不到有效值。 |
RemainScanTime | Integer | 剩余扫描时间 注意:此字段可能返回 null,表示取不到有效值。 |
IsAuthorized | Integer | 授权为:1,未授权为:0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询镜像详细信息
查询镜像详细信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetImageDetail
<公共请求参数>
{
"ImageID": "dskaldjskld"
}
输出示例
{
"Response": {
"ImageID": "abc",
"ImageName": "abc",
"CreateTime": "abc",
"Size": 1,
"HostCnt": 1,
"ContainerCnt": 1,
"ScanTime": "abc",
"VulCnt": 1,
"RiskCnt": 1,
"SensitiveInfoCnt": 1,
"IsTrustImage": true,
"OsName": "abc",
"AgentError": "abc",
"ScanError": "abc",
"Architecture": "abc",
"Author": "abc",
"BuildHistory": "abc",
"ScanVirusProgress": 1,
"ScanVulProgress": 1,
"ScanRiskProgress": 1,
"ScanVirusError": "abc",
"ScanVulError": "abc",
"ScanRiskError": "abc",
"ScanStatus": "abc",
"VirusCnt": 1,
"Status": 1,
"RemainScanTime": 1,
"IsAuthorized": 0,
"ImageDigest": "abc",
"RequestId": "abc"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.MainDBFail | 操作数据库失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParsingError | 参数解析错误。 |
ResourceNotFound | 资源不存在。 |