查询漏洞影响的镜像列表
最近更新时间: 2024-09-03 18:49:49
1. 接口描述
接口请求域名： tcss.api3.cloud.sunhongs.com。
查询漏洞影响的镜像列表
默认接口请求频率限制：20次/秒。
接口更新时间：2023-09-05 07:13:13。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeVulImageList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-11-01 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| PocID | 是 | 否 | String | 漏洞PocID |
| Limit | 否 | 否 | Uint64 | 需要返回的数量，默认为10，最大值为100 |
| Offset | 否 | 否 | Uint64 | 偏移量，默认为0。 |
| Filters | 否 | 否 | Array of RunTimeFilters | 过滤条件。<br><li>OnlyAffectedNewestImage- Bool- 是否必填：否 - 仅展示影响最新版本镜像的漏洞</li><br><li>ImageID- string - 是否必填：否 - 镜像ID</li><br><li>ImageName- String -是否必填: 否 - 镜像名称</li><br><li>HostIP- string -是否必填: 否 - 内网IP</li><br><li>PublicIP- string -是否必填: 否 - 外网IP</li><br><li>ComponentName- string -是否必填: 否 - 组件名称</li><br><li>ComponentVersion- string -是否必填: 否 - 组件版本</li><br><li>HostName- string -是否必填: 否 - 主机名称</li> |
| Order | 否 | 否 | String | 排序方式 |
| By | 否 | 否 | String | 排序字段 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | VulAffectedImageInfo | 受影响的镜像列表 |
| TotalCount | Int64 | 镜像总数 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| MissingParameter | |
| InvalidParameter | |
| AuthFailure | |
| InternalError | |
| ResourceNotFound | |
| InvalidParameter.ParsingError | |
| InvalidParameter.MissingParameter | |
| InvalidParameter.InvalidFormat |