1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
查询最近一次任务发现的检测项的汇总信息列表,按照 检测项 → 资产 的两级层次展开。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeComplianceTaskPolicyItemSummaryList。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
AssetType | 否 | String | 资产类型。仅查询与指定资产类型相关的检测项。 ASSET_CONTAINER, 容器 ASSET_IMAGE, 镜像 ASSET_HOST, 主机 ASSET_K8S, K8S资产 示例值:ASSET_CONTAINER |
Offset | 否 | Integer | 起始偏移量,默认为0。 示例值:1 |
Limit | 否 | Integer | 需要返回的数量,默认为10,最大值为100。 示例值:1 |
Filters.N | 否 | Array of ComplianceFilters | 过滤条件 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | 返回最近一次合规检查任务的ID。这个任务为本次所展示数据的来源。 注意:此字段可能返回 null,表示取不到有效值。 示例值:6767 |
TotalCount | Integer | 返回检测项的总数。 示例值:676 |
PolicyItemSummaryList | Array of CompliancePolicyItemSummary | 返回各检测项对应的汇总信息的列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询上次任务的检测项的汇总信息列表
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeComplianceTaskPolicyItemSummaryList
<公共请求参数>
{
"Offset": 0,
"Limit": 10,
"Filters": [
{
"Name": "RiskLevel",
"Values": [
"3",
"2",
"1",
"0"
],
"ExactMatch": true
},
{
"Name": "ItemType",
"Values": [
"CATEGORY_DOCKER_RUNTIME"
],
"ExactMatch": true
}
],
"AssetType": "ASSET_CONTAINER"
}
输出示例
{
"Response": {
"PolicyItemSummaryList": [
{
"ApplicableVersion": "docker 1.11-1.13, 17.12-20.10.2",
"AssetType": "ASSET_CONTAINER",
"AuditProcedure": "运行以下命令执行检查\ndocker ps --quiet --all | xargs docker inspect --format '{{ .Id }}: Privileged={{ .HostConfig.Privileged }}'",
"BasePolicyItemId": 1,
"BenchmarkStandardId": 1,
"BenchmarkStandardName": "CIS Docker",
"Category": "CATEGORY_DOCKER_RUNTIME",
"CheckResult": "RESULT_FAILED",
"CheckStatus": "CHECK_FINISHED",
"CustomerPolicyItemId": 6190,
"Description": "开启了privileged权限之后,会让容器拥有底层主机的大部分权限,不应该在创建容器时使用该参数",
"FailedAssetCount": 29,
"FixSuggestion": "不要运行带有--privileged标志的容器。 例如,不要启动如下容器:docker run --interactive --tty --privileged centos/bin/bash。",
"IsEnable": 1,
"LastCheckTime": "2024-10-30 02:02:27",
"Name": "确保不使用特权容器",
"PassedAssetCount": 210,
"RiskLevel": "3",
"WhitelistId": 0
}
],
"RequestId": "a9aae028-b4f8-4ec3-8f77-5c102c4b5fcf",
"TaskId": 0,
"TotalCount": 33
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
UnauthorizedOperation | 未授权操作。 |