分页查询指定漏洞影响的主机或开发机,返回资产、软件、修复和检测信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListVulnHosts | 要执行的操作,取值:ListVulnHosts。 |
Version | String | 是 | 2024-05-08 | API的版本,取值:2024-05-08。 |
AgentIDList | Array of String | 否 | ["agent-id-001"] | 主机ID列表 |
CwppID | String | 否 | vuln-id-001 | 漏洞ID |
LeafGroupIDs | Array of String | 否 | ["group-id-001"] | 叶子分组ID列表 LeafGroupIDs 不传时不指定叶子分组 |
PageSize | Long | 是 | 20 | 每页记录数,取值范围为 1~1000 |
AgentTags | Array of String | 否 | ["production"] | 主机标签 |
AssetName | String | 否 | example-name | 开发机名称,AssetType 为 Dev 时可按名称模糊筛选;不传时不按开发机名称筛选 |
AssetType | String | 否 | Dev | 资产类型, Dev: 开发机, Host:主机, 默认主机 |
IP | String | 否 | 192.0.2.10 | 主机ip |
PageNumber | Long | 是 | 1 | 翻页页码,取值范围为 1 及以上 |
SortOrder | String | 否 | Desc | 排序顺序
|
AssetIDs | Array of String | 否 | ["asset-id-001"] | 资产ID列表,AssetType为Dev时上送 |
HostName | String | 否 | host-001 | 主机名 |
AssetIP | String | 否 | 192.0.2.10 | 开发机IP,AssetType为Dev时上送 |
CloudProviders | Array of String | 否 | ["ali"] | 云厂商列表;可选值 volc(火山引擎)、volc_edge(火山边缘云)、ali(阿里云)、tencent(腾讯云)、huawei(华为云)、aws(AWS)、ibm(IBM Cloud)、azure(Azure)、idc(云外主机);不传时不按云厂商筛选 |
IsRealRiskVul | Boolean | 否 | true | 是否真实风险漏洞 |
SortBy | String | 否 | LastHeartbeatTime | 排序字段。支持取值:CreateTime(创建时间)、UpdateTime(更新时间);仅以上取值生效。传入其他取值时不生效。未指定时按接口默认顺序返回。 |
Status | Array of String | 否 | ["unprocessed"] | 漏洞处理状态, unprocessed: 未处理, processed: 已处理, ignored: 已忽略 |
TopGroupID | String | 否 | group-id-001 | 根分组ID TopGroupID 不传时不按根分组限定,规则覆盖当前账户全部分组 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
TotalCount | Long | 1 | 全部数据条数 |
Data | Array of Object | -- | 分页业务数据,具体元素结构见各接口响应声明 |
PageNumber | Long | 1 | 当前页面 |
PageSize | Long | 20 | 页面大小 |
POST /?Action=ListVulnHosts&Version=2024-05-08 HTTP/1.1 Host: seccenter.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20241120T080538Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "AgentIDList": [ "agent-id-001" ], "AgentTags": [ "production" ], "AssetIDs": [ "asset-id-001" ], "AssetIP": "192.0.2.10", "AssetName": "example-name", "AssetType": "Dev", "CloudProviders": [ "ali" ], "CwppID": "vuln-id-001", "HostName": "host-001", "IP": "192.0.2.10", "IsRealRiskVul": true, "LeafGroupIDs": [ "group-id-001" ], "PageNumber": 1, "PageSize": 20, "SortBy": "LastHeartbeatTime", "SortOrder": "Desc", "Status": [ "unprocessed" ], "TopGroupID": "group-id-001" }
{ "ResponseMetadata": { "RequestId": "20241120165538010234567890", "Action": "ListVulnHosts", "Version": "2024-05-08", "Service": "seccenter", "Region": "cn-beijing" }, "Result": { "Data": [ { "AgentID": "agent-id-001", "AgentTags": [ "production" ], "AssetID": "asset-id-001", "AssetName": "example-name", "ControlTime": 1786579199, "CreateTime": 1786492800, "CwppID": "vuln-id-001", "EipAddress": "192.0.2.10", "HostName": "host-001", "OperateReason": "example description", "PrimaryIpAddress": "192.0.2.10", "Status": "unprocessed", "UpdateTime": 1786579199 } ], "PageNumber": 1, "PageSize": 20, "TotalCount": 1 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | MissingParameter | 请求参数缺失,请检查参数是否已正确传入。 |
400 | InvalidParameter | 请求参数错误,请检查参数传递内容是否正确。 |
400 | OperationDenied | 不允许的操作,请检查当前资源是否被占用。 |
500 | InternalError | 服务器内部错误,请稍后重试或联系技术支持。 |
500 | DBOperateError | 数据库操作异常,请稍后重试或联系技术支持。 |