1. 接口描述
接口请求域名： tcss.tencentcloudapi.com 。
查询容器安全概览信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTcssSummary。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ImageCnt | Integer | 镜像总数 示例值：10 |
| ScannedImageCnt | Integer | 已扫描镜像数 示例值：10 |
| UnScannedImageCnt | Integer | 待扫描镜像个数 示例值：10 |
| LocalImageCnt | Integer | 本地镜像个数 示例值：10 |
| RepositoryImageCnt | Integer | 仓库镜像个数 示例值：10 |
| RiskLocalImageCnt | Integer | 风险本地镜像个数 示例值：10 |
| RiskRepositoryImageCnt | Integer | 风险仓库镜像个数 示例值：10 |
| ContainerCnt | Integer | 容器个数 示例值：10 |
| RiskContainerCnt | Integer | 风险容器个数 示例值：10 |
| ClusterCnt | Integer | 集群个数 示例值：10 |
| RiskClusterCnt | Integer | 风险集群个数 示例值：10 |
| UnScannedVulCnt | Integer | 待扫描漏洞个数 示例值：10 |
| RiskVulCnt | Integer | 风险漏洞个数 示例值：10 |
| UnScannedBaseLineCnt | Integer | 安全基线待扫描项个数 示例值：10 |
| RiskBaseLineCnt | Integer | 安全基线风险个数 示例值：10 |
| RuntimeUnhandleEventCnt | Integer | 运行时(高危)待处理事件个数 示例值：10 |
| UnScannedClusterCnt | Integer | 待扫描集群个数 示例值：10 |
| ScanImageStatus | Boolean | 是否已扫描镜像 示例值：true |
| ScanClusterStatus | Boolean | 是否已扫描集群 示例值：true |
| ScanBaseLineStatus | Boolean | 是否已扫描基线 示例值：true |
| ScanVulStatus | Boolean | 是否已扫描漏洞 示例值：true |
| VulRiskImageCnt | Integer | 漏洞影响镜像数 示例值：10 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询容器安全概览信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTcssSummary
<公共请求参数>
{}输出示例
{
"Response": {
"RiskLocalImageCnt": 1,
"RiskRepositoryImageCnt": 1,
"RuntimeUnhandleEventCnt": 1,
"RiskBaseLineCnt": 1,
"ScannedImageCnt": 1,
"RiskVulCnt": 1,
"RiskContainerCnt": 1,
"ImageCnt": 1,
"ContainerCnt": 1,
"UnScannedVulCnt": 1,
"UnScannedBaseLineCnt": 1,
"RiskClusterCnt": 1,
"ClusterCnt": 1,
"UnScannedImageCnt": 1,
"LocalImageCnt": 1,
"RepositoryImageCnt": 1,
"UnScannedClusterCnt": 1,
"ScanImageStatus": true,
"ScanClusterStatus": true,
"ScanBaseLineStatus": true,
"ScanVulStatus": true,
"VulRiskImageCnt": 10,
"RequestId": "29b37d86-f63d-43d1-b21a-640e82965198"
}
}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 | 内部错误。 |
| InvalidParameter | 参数错误。 |