1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
按照 检测项 → 资产 的两级层次展开的第一层级:检测项层级。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCompliancePolicyItemAffectedSummary。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
CustomerPolicyItemId | 是 | Integer | DescribeComplianceTaskPolicyItemSummaryList返回的CustomerPolicyItemId,表示检测项的ID。 示例值:667 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PolicyItemSummary | CompliancePolicyItemSummary | 返回各检测项影响的资产的汇总信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询某检测项影响的信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCompliancePolicyItemAffectedSummary
<公共请求参数>
{
"CustomerPolicyItemId": 474567
}
输出示例
{
"Response": {
"PolicyItemSummary": {
"ApplicableVersion": "docker 1.11-1.13, 17.12-20.10.2",
"AssetType": "ASSET_IMAGE",
"AuditProcedure": "执行以下命令审计\ndocker ps --quiet | xargs --max-args=1 -I{} docker exec {} cat /proc/1/status | grep '^Uid:' | awk '{print $3}'",
"BasePolicyItemId": 178,
"BenchmarkStandardId": 2,
"BenchmarkStandardName": "CIS Docker",
"Category": "CATEGORY_DOCKER_IMAGES_BUILD_FILE",
"CheckResult": "RESULT_FAILED",
"CheckStatus": "CHECK_FINISHED",
"CustomerPolicyItemId": 5914,
"Description": "在可能的情况下,最好以非root用户的身份运行容器。",
"FailedAssetCount": 208,
"FixSuggestion": "确保容器镜像的Dockerfile包含以下指令:USER <用户名或ID> 其中用户名或ID是指可以在容器基础镜像中找到的用户。 如果在容器基础镜像中没有创建特定用户,则在USER指令之前添加useradd命令以添加特定用户。例如,在Dockerfile中创建用户:RUN useradd -d /home/username -m -s /bin/bash username USER username注意:如果镜像中有容器不需要的用户,请考虑删除它们。 删除这些用户后,提交镜像,然后生成新的容器实例以供使用。",
"IsEnable": 0,
"LastCheckTime": "2024-10-30 02:02:09",
"Name": "确保创建使用容器的用户",
"PassedAssetCount": 0,
"RiskLevel": "1",
"WhitelistId": 0
},
"RequestId": "3e8b4c60-58ba-4acc-97fc-33f086c7a3bb"
}
}
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 | 请求的次数超过了频率限制。 |