1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
查询某资产下的检测项列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeComplianceAssetPolicyItemList。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
CustomerAssetId | 是 | Integer | 客户资产的ID。 示例值:111 |
Offset | 否 | Integer | 起始偏移量,默认为0。 示例值:10 |
Limit | 否 | Integer | 要获取的数据量,默认为10,最大为100。 示例值:10 |
Filters.N | 否 | Array of ComplianceFilters | 过滤器列表。Name字段支持 RiskLevel, AppId |
AssetType | 否 | String | 资产类型 示例值:ASSET_CONTAINER |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 返回检测项的总数。如果用户未启用基线检查,此处返回0。 示例值:10 |
AssetPolicyItemList | Array of ComplianceAssetPolicyItem | 返回某个资产下的检测项的列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求资产检测项列表
请求资产检测项列表
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeComplianceAssetPolicyItemList
<公共请求参数>
{
"CustomerAssetId": 2202462,
"Offset": 0,
"Limit": 3,
"AssetType": "ASSET_CONTAINER"
}
输出示例
{
"Response": {
"AssetPolicyItemList": [
{
"BasePolicyItemId": 142,
"BenchmarkStandardId": 1,
"BenchmarkStandardName": "CIS Docker",
"Category": "CATEGORY_DOCKER_RUNTIME",
"CheckResult": "RESULT_PASSED",
"CheckStatus": "CHECK_FINISHED",
"CustomerPolicyItemId": 2809,
"FixSuggestion": "使用--health-cmd和其他参数运行容器。 例如,docker run -d --health-cmd ='stat /etc/passwd || exit1'nginx。",
"LastCheckTime": "2024-07-24 11:12:16",
"Name": "检查容器运行时的健康状态",
"RiskLevel": "1",
"VerifyInfo": "e822238a07e0d193a12c0608f2d821812664d3d9cf5871cc9bedc9eab562e602:Healthcheck=null\n",
"WhitelistId": 0
},
{
"BasePolicyItemId": 141,
"BenchmarkStandardId": 1,
"BenchmarkStandardName": "CIS Docker",
"Category": "CATEGORY_DOCKER_RUNTIME",
"CheckResult": "RESULT_PASSED",
"CheckStatus": "CHECK_FINISHED",
"CustomerPolicyItemId": 2808,
"FixSuggestion": "如无必须,不要使用 --cgroup-parent 选项在docker运行。",
"LastCheckTime": "2024-07-24 11:12:16",
"Name": "确保cgroup安全使用",
"RiskLevel": "1",
"VerifyInfo": "e822238a07e0d193a12c0608f2d821812664d3d9cf5871cc9bedc9eab562e602:CgroupParent=\n",
"WhitelistId": 0
},
{
"BasePolicyItemId": 140,
"BenchmarkStandardId": 1,
"BenchmarkStandardName": "CIS Docker",
"Category": "CATEGORY_DOCKER_RUNTIME",
"CheckResult": "RESULT_PASSED",
"CheckStatus": "CHECK_FINISHED",
"CustomerPolicyItemId": 2807,
"FixSuggestion": "在docker exec命令中不要使用--privileged选项。",
"LastCheckTime": "2024-07-24 11:12:16",
"Name": "确保docker exec命令不能使用特权选项",
"RiskLevel": "2",
"VerifyInfo": "e822238a07e0d193a12c0608f2d821812664d3d9cf5871cc9bedc9eab562e602:ExecIDs=null\n",
"WhitelistId": 0
}
],
"RequestId": "dc08e10e-5ac8-4e94-9321-6c2f89d8ed5c",
"TotalCount": 24
}
}
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 | 参数错误。 |
InvalidParameter.MissingParameter | 缺少必须参数。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |