1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
按照 检测项 → 资产 的两级层次展开的第二层级:资产层级。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCompliancePolicyItemAffectedAssetList。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
CustomerPolicyItemId | 是 | Integer | DescribeComplianceTaskPolicyItemSummaryList返回的CustomerPolicyItemId,表示检测项的ID。 示例值:345643 |
Offset | 否 | Integer | 起始偏移量,默认为0。 示例值:565 |
Limit | 否 | Integer | 需要返回的数量,默认为10,最大值为100。 示例值:4656 |
Filters.N | 否 | Array of ComplianceFilters | 过滤条件。 Name - String Name 可取值:NodeName, CheckResult |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AffectedAssetList | Array of ComplianceAffectedAsset | 返回各检测项所影响的资产的列表。 |
TotalCount | Integer | 检测项影响的资产的总数。 示例值:6456 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询检测项影响的资产列表
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCompliancePolicyItemAffectedAssetList
<公共请求参数>
{
"CustomerPolicyItemId": 45675,
"Offset": 1000,
"Limit": 10,
"Filters": [
{
"Name": "NodeName",
"Values": [
"node-1"
],
"ExactMatch": true
}
]
}
输出示例
{
"Response": {
"AffectedAssetList": [
{
"AssetName": "hyperkube",
"AssetType": "ASSET_IMAGE",
"CheckResult": "RESULT_FAILED",
"CheckStatus": "CHECK_FINISHED",
"ClusterID": "cls-5licssbi",
"ClusterName": "piper-容器告警接入安全中心测试",
"CustomerAssetId": 1001005017196,
"HostIP": "172.17.1.53",
"ImageRegistryInfo": {
"Address": "",
"Name": "",
"Type": ""
},
"ImageTag": "v1.22.5-tke.27-rc1",
"InstanceId": "ins-4bi3i496",
"LastCheckTime": "2024-10-29 02:02:18",
"NodeName": "as-tke-np-7lmwo8pi",
"VerifyInfo": "sha256:f5b7776211ac931c484d203db03ed67e8b2dd44e0697119d02796a7d50041bcf:User="
}
],
"RequestId": "dce87f72-d7ad-4ed4-8cd4-688a8464aad3",
"TotalCount": 186
}
}
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 | 请求的次数超过了频率限制。 |