容器安全服务查询workload类型的影响范围

1. 接口描述

接口请求域名： tcss.tencentcloudapi.com 。

查询workload类型的影响范围，返回workload列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAffectedWorkloadList。
Version	是	String	公共参数，本接口取值：2020-11-01。
Region	否	String	公共参数，此参数为可选参数。
CheckItemId	是	Integer	唯一的检测项的ID 示例值：1
Offset	否	Integer	偏移量示例值：0
Limit	否	Integer	每次查询的最大记录数量示例值：20
Filters.N	否	Array of ComplianceFilters	Name - String Name 可取值：WorkloadType,ClusterId 示例值：[{"ExactMatch": false, "Name": "Clust", "Values": ["57153b3ea9483f46f5dd9a0052ca"]}]
By	否	String	排序字段示例值：WorkloadName
Order	否	String	排序方式 asc,desc 示例值：asc

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	受影响的workload列表数量示例值：1
AffectedWorkloadList	Array of AffectedWorkloadItem	受影响的workload列表示例值：[{"ClusterId": "57153b3ea9483f46f5dd9a0052ca", "ClusterName": "yancy", "Region": null, "VerifyInfo": "RoleBinding/default-pod-writer bind Role/pod-writer(read-write) in [p", "WorkloadName": "default/def", "WorkloadType": "ServiceAcc****"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询workload类型的影响范围示例

输入示例

POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAffectedWorkloadList
<公共请求参数>

{
    "CheckItemId": 10071,
    "Limit": 10,
    "Offset": 0
}

输出示例

{
    "Response": {
        "AffectedWorkloadList": [
            {
                "ClusterId": "test-clusterid",
                "ClusterName": "benben-tcss",
                "Region": "ap-guangzhou",
                "VerifyInfo": "yunjing-agent set image tag \"latest\"",
                "WorkloadName": "tcss/yunjing-agent",
                "WorkloadType": "DaemonSet"
            }
        ],
        "RequestId": "299deeb1-48aa-449d-980c-1f46e2375cec",
        "TotalCount": "0"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
OperationDenied	操作被拒绝。
RequestLimitExceeded	请求的次数超过了频率限制。
UnauthorizedOperation	未授权操作。

查询workload类型的影响范围

本页目录：