分页查询已加入病毒文件自动隔离范围的主机及其 Agent、分组和在线状态。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | GetAutoIsolateAgentList | 要执行的操作,取值:GetAutoIsolateAgentList。 |
Version | String | 是 | 2024-05-08 | API的版本,取值:2024-05-08。 |
SortBy | String | 否 | LastHeartbeatTime | 排序字段。本接口不支持自定义排序,结果按默认顺序返回。 |
SortOrder | String | 否 | Desc | 排序顺序
|
Tags | Array of String | 否 | ["production"] | 主机TAG |
AgentId | String | 否 | agent-id-001 | 主机ID |
CloudProviders | Array of String | 否 | ["volc"] | 云厂商列表,精确匹配;可选值 volc(火山引擎)、volc_edge(火山边缘云)、ali(阿里云)、tencent(腾讯云)、huawei(华为云)、aws(AWS)、ibm(IBM Cloud)、azure(Azure)、idc(云外主机);不传时不按云厂商筛选 |
Hostname | String | 否 | host-001 | 主机名称 |
LeafGroupIDs | Array of String | 否 | ["group-id-101","group-id-102"] | 叶子分组 ID 列表,可通过多级分组查询接口获取;不传时不限制叶子分组 |
PageNumber | Long | 是 | 1 | 翻页页码,取值范围为 1 及以上 |
Ip | String | 否 | 192.0.2.10 | 主机 IP;支持公网 IP、私网主 IP、IP 列表与公网出口 IP 模糊匹配,IPv4、IPv6 均可 |
PageSize | Long | 是 | 20 | 每页记录数,取值范围为 1~1000 |
TopGroupID | String | 否 | group-id-001 | 根分组 ID,可通过多级分组查询接口获取;不传时不限制根分组 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Data | Array of Object | -- | 分页业务数据,具体元素结构见各接口响应声明 |
PageNumber | Long | 1 | 当前页面 |
PageSize | Long | 20 | 页面大小 |
TotalCount | Long | 1 | 全部数据条数 |
POST /?Action=GetAutoIsolateAgentList&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 { "AgentId": "agent-id-001", "CloudProviders": [ "volc" ], "Hostname": "host-001", "Ip": "192.0.2.10", "LeafGroupIDs": [ "group-id-101", "group-id-102" ], "PageNumber": 1, "PageSize": 20, "SortBy": "LastHeartbeatTime", "SortOrder": "Desc", "Tags": [ "production" ], "TopGroupID": "group-id-001" }
{ "ResponseMetadata": { "RequestId": "20241120165538010234567890", "Action": "GetAutoIsolateAgentList", "Version": "2024-05-08", "Service": "seccenter", "Region": "cn-beijing" }, "Result": { "Data": [ { "AgentID": "agent-id-001", "EcsInstance": { "AccessKey": "AKLTEXAMPLE001", "AccountID": "account-id-001", "Architecture": "amd64", "Cpu": 1, "CreatedAt": "2024-05-08T10:00:00Z", "ECSUpdateAt": "2024-05-08T10:00:00Z", "EipAddress": "192.0.2.10", "HostName": "host-001", "IPList": [ "192.0.2.10" ], "InstanceName": "example-name", "Mem": 1, "OsName": "veLinux 1.0 64位", "OsType": "veLinux", "Platform": "Linux", "PlatformVersion": "1.0", "PrimaryIpAddress": "192.0.2.10", "Region": "cn-beijing", "SecurityEnhancementStrategy": "security-enhancement-strategy-sample", "Status": "RUNNING", "Visibility": "visibility-sample", "VpcId": "vpc-id-001", "VpcName": "example-name", "ZoneId": "cn-beijing-a" }, "ExtranetIPv4": [ "192.0.2.10" ], "ExtranetIPv6": [ "192.0.2.10" ], "Hostname": "host-001", "ImportantProtect": true, "IntranetIPv4": [ "192.0.2.10" ], "IntranetIPv6": [ "192.0.2.10" ], "Tags": [ "production" ], "UpdateTime": 1786579199 } ], "PageNumber": 1, "PageSize": 20, "TotalCount": 1 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | MissingParameter | 请求参数缺失,请检查参数是否已正确传入。 |
400 | InvalidParameter | 请求参数错误,请检查参数传递内容是否正确。 |
400 | OperationDenied | 不允许的操作,请检查当前资源是否被占用。 |
500 | InternalError | 服务器内部错误,请稍后重试或联系技术支持。 |
500 | DBOperateError | 数据库操作异常,请稍后重试或联系技术支持。 |