{ "name": "cwp", "display_name": "主机安全", "description": "介绍如何使用API对主机安全进行操作，包括资产管理、漏洞管理等。", "domain": "security", "api_version": "2018-02-28", "endpoint": "cwp.tencentcloudapi.com", "actions": [ { "name": "AddLoginWhiteLists", "description": "批量添加异地登录白名单", "status": "online", "parameters": [ { "name": "HostLoginWhiteObj", "type": "object", "required": true, "description": "异地登录白名单实体", "example": "{\"EndTime\": \"2020-11-11 10:1****\", \"HostInfos\": [{\"Quuid\": \"f3567720-cb97-4dd8-919d-6d41506c****\", \"Uuid\": \"f3567720-cb97-4dd8-919d-6d41506c****\"}], \"IsGlobal\": 1, \"Places\": [{\"CityId\": 197, \"CountryId\": 1, \"Location\": \"\\u5e7f\\u4e1c\\u7701-\\u5e7f\\u5dde\\u5e02\", \"ProvinceId\": 19}], \"Remark\": \"\\u5821\\u5792\\u673a\\u5230jump\", \"SrcIp\": \"197.135.****\", \"StartTime\": \"2020-11-11 10:1****\", \"UserName\": \"root\"}", "children": [ { "name": "Places", "type": "array", "required": true, "description": "加白地域", "example": "无", "item_type": "object", "children": [ { "name": "CityId", "type": "integer", "required": true, "description": "城市 ID。", "example": "99" }, { "name": "ProvinceId", "type": "integer", "required": true, "description": "省份 ID。", "example": "23" }, { "name": "CountryId", "type": "integer", "required": true, "description": "国家ID，暂只支持境内：1。", "example": "104" }, { "name": "Location", "type": "string", "required": false, "description": "位置名称", "example": "中国:北京市:北京市" } ] }, { "name": "SrcIp", "type": "string", "required": true, "description": "加白源IP，支持网段，多个IP以逗号隔开", "example": "10.0.1.11" }, { "name": "UserName", "type": "string", "required": true, "description": "加白用户名，多个用户名以逗号隔开", "example": "root" }, { "name": "IsGlobal", "type": "integer", "required": true, "description": "是否对全局生效, 1：全局有效 0: 仅针对单台主机'", "example": "1" }, { "name": "HostInfos", "type": "array", "required": true, "description": "白名单生效的机器信息列表", "example": "无", "item_type": "object", "children": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "d99a1b46-cc2d-4633-a11f-4a7663d2523e" }, { "name": "Uuid", "type": "string", "required": true, "description": "Uuid主机", "example": "d99a1b46-cc2d-4633-a11f-4a7663d2523e" } ] }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "内部使用" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "08:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "22:00" } ] }, { "name": "ProcessType", "type": "string", "required": false, "description": "事件同步处理方式： \"\" -- 不操作 \"All\" -- 将符合此配置的所有事件记录加白 \"Id\" -- 将EventId对应的事件记录加白", "example": "All" }, { "name": "EventId", "type": "integer", "required": false, "description": "异地登录事件ID，当ProcessType为Id时此项必填", "example": "1" } ], "required": [ "HostLoginWhiteObj" ] }, { "name": "ChangeRuleEventsIgnoreStatus", "description": "根据检测项id或事件id批量忽略事件或取消忽略", "status": "online", "parameters": [ { "name": "IgnoreStatus", "type": "integer", "required": true, "description": "忽略状态 0:取消忽略 ； 1:忽略", "example": "1" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "检测项id数组", "example": "[1,2]", "item_type": "integer" }, { "name": "EventIdList", "type": "array", "required": false, "description": "事件id数组", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IgnoreStatus" ] }, { "name": "ChangeStrategyEnableStatus", "description": "根据策略id修改策略可用状态", "status": "online", "parameters": [ { "name": "StrategyId", "type": "integer", "required": true, "description": "基线策略id", "example": "1" }, { "name": "Status", "type": "integer", "required": true, "description": "开关状态", "example": "0" } ], "required": [ "StrategyId", "Status" ] }, { "name": "CheckBashPolicyParams", "description": "校验高危命令用户规则新增和编辑时的参数。", "status": "online", "parameters": [ { "name": "CheckField", "type": "string", "required": true, "description": "校验内容字段,如果需要检测多个字段时,用逗号分割 Name 策略名称 Process 进程 Name PProcess 父进程 Name AProcess 祖先进程", "example": "Name,Process" }, { "name": "EventId", "type": "integer", "required": false, "description": "在事件列表中新增白名时需要提交事件ID", "example": "10003" }, { "name": "Name", "type": "string", "required": false, "description": "填入的规则名称", "example": "规则1" }, { "name": "Rule", "type": "string", "required": false, "description": "该字段不在维护,如果填入该参数,自动替换到Rules.Process", "example": "rm -rf /tmp/tmp\\\\.ERYbwgd8e9" }, { "name": "Id", "type": "integer", "required": false, "description": "编辑时传的规则id", "example": "1230" }, { "name": "Rules", "type": "object", "required": false, "description": "规则表达式", "example": "rm -rf /tmp/tmp\\\\.ERYbwgd8e9", "children": [ { "name": "Process", "type": "object", "required": false, "description": "进程", "example": "{\"Exe\":\"/tmp/test\",\"Cmdline\":\"/tmp/test\"}", "children": [ { "name": "Exe", "type": "string", "required": false, "description": "路径,需要base64加密", "example": "/tmp/test" }, { "name": "Cmdline", "type": "string", "required": false, "description": "命令行,需要base64加密", "example": "sh test.sh" } ] }, { "name": "PProcess", "type": "object", "required": false, "description": "父进程", "example": "{\"Exe\":\"/tmp/test\",\"Cmdline\":\"/tmp/test\"}", "children": [ { "name": "Exe", "type": "string", "required": false, "description": "路径,需要base64加密", "example": "/tmp/test" }, { "name": "Cmdline", "type": "string", "required": false, "description": "命令行,需要base64加密", "example": "sh test.sh" } ] }, { "name": "AProcess", "type": "object", "required": false, "description": "祖先进程", "example": "{\"Exe\":\"/tmp/test\",\"Cmdline\":\"/tmp/test\"}", "children": [ { "name": "Exe", "type": "string", "required": false, "description": "路径,需要base64加密", "example": "/tmp/test" }, { "name": "Cmdline", "type": "string", "required": false, "description": "命令行,需要base64加密", "example": "sh test.sh" } ] } ] } ], "required": [ "CheckField" ] }, { "name": "CheckBashRuleParams", "description": "校验高危命令用户规则新增和编辑时的参数。", "status": "online", "parameters": [ { "name": "CheckField", "type": "string", "required": true, "description": "校验内容 Name或Rule ，两个都要校验时逗号分割", "example": "Name,Rule" }, { "name": "EventId", "type": "integer", "required": false, "description": "在事件列表中新增白名时需要提交事件ID", "example": "10003" }, { "name": "Name", "type": "string", "required": false, "description": "填入的规则名称", "example": "规则1" }, { "name": "Rule", "type": "string", "required": false, "description": "用户填入的正则表达式：\"正则表达式\" 需与 \"提交EventId对应的命令内容\" 相匹配", "example": "rm -rf /tmp/tmp\\\\.ERYbwgd8e9" }, { "name": "Id", "type": "integer", "required": false, "description": "编辑时传的规则id", "example": "1230" } ], "required": [ "CheckField" ] }, { "name": "CheckFileTamperRule", "description": "检验核心文件监控前端新增和编辑时的规则参数。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "填入的规则名称", "example": "规则1" }, { "name": "Id", "type": "integer", "required": false, "description": "编辑时传的规则id", "example": "1230" } ], "required": [] }, { "name": "CheckFirstScanBaseline", "description": "查询基线是否第一次检测", "status": "online", "parameters": [], "required": [] }, { "name": "CheckLogKafkaConnectionState", "description": "检查日志投递kafka连通性", "status": "online", "parameters": [ { "name": "AccessType", "type": "integer", "required": true, "description": "接入方式,1公网域名接入，2支撑环境接入", "example": "1" }, { "name": "AccessAddr", "type": "string", "required": true, "description": "接入地址，域名或ip，带端口", "example": "100.119.167.50:6281" }, { "name": "Username", "type": "string", "required": true, "description": "用户名", "example": "uname" }, { "name": "HasPwd", "type": "integer", "required": true, "description": "0不用密码，1有密码", "example": "1" }, { "name": "Pwd", "type": "string", "required": true, "description": "密码，使用aes加密", "example": "pwdpwd" }, { "name": "KafkaId", "type": "string", "required": true, "description": "kafka实例id", "example": "ckafka-ce80kte5" }, { "name": "InsVersion", "type": "string", "required": true, "description": "kafka版本", "example": "0.10.2.1" } ], "required": [ "AccessType", "AccessAddr", "Username", "HasPwd", "Pwd", "KafkaId", "InsVersion" ] }, { "name": "ClearLocalStorage", "description": "清理本地存储数据", "status": "online", "parameters": [], "required": [] }, { "name": "CreateBanWhiteList", "description": "添加阻断白名单列表", "status": "online", "parameters": [ { "name": "Rules", "type": "object", "required": true, "description": "阻断规则", "example": "{ \"CreateTime\": \"2020-09-22 00:00:00\", \"Id\": \"1\", \"IsGlobal\": true, \"ModifyTime\": \"2020-09-22 00:00:00\", \"Quuids\": [ \"05f0bcab-726c-4ea4-8109-bcd03d5598f7\" ], \"Remark\": \"备注\", \"SrcIp\": \"1.1.1.1\", \"Uuid\": \"05f0bcab-726c-4ea4-8109-bcd03d5598f7\" }", "children": [ { "name": "Id", "type": "string", "required": false, "description": "白名单ID。", "example": "id_10001" }, { "name": "Remark", "type": "string", "required": false, "description": "白名单别名。", "example": "别名" }, { "name": "SrcIp", "type": "string", "required": false, "description": "阻断来源IP。", "example": "1.1.1.1" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改白名单时间。", "example": "2021-01-01 00:00:00" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建白名单时间。", "example": "2021-01-01 00:00:00" }, { "name": "Uuid", "type": "string", "required": false, "description": "白名单所属机器。", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "IsGlobal", "type": "boolean", "required": false, "description": "白名单是否全局", "example": "false" }, { "name": "Quuids", "type": "array", "required": false, "description": "白名单所属机器列表", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9", "item_type": "string" } ] }, { "name": "EventId", "type": "integer", "required": false, "description": "事件ID，事件列表加白名单时传递，白名单添加成功后，会将事件变成已加白状态", "example": "653" } ], "required": [ "Rules" ] }, { "name": "CreateBaselineStrategy", "description": "根据策略信息创建基线策略", "status": "online", "parameters": [ { "name": "StrategyName", "type": "string", "required": true, "description": "策略名称", "example": "定时扫描基线" }, { "name": "ScanCycle", "type": "integer", "required": true, "description": "检测周期, 表示每隔多少天进行检测.示例: 2, 表示每2天进行检测一次.", "example": "2" }, { "name": "ScanAt", "type": "string", "required": true, "description": "定期检测时间，该时间下发扫描. 示例:“22:00”, 表示在22:00下发检测", "example": "02:00" }, { "name": "CategoryIds", "type": "array", "required": true, "description": "该策略下选择的基线id数组. 示例: [1,3,5,7]", "example": "1", "item_type": "integer" }, { "name": "IsGlobal", "type": "integer", "required": true, "description": "扫描范围是否全部服务器, 1:是 0:否, 为1则为全部专业版主机", "example": "1" }, { "name": "MachineType", "type": "string", "required": true, "description": "云主机类型： CVM：虚拟主机 BM：裸金属 ECM：边缘计算主机 LH：轻量应用服务器 Other：混合云机器", "example": "CVM" }, { "name": "RegionCode", "type": "string", "required": true, "description": "主机地域. 示例: \"ap-guangzhou\"", "example": "ap-bj" }, { "name": "Quuids", "type": "array", "required": false, "description": "主机id数组. 示例: [\"quuid1\",\"quuid2\"]", "example": "[\"657f3c29-4bc9-4c48-a8d6-de5bd14ffc67\"]", "item_type": "string" } ], "required": [ "StrategyName", "ScanCycle", "ScanAt", "CategoryIds", "IsGlobal", "MachineType", "RegionCode" ] }, { "name": "CreateBuyBindTask", "description": "新购授权自动绑定任务", "status": "online", "parameters": [ { "name": "DealName", "type": "string", "required": true, "description": "订单号", "example": "dealName" }, { "name": "LicenseType", "type": "integer", "required": true, "description": "可选参数: 1专业版-包年包月 , 2 旗舰版-包年包月", "example": "1" }, { "name": "QuuidList", "type": "array", "required": false, "description": "机器列表", "example": "[quuid1]", "item_type": "string" }, { "name": "IsAll", "type": "boolean", "required": false, "description": "是否全选机器", "example": "false" } ], "required": [ "DealName", "LicenseType" ] }, { "name": "CreateEmergencyVulScan", "description": "创建应急漏洞扫描任务", "status": "online", "parameters": [ { "name": "VulId", "type": "integer", "required": true, "description": "漏洞id", "example": "105006" }, { "name": "Uuids", "type": "array", "required": false, "description": "自选服务器时生效，主机uuid的string数组", "example": "[\"4aae2527-3030-41a5-a9f1-a2a002e848b6\"]", "item_type": "string" }, { "name": "TimeoutPeriod", "type": "integer", "required": false, "description": "扫描超时时长 ，单位秒", "example": "3600" } ], "required": [ "VulId" ] }, { "name": "CreateIncidentBacktracking", "description": "对旗舰版机器单次触发事件调查及告警回溯", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机安全quuid", "example": "c973997a-36ad-4374-860a-fa462281****" } ], "required": [ "Quuid" ] }, { "name": "CreateLicenseOrder", "description": "CreateLicenseOrder 该接口可以创建专业版/旗舰版订单 支持预付费后付费创建 后付费订单直接创建成功 预付费订单仅下单不支付,需要调用计费支付接口进行支付", "status": "online", "parameters": [ { "name": "Tags", "type": "array", "required": false, "description": "标签数组, 空则表示不需要绑定标签", "example": "[{\"TagKey\":\"cwp\", \"TagValue\":\"dev\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "business1" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "businessValue" } ] }, { "name": "LicenseType", "type": "integer", "required": false, "description": "授权类型, 0 专业版-按量计费, 1专业版-包年包月 , 2 旗舰版-包年包月 默认为0", "example": "0" }, { "name": "LicenseNum", "type": "integer", "required": false, "description": "授权数量 , 需要购买的数量. 默认为1", "example": "1" }, { "name": "RegionId", "type": "integer", "required": false, "description": "购买订单地域,这里仅支持 1 广州,9 新加坡. 推荐选择广州. 新加坡地域为白名单用户购买. 默认为1", "example": "1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID . 默认为0", "example": "0" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "购买时间长度,默认1 , 可选值为1,2,3,4,5,6,7,8,9,10,11,12,24,36 该参数仅包年包月生效", "example": "1" }, { "name": "AutoRenewFlag", "type": "boolean", "required": false, "description": "是否自动续费, 默认不自动续费. 该参数仅包年包月生效", "example": "false" }, { "name": "AutoProtectOpenConfig", "type": "string", "required": false, "description": "该字段作废", "example": "\"no config\"" }, { "name": "ModifyConfig", "type": "object", "required": false, "description": "变配参数", "example": "{\"ResourceId\":\"f1fm4-vm4igjxvk_****\", \"NewSubProductCode\":\"PRO_VERSION\", \"InquireNum\":331}", "children": [ { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID", "example": "'cakf-4mrnx******'" }, { "name": "NewSubProductCode", "type": "string", "required": false, "description": "新产品标识,这里支持PRO_VERSION 专业版,FLAGSHIP 旗舰版", "example": "PRO_VERSION" }, { "name": "InquireNum", "type": "integer", "required": false, "description": "扩容/缩容数,变配子产品忽略该参数", "example": "1242" } ] } ], "required": [] }, { "name": "CreateLogExport", "description": "创建日志下载任务", "status": "online", "parameters": [ { "name": "Count", "type": "integer", "required": true, "description": "日志导出数量, 最大值5000万", "example": "10" }, { "name": "StartTime", "type": "integer", "required": true, "description": "日志导出起始时间，毫秒时间戳", "example": "1656640800000" }, { "name": "EndTime", "type": "integer", "required": true, "description": "日志导出结束时间，毫秒时间戳", "example": "1656641100000" }, { "name": "QueryString", "type": "string", "required": false, "description": "日志导出检索语句，不支持[SQL语句]", "example": "\"dev\"" }, { "name": "Sort", "type": "string", "required": false, "description": "日志导出时间排序。desc，asc，默认为desc", "example": "desc" }, { "name": "Format", "type": "string", "required": false, "description": "日志导出数据格式。json，csv，默认为json", "example": "json" } ], "required": [ "Count", "StartTime", "EndTime" ] }, { "name": "CreateMaliciousRequestWhiteList", "description": "添加恶意请求白名单", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "白名单域名", "example": "www.tapd.com" }, { "name": "Mark", "type": "string", "required": false, "description": "备注", "example": "mark" } ], "required": [ "Domain" ] }, { "name": "CreateMalwareWhiteList", "description": "创建木马白名单", "status": "online", "parameters": [ { "name": "Mode", "type": "integer", "required": true, "description": "白名单模式； 0 MD5白名单，1自定义", "example": "1" }, { "name": "QuuidList", "type": "array", "required": false, "description": "quuid 列表", "example": "[\"9942e3f5-756f-459f-89f9-07428d38d2f9\"]", "item_type": "string" }, { "name": "IsGlobal", "type": "integer", "required": false, "description": "是否全部主机； 0否，1是。", "example": "1" }, { "name": "MatchType", "type": "integer", "required": false, "description": "匹配模式 ；0 精确匹配，1模糊匹配（废弃）", "example": "1" }, { "name": "FileName", "type": "array", "required": false, "description": "文件名称(正则)；长度不超过200个", "example": "[\"UmV1YmVuLmRs****\"]", "item_type": "string" }, { "name": "FileDirectory", "type": "array", "required": false, "description": "文件目录(正则)；长度不超过200个,内容base64转义", "example": "[\"QyUzQSUyRkdh****\"]", "item_type": "string" }, { "name": "FileExtension", "type": "array", "required": false, "description": "文件后缀；长度不超过200个,内容base64转义（废弃）", "example": "java", "item_type": "string" }, { "name": "Md5List", "type": "array", "required": false, "description": "MD5列表", "example": "[\"e10adc3949ba59abbe56e057f20f883e\"]", "item_type": "string" }, { "name": "EventId", "type": "integer", "required": false, "description": "木马事件ID", "example": "1" }, { "name": "IsHandleHistoryEvents", "type": "integer", "required": false, "description": "对历史待处理执行加白操作；0是不处理，1是处理", "example": "1" } ], "required": [ "Mode" ] }, { "name": "CreateNetAttackWhiteList", "description": "创建网络攻击白名单", "status": "online", "parameters": [ { "name": "Scope", "type": "integer", "required": true, "description": "是否全部主机； 0否，1是。", "example": "1" }, { "name": "SrcIp", "type": "array", "required": true, "description": "来源IP 单IP:1.1.1.1 IP范围:1.1.1.1-1.1.2.1 IP范围：1.1.1.0/24", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "QuuidList", "type": "array", "required": false, "description": "quuid 列表", "example": "[\"xxx\"]", "item_type": "string" }, { "name": "EventId", "type": "integer", "required": false, "description": "事件id", "example": "1" }, { "name": "DealOldEvents", "type": "integer", "required": false, "description": "是否加白所有符合该规则的告警 ，1:处理,0:不处理", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "接口测试" } ], "required": [ "Scope", "SrcIp" ] }, { "name": "CreateProtectServer", "description": "添加网站防护服务器", "status": "online", "parameters": [ { "name": "ProtectDir", "type": "string", "required": true, "description": "防护目录地址", "example": "/var/www" }, { "name": "ProtectHostConfig", "type": "array", "required": true, "description": "防护机器 信息", "example": "[{\"AutoRecovery\": 0, \"ProtectSwitch\": 0, \"Quuid\": \"04fdfbaf-322b-4f1e-9cb9-aaa149c1****\"}]", "item_type": "object", "children": [ { "name": "Quuid", "type": "string", "required": true, "description": "机器唯一ID", "example": "15c76928-e4e1-4f0d-8a2a-46c7de78****" }, { "name": "ProtectSwitch", "type": "integer", "required": true, "description": "防护开关 0 关闭 1开启", "example": "0" }, { "name": "AutoRecovery", "type": "integer", "required": true, "description": "自动恢复开关 0 关闭 1开启", "example": "0" } ] } ], "required": [ "ProtectDir", "ProtectHostConfig" ] }, { "name": "CreateRansomDefenseStrategy", "description": "创建或修改防勒索策略", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "策略名称", "example": "ada_api****" }, { "name": "Hour", "type": "string", "required": true, "description": "定时快照执行时间（0-23）：01:00;23:00", "example": "00:00;11:00;15:00" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID，填ID时修改策略，否则新增策略", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "策略备注", "example": "subtitle" }, { "name": "Status", "type": "integer", "required": false, "description": "是否开启：0关，1开", "example": "1" }, { "name": "IsAll", "type": "integer", "required": false, "description": "是否全部机器生效：0否，1是", "example": "1" }, { "name": "IncludeDir", "type": "string", "required": false, "description": "包含目录，;分隔", "example": "/root;/data" }, { "name": "ExcludeDir", "type": "string", "required": false, "description": "排除目录，;分隔", "example": "/tmp;/var/log" }, { "name": "BackupType", "type": "integer", "required": false, "description": "备份模式： 0按周，1按天，2不备份", "example": "1" }, { "name": "Weekday", "type": "string", "required": false, "description": "定时任务执行星期天数（1-7）：1;2;7", "example": "1;2;3" }, { "name": "SaveDay", "type": "integer", "required": false, "description": "保留天数：0永久", "example": "1" }, { "name": "Machines", "type": "array", "required": false, "description": "绑定主机列表", "example": "[{\"DiskInfo\": \"\", \"Uuid\": \"15c76928-e4e1-4f0d-8a2a-46c7de78****\"}]", "item_type": "object", "children": [ { "name": "Uuid", "type": "string", "required": true, "description": "主机uuid", "example": "acdd5474-6360-4fd4-bfc7-843162cb8116" }, { "name": "DiskInfo", "type": "string", "required": false, "description": "指定硬盘列表，为空时表示所有硬盘：disk_id1|disk_name1;disk_id2|disk_name2", "example": "disk_id1|disk_name1;disk_id2|disk_name2" } ] } ], "required": [ "Name", "Hour" ] }, { "name": "CreateScanMalwareSetting", "description": "该接口可以对入侵检测-文件查杀扫描检测", "status": "online", "parameters": [ { "name": "ScanPattern", "type": "integer", "required": true, "description": "扫描模式 0 全盘扫描, 1 快速扫描", "example": "1" }, { "name": "HostType", "type": "integer", "required": true, "description": "服务器分类：1:专业版服务器；2:自选服务器", "example": "1" }, { "name": "QuuidList", "type": "array", "required": false, "description": "自选服务器时生效，主机quuid的string数组", "example": "[\"a15a2cac-0bea-478d-a5d0-f54be8******\"\"]", "item_type": "string" }, { "name": "TimeoutPeriod", "type": "integer", "required": false, "description": "超时时间单位 秒 默认3600 秒", "example": "1" }, { "name": "EngineType", "type": "integer", "required": false, "description": "1标准模式（只报严重、高危）、2增强模式（报严重、高危、中危）、3严格模式（报严重、高、中、低、提示）", "example": "2" }, { "name": "EnableMemShellScan", "type": "integer", "required": false, "description": "是否开启恶意进程查杀[0:未开启,1:开启]", "example": "1" } ], "required": [ "ScanPattern", "HostType" ] }, { "name": "CreateSearchLog", "description": "添加历史搜索记录", "status": "online", "parameters": [ { "name": "SearchContent", "type": "string", "required": true, "description": "搜索内容", "example": "接口测试" } ], "required": [ "SearchContent" ] }, { "name": "CreateSearchTemplate", "description": "添加检索模板", "status": "online", "parameters": [ { "name": "SearchTemplate", "type": "object", "required": true, "description": "搜索模板", "example": "{\"Condition\": \"count \\u7b49\\u4e8e\\u6570\\u503c****\", \"DisplayData\": \"[{\\\"id\\\":369266774838,\\\"patternsField\\\":\\\"count\\\",\\\"selectedtype\\\":\\\"is\\\",\\\"selectedOptionsMap\\\":{\\\"is\\\":\\\"\\u7b49\\u4e8e\\u6570\\u503c\\\",\\\"not\\\":\\\"\\u4e0d\\u7b49\\u4e8e\\u6570\\u503c\\\",\\\"is_one_of\\\":\\\"\\u7b49\\u4e8e\\u4ee5\\u4e0b\\u4efb\\u610f\\u6570\\u503c\\\",\\\"not_one_of\\\":\\\"\\u4e0d\\u7b49\\u4e8e\\u4ee5\\u4e0b\\u4efb\\u610f\\u6570\\u503c\\\",\\\"is_range\\\":\\\"\\u5c5e\\u4e8e\\u6570\\u503c\\u533a\\u95f4\\\",\\\"not_range\\\":\\\"\\u4e0d\\u5c5e\\u4e8e\\u6570\\u503c\\u533a\\u95f4\\\"},\\\"selectedTypeList\\\":[\\\"is\\\",\\\"not\\\",\\\"is_one_of\\\",\\\"not_one_of\\\",\\\"is_range\\\",\\\"not_range\\\"],\\\"third_cat\\\":\\\"input\\\",\\\"value\\\":\\\"1****\", \"Flag\": \"simple\", \"LogType\": \"userlog-vul|userlog-hostlogin|userlog-baseline|userlog-asset_port|userlog-network_attack|userlog-privilege_escalation|userlog-reverse_shell|userlog-bruteforce|userlog-asset_component|userlog-asset_process|userlog-risk_dns|userlog-asset_account|userlog-malware|userlog-risk_****\", \"Name\": \"nOqBFVNMgONSxKmSGYZpekKdZJKFMtuGyxMcJeoMsGEIScvKeDcpSFuzHkTlEjqkGVWameNFwntVRRkEbdoDG@U****\", \"Query\": \"{\\\"index\\\":[\\\"userlog-vul\\\",\\\"userlog-hostlogin\\\",\\\"userlog-baseline\\\",\\\"userlog-asset_port\\\",\\\"userlog-network_attack\\\",\\\"userlog-privilege_escalation\\\",\\\"userlog-reverse_shell\\\",\\\"userlog-bruteforce\\\",\\\"userlog-asset_component\\\",\\\"userlog-asset_process\\\",\\\"userlog-risk_dns\\\",\\\"userlog-asset_account\\\",\\\"userlog-malware\\\",\\\"userlog-risk_bash\\\"],\\\"body\\\":{\\\"query\\\":{\\\"bool\\\":{\\\"filter\\\":{\\\"bool\\\":{\\\"filter\\\":{\\\"range\\\":{\\\"create_time\\\":{\\\"gte\\\":1636560000000,\\\"lte\\\":1636646399999}}},\\\"must\\\":[],\\\"must_not\\\":[],\\\"should\\\":[{\\\"term\\\":{\\\"count\\\":\\\"12\\\"}}]}}}},\\\"aggs\\\":{\\\"count_stats\\\":{\\\"date_histogram\\\":{\\\"field\\\":\\\"create_time\\\",\\\"interval\\\":\\\"30m\\\",\\\"time_zone\\\":\\\"Asia/Shanghai\\\",\\\"min_doc_count\\\":1}}},\\\"highlight\\\":{\\\"fields\\\":{\\\"*\\\":{}}}},\\\"sort\\\":[{\\\"create_time\\\":\\\"desc****\", \"TimeRange\": \"2021-11-11 00:00:00 \\u81f3 2021-11-11 23:5****\"}", "children": [ { "name": "Name", "type": "string", "required": true, "description": "检索名称", "example": "nOqBFVNMgONSxKmSGYZpekKdZJKFMtuGyxMcJeoMsGEIScvKeDcpSFuzHkTlEjqkGVWameNFwntVRRkEbdoDG@U****" }, { "name": "LogType", "type": "string", "required": true, "description": "检索索引类型", "example": "userlog-vul|userlog-hostlogin|userlog-baseline|userlog-asset_port|userlog-network_attack|userlog-privilege_escalation|userlog-reverse_shell|userlog-bruteforce|userlog-asset_component|userlog-asset_process|userlog-risk_dns|userlog-asset_account|userlog-malware|userlog-risk_****" }, { "name": "Condition", "type": "string", "required": true, "description": "检索语句", "example": "count 等于数值****" }, { "name": "TimeRange", "type": "string", "required": true, "description": "时间范围", "example": "2021-11-11 00:00:00 至 2021-11-11 23:5****" }, { "name": "Query", "type": "string", "required": true, "description": "转换的检索语句内容", "example": "{\"index\":[\"userlog-vul\",\"userlog-hostlogin\",\"userlog-baseline\",\"userlog-asset_port\",\"userlog-network_attack\",\"userlog-privilege_escalation\",\"userlog-reverse_shell\",\"userlog-bruteforce\",\"userlog-asset_component\",\"userlog-asset_process\",\"userlog-risk_dns\",\"userlog-asset_account\",\"userlog-malware\",\"userlog-risk_bash\"],\"body\":{\"query\":{\"bool\":{\"filter\":{\"bool\":{\"filter\":{\"range\":{\"create_time\":{\"gte\":1636560000000,\"lte\":1636646399999}}},\"must\":[],\"must_not\":[],\"should\":[{\"term\":{\"count\":\"12\"}}]}}}},\"aggs\":{\"count_stats\":{\"date_histogram\":{\"field\":\"create_time\",\"interval\":\"30m\",\"time_zone\":\"Asia/Shanghai\",\"min_doc_count\":1}}},\"highlight\":{\"fields\":{\"*\":{}}}},\"sort\":[{\"create_time\":\"desc****" }, { "name": "Flag", "type": "string", "required": true, "description": "检索方式。输入框检索：standard,过滤，检索：simple", "example": "simple" }, { "name": "DisplayData", "type": "string", "required": true, "description": "展示数据", "example": "[{\"id\":369266774838,\"patternsField\":\"count\",\"selectedtype\":\"is\",\"selectedOptionsMap\":{\"is\":\"等于数值\",\"not\":\"不等于数值\",\"is_one_of\":\"等于以下任意数值\",\"not_one_of\":\"不等于以下任意数值\",\"is_range\":\"属于数值区间\",\"not_range\":\"不属于数值区间\"},\"selectedTypeList\":[\"is\",\"not\",\"is_one_of\",\"not_one_of\",\"is_range\",\"not_range\"],\"third_cat\":\"input\",\"value\":\"1****" }, { "name": "Id", "type": "integer", "required": false, "description": "规则ID", "example": "198" } ] } ], "required": [ "SearchTemplate" ] }, { "name": "CreateVulFix", "description": "提交漏洞修护", "status": "online", "parameters": [ { "name": "CreateVulFixTaskQuuids", "type": "array", "required": true, "description": "漏洞对应要修复的主机列表", "example": "[{\"FixMethod\": 0, \"Quuids\": [\"b93a35d2-f398-4cd1-b12d-7e129f66****\"], \"VulId\": 1407}]", "item_type": "object", "children": [ { "name": "Quuids", "type": "array", "required": true, "description": "需要修复漏洞的主机，所有主机必须有VulId的这个漏洞且是待修复状态。", "example": "[\"e5b4724c-49af-46ab-bd84-cdbae897e7e0\"]", "item_type": "string" }, { "name": "VulId", "type": "integer", "required": false, "description": "漏洞id", "example": "1089" }, { "name": "FixMethod", "type": "integer", "required": false, "description": "修复方式 0组件更新或者安装补丁,1禁用服务", "example": "0" }, { "name": "KbId", "type": "integer", "required": false, "description": "kb id", "example": "1" } ] }, { "name": "SaveDays", "type": "integer", "required": true, "description": "快照保存天数， 0 天表示不创建快照。24小时没有快照的主机必须要创建快照才能修复", "example": "7" }, { "name": "SnapshotName", "type": "string", "required": false, "description": "快照名称", "example": "快照1" } ], "required": [ "CreateVulFixTaskQuuids", "SaveDays" ] }, { "name": "CreateWhiteListOrder", "description": "该接口可以创建白名单订单", "status": "online", "parameters": [ { "name": "LicenseType", "type": "integer", "required": true, "description": "授权类型", "example": "1" }, { "name": "LicenseNum", "type": "integer", "required": true, "description": "授权数量,最小为1 最大99999", "example": "1" }, { "name": "Deadline", "type": "integer", "required": true, "description": "到期时间,最小为1", "example": "1" }, { "name": "RuleName", "type": "string", "required": true, "description": "规则名称,大资产中心:asset_center", "example": "cwp" }, { "name": "SourceType", "type": "integer", "required": true, "description": "订单类型, 1 试用 2 赠送 3 体验 4 SSL-证书赠送 5 cvm赠送", "example": "1" }, { "name": "RegionId", "type": "integer", "required": false, "description": "地域, 1 广州 9新加坡, 默认为 1. 非必要情况不要选9", "example": "1" }, { "name": "ExtraParam", "type": "string", "required": false, "description": "额外参数,json字符串,包含ResourceId 资源ID,LicenseType 授权类型", "example": "{\"ResourceId\":\"resource-01\"}" } ], "required": [ "LicenseType", "LicenseNum", "Deadline", "RuleName", "SourceType" ] }, { "name": "DeleteAllJavaMemShells", "description": "删除全部java内存马事件", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "服务器quuid", "example": "5a540076-d38a-4078-aa98-e7c86371d322" } ], "required": [] }, { "name": "DeleteBanWhiteList", "description": "删除阻断白名单列表", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "要删除的白名单ID列表 (最大100条)", "example": "1", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteBaselinePolicy", "description": "删除基线策略配置", "status": "online", "parameters": [ { "name": "PolicyIds", "type": "array", "required": true, "description": "策略Id", "example": "[309052]", "item_type": "integer" } ], "required": [ "PolicyIds" ] }, { "name": "DeleteBaselineRule", "description": "删除基线规则", "status": "online", "parameters": [ { "name": "RuleId", "type": "integer", "required": true, "description": "规则Id", "example": "1" } ], "required": [ "RuleId" ] }, { "name": "DeleteBaselineRuleIgnore", "description": "删除基线忽略规则", "status": "online", "parameters": [ { "name": "RuleIds", "type": "array", "required": true, "description": "规则Id", "example": "[44106]", "item_type": "integer" } ], "required": [ "RuleIds" ] }, { "name": "DeleteBaselineStrategy", "description": "根据基线策略id删除策略", "status": "online", "parameters": [ { "name": "StrategyId", "type": "integer", "required": true, "description": "基线策略id", "example": "1" } ], "required": [ "StrategyId" ] }, { "name": "DeleteBaselineWeakPassword", "description": "删除基线弱口令", "status": "online", "parameters": [ { "name": "PasswordIds", "type": "array", "required": true, "description": "弱口令Id", "example": "[1002]", "item_type": "integer" } ], "required": [ "PasswordIds" ] }, { "name": "DeleteBashEvents", "description": "根据Ids删除高危命令事件", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "ID数组，最大1000条。", "example": "[1002]", "item_type": "integer" }, { "name": "All", "type": "boolean", "required": false, "description": "是否删除全部", "example": "true" } ], "required": [] }, { "name": "DeleteBashPolicies", "description": "删除高危命令策略", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "ID数组，最大100条。", "example": "1", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteBashRules", "description": "删除高危命令规则", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "ID数组，最大100条。", "example": "[1,23,100]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteBruteAttacks", "description": "本接口 (DeleteBruteAttacks) 用于删除暴力破解记录。", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "暴力破解事件Id数组。(最大 100条)", "example": "[1,2]", "item_type": "integer" }, { "name": "All", "type": "boolean", "required": false, "description": "是否删除全部", "example": "true" } ], "required": [] }, { "name": "DeleteLicenseRecord", "description": "对授权管理-订单列表内已过期的订单进行删除.(删除后的订单不在统计范畴内)", "status": "online", "parameters": [ { "name": "LicenseId", "type": "integer", "required": true, "description": "授权ID ,可以用授权订单列表获取.", "example": "1" }, { "name": "LicenseType", "type": "integer", "required": true, "description": "授权类型", "example": "0" }, { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID", "example": "cwplic-9090****" } ], "required": [ "LicenseId", "LicenseType", "ResourceId" ] }, { "name": "DeleteLicenseRecordAll", "description": "删除授权全部记录", "status": "online", "parameters": [], "required": [] }, { "name": "DeleteLogExport", "description": "删除日志下载任务", "status": "online", "parameters": [ { "name": "ExportId", "type": "string", "required": true, "description": "日志导出ID", "example": "export-9842ff7e-0655-42b8-ab19-07bdd4f1****" } ], "required": [ "ExportId" ] }, { "name": "DeleteLoginWhiteList", "description": "本接口用于删除异地登录白名单规则。", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "白名单ID (最大 100 条)", "example": "[36040272]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteMachine", "description": "本接口（DeleteMachine）用于卸载主机安全客户端。", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": true, "description": "主机安全客户端Uuid。", "example": "97d7cec6-0f2a-b636-e340-43f212dbb33c" } ], "required": [ "Uuid" ] }, { "name": "DeleteMachineClearHistory", "description": "删除机器清理记录", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "需要删除的记录id值,最大长度100个", "example": "[1,2]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteMachineTag", "description": "删除服务器关联的标签", "status": "online", "parameters": [ { "name": "Rid", "type": "integer", "required": true, "description": "关联的标签ID", "example": "1" } ], "required": [ "Rid" ] }, { "name": "DeleteMaliciousRequestWhiteList", "description": "删除恶意请求白名单", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "白名单id (最大100条)", "example": "[1]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteMaliciousRequests", "description": "本接口 (DeleteMaliciousRequests) 用于删除恶意请求记录。", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "恶意请求记录ID数组，(最大100条)", "example": "[1002]", "item_type": "integer" }, { "name": "All", "type": "boolean", "required": false, "description": "是否删除全部", "example": "true" } ], "required": [] }, { "name": "DeleteMalwareScanTask", "description": "入侵管理-终止扫描任务", "status": "online", "parameters": [], "required": [] }, { "name": "DeleteMalwareWhiteList", "description": "删除木马白名单", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "ID数组，最大100条。", "example": "1", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteMalwares", "description": "本接口 (DeleteMalwares) 用于删除木马记录。", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "木马记录ID数组 (最大100条)", "example": "[1]", "item_type": "integer" }, { "name": "All", "type": "boolean", "required": false, "description": "是否删除全部", "example": "true" } ], "required": [] }, { "name": "DeleteNetAttackWhiteList", "description": "删除网络攻击白名单", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "ID数组，最大100条。", "example": "[1]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteNonlocalLoginPlaces", "description": "本接口 (DeleteNonlocalLoginPlaces) 用于删除异地登录记录。", "status": "online", "parameters": [ { "name": "DelType", "type": "string", "required": false, "description": "删除异地登录事件的方式，可选值：\"Ids\"、\"Ip\"、\"All\"，默认为Ids", "example": "Ip" }, { "name": "Ids", "type": "array", "required": false, "description": "异地登录事件ID数组。DelType为Ids或DelType未填时此项必填", "example": "[202417010656750]", "item_type": "integer" }, { "name": "Ip", "type": "array", "required": false, "description": "异地登录事件的Ip。DelType为Ip时必填", "example": "1.1.1.1", "item_type": "string" }, { "name": "Uuid", "type": "string", "required": false, "description": "主机Uuid", "example": "acdd5474-6360-4fd4-bfc7-843162cb8116" } ], "required": [] }, { "name": "DeletePrivilegeEvents", "description": "根据Ids删除本地提权", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "ID数组. (最大100条)", "example": "[1,2,3]", "item_type": "integer" }, { "name": "All", "type": "boolean", "required": false, "description": "是否删除全部", "example": "true" } ], "required": [] }, { "name": "DeletePrivilegeRules", "description": "删除本地提权规则", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "ID数组，最大100条。", "example": "[1,2]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteProtectDir", "description": "删除防护网站", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "删除的目录ID 最大100条", "example": "[\"/root/\",\"/tmp\"]", "item_type": "string" } ], "required": [ "Ids" ] }, { "name": "DeleteRaspRules", "description": "删除漏洞防御白名单", "status": "online", "parameters": [ { "name": "IDs", "type": "array", "required": true, "description": "待删除的规则ID数组 (最大100条)", "example": "[31]", "item_type": "integer" } ], "required": [ "IDs" ] }, { "name": "DeleteReverseShellEvents", "description": "根据Ids删除反弹Shell事件", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "ID数组. (最大100条)", "example": "[232196162]", "item_type": "integer" }, { "name": "All", "type": "boolean", "required": false, "description": "是否删除全部", "example": "true" } ], "required": [] }, { "name": "DeleteReverseShellRules", "description": "删除反弹Shell规则", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "ID数组. (最大100条)", "example": "1", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteRiskDnsEvent", "description": "删除恶意请求事件", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "恶意请求记录ID数组，(最大100条), 为空时全部删除", "example": "[1002]", "item_type": "integer" } ], "required": [] }, { "name": "DeleteRiskDnsPolicy", "description": "删除恶意请求策略", "status": "online", "parameters": [ { "name": "PolicyIds", "type": "array", "required": false, "description": "策略ID", "example": "[5018412]", "item_type": "integer" } ], "required": [] }, { "name": "DeleteScanTask", "description": "DeleteScanTask 该接口可以对指定类型的扫描任务进行停止扫描;", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务Id", "example": "1" }, { "name": "ModuleType", "type": "string", "required": true, "description": "模块类型 当前提供 Malware 木马 , Vul 漏洞 , Baseline 基线", "example": "Vul" }, { "name": "QuuidList", "type": "array", "required": false, "description": "自选服务器时生效，主机quuid的string数组", "example": "[\"17d8ad3a-afbb-44a8-8b9e-99a92160f367\"]", "item_type": "string" } ], "required": [ "TaskId", "ModuleType" ] }, { "name": "DeleteSearchTemplate", "description": "删除检索模板", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "模板ID", "example": "1" } ], "required": [ "Id" ] }, { "name": "DeleteTags", "description": "删除标签", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "标签ID (最大100 条)", "example": "[16500]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteWebHookPolicy", "description": "删除告警策略", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "id列表", "example": "[465]", "item_type": "integer" } ], "required": [] }, { "name": "DeleteWebHookReceiver", "description": "删除告警接收人", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "id数组", "example": "[670]", "item_type": "integer" } ], "required": [] }, { "name": "DeleteWebHookRule", "description": "删除企微机器人规则", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "规则Id列表", "example": "[10001,10002]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "DeleteWebPageEventLog", "description": "网站防篡改-删除事件记录", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeABTestConfig", "description": "获取用户当前灰度配置", "status": "online", "parameters": [ { "name": "ProjectName", "type": "string", "required": false, "description": "灰度项目名称", "example": "tename" } ], "required": [] }, { "name": "DescribeAESKey", "description": "获取配置的aeskey和aesiv", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAccountStatistics", "description": "本接口 (DescribeAccountStatistics) 用于获取账号统计列表数据。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Username - String - 是否必填：否 - 帐号用户名", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeAgentInstallCommand", "description": "获取agent安装命令", "status": "online", "parameters": [ { "name": "IsCloud", "type": "boolean", "required": true, "description": "是否腾讯云", "example": "true" }, { "name": "NetType", "type": "string", "required": true, "description": "网络类型：basic-基础网络，private-VPC, public-公网，direct-专线", "example": "private" }, { "name": "RegionCode", "type": "string", "required": false, "description": "地域标示, NetType=direct时必填", "example": "gz" }, { "name": "VpcId", "type": "string", "required": false, "description": "VpcId, NetType=direct时必填", "example": "vpc-1234" }, { "name": "TagIds", "type": "array", "required": false, "description": "标签ID列表，IsCloud=false时才会生效", "example": "[1,2,3]", "item_type": "integer" }, { "name": "ExpireDate", "type": "string", "required": false, "description": "命令有效期，非腾讯云时必填（已废弃，命令永久生效）", "example": "2021-06-17" }, { "name": "Vip", "type": "string", "required": false, "description": "代理方式接入的vip", "example": "111.93.22.12" } ], "required": [ "IsCloud", "NetType" ] }, { "name": "DescribeAgentInstallationToken", "description": "混合云安装agent token获取", "status": "online", "parameters": [ { "name": "ExpireDate", "type": "string", "required": true, "description": "token 过期时间", "example": "2021-03-09" } ], "required": [ "ExpireDate" ] }, { "name": "DescribeAlarmIncidentNodes", "description": "获取告警点所在事件的所有节点信息", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": true, "description": "机器uuid", "example": "1ad273c9172ddcd6f0ae3cde317149f9" }, { "name": "AlarmVid", "type": "string", "required": true, "description": "告警vid", "example": "1ad273c9172ddcd6f0ae3cde317149f9" }, { "name": "AlarmTime", "type": "integer", "required": true, "description": "告警时间", "example": "1664413164" }, { "name": "TableId", "type": "integer", "required": false, "description": "告警来源表ID", "example": "115920" } ], "required": [ "Uuid", "AlarmVid", "AlarmTime" ] }, { "name": "DescribeAlarmVertexId", "description": "查询告警点id列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": true, "description": "机器uuid", "example": "e8f91530-02c7-3e98-d84d-26df60d981ef" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间戳", "example": "1679027368" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间戳", "example": "1679027368" } ], "required": [ "Uuid", "StartTime", "EndTime" ] }, { "name": "DescribeAssetAppCount", "description": "获取所有软件应用数量", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "搜索条件：搜索返回所有软件名包含Name的进程列表", "example": "jar" } ], "required": [] }, { "name": "DescribeAssetAppList", "description": "查询应用列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 AppName- string - 是否必填：否 - 应用名搜索 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Type - int - 是否必填：否 - 类型 : 仅linux 0: 全部 1: 运维 2 : 数据库 3 : 安全 4 : 可疑应用 5 : 系统架构 6 : 系统应用 7 : WEB服务 99:其他 OsType - uint64 - 是否必填：否 - windows/linux Os -String 是否必填: 否 - 操作系统( Descri...", "example": "1", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime|ProcessCount]", "example": "1" } ], "required": [] }, { "name": "DescribeAssetAppProcessList", "description": "获取软件关联进程列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Uuid", "type": "string", "required": true, "description": "主机Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Name", "type": "string", "required": true, "description": "App名", "example": "mysql" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" } ], "required": [ "Quuid", "Uuid", "Name" ] }, { "name": "DescribeAssetCoreModuleInfo", "description": "获取内核模块详情", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "服务器Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Uuid", "type": "string", "required": true, "description": "服务器Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Id", "type": "string", "required": true, "description": "内核模块ID", "example": "1001" } ], "required": [ "Quuid", "Uuid", "Id" ] }, { "name": "DescribeAssetCoreModuleList", "description": "查询资产管理内核模块列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Name- string - 是否必填：否 - 包名 User- string - 是否必填：否 - 用户", "example": "[{\"ExactMatch\": false, \"Name\": \"IpOrA****\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序依据[Size|FirstTime|ProcessCount|ModuleCount]", "example": "Size" } ], "required": [] }, { "name": "DescribeAssetDatabaseCount", "description": "获取所有数据库数量", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "搜索条件：返回名称包含Name的数据库列表", "example": "mysql" } ], "required": [] }, { "name": "DescribeAssetDatabaseInfo", "description": "获取资产管理数据库详情", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "服务器Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Uuid", "type": "string", "required": true, "description": "服务器Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Id", "type": "string", "required": true, "description": "数据库ID", "example": "1" } ], "required": [ "Quuid", "Uuid", "Id" ] }, { "name": "DescribeAssetDatabaseList", "description": "查询资产管理数据库列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 MachineName- String - 是否必填：否 - 主机别名筛选 IP- String - 是否必填：否 - 主机ip筛选 InstanceID- String - 是否必填：否 - 主机实例ID筛选 User- string - 是否必填：否 - 运行用户 Port - Int - 是否必填：否 - 端口 Name - Int - 是否必填：否 - 数据库名称 0:全部 1:MySQL 2:Redis 3:Oracle 4:MongoDB 5:MemCache 6:PostgreSQL 7:HBase 8:DB2 9:Sybase 10:TiDB Proto - String - 是否必填：否 - 协议：1:TCP, 2:UDP, 3:未知 O...", "example": "[{\"ExactMatch\": false, \"Name\": \"IsNew\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetDiskList", "description": "获取主机磁盘分区列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "ed12c76b-2f65-4d44-a001-8f60cce9****" }, { "name": "Uuid", "type": "string", "required": true, "description": "主机Uuid", "example": "ed12c76b-2f65-4d44-a001-8f60cce9****" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" } ], "required": [ "Quuid", "Uuid" ] }, { "name": "DescribeAssetEnvList", "description": "查询资产管理环境变量列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "1c26308c-5493-4eaf-a817-112ec25f499e" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "1c26308c-5493-4eaf-a817-112ec25f499e" }, { "name": "Type", "type": "integer", "required": false, "description": "该字段已废弃，由Filters代替", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 Name- string - 是否必填：否 - 环境变量名 Type- int - 是否必填：否 - 类型：0用户变量，1系统变量", "example": "[{\"Name\":\"Name\",\"Values\":[\"root\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetHostTotalCount", "description": "获取主机所有资源数量", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": true, "description": "主机Uuid", "example": "ed12c76b-2f65-4d44-a001-8f60cce9****" }, { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "ed12c76b-2f65-4d44-a001-8f60cce9****" } ], "required": [ "Uuid", "Quuid" ] }, { "name": "DescribeAssetInfo", "description": "获取资产数量： 主机数、账号数、端口数、进程数、软件数、数据库数、Web应用数、Web框架数、Web服务数、Web站点数", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAssetInitServiceList", "description": "查询资产管理启动服务列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "1" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Name- string - 是否必填：否 - 包名 User- string - 是否必填：否 - 用户 IsAutoRun - string - 是否必填：否 - 是否开机自启动：0否，1是 Status- string - 是否必填：否 - 默认启用状态：0未启用， 1启用 仅linux Type- string - 是否必填：否 - 类型：类型 仅windows： 1:编码器...", "example": "1", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "11" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetJarInfo", "description": "获取Jar包详情", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "服务器Quuid", "example": "acdd5474-6360-4fd4-bfc7-843162cb8116" }, { "name": "Uuid", "type": "string", "required": true, "description": "服务器Uuid", "example": "acdd5474-6360-4fd4-bfc7-843162cb8116" }, { "name": "Id", "type": "string", "required": true, "description": "Jar包ID", "example": "1" } ], "required": [ "Quuid", "Uuid", "Id" ] }, { "name": "DescribeAssetJarList", "description": "查询Jar包列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Name- string - 是否必填：否 - 包名 Type- uint - 是否必填：否 - 类型 1: 应用程序 2 : 系统类库 3 : Web服务自带库 4 : 其他依赖包 Status- string - 是否必填：否 - 是否可执行：0否，1是", "example": "1", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetLoadInfo", "description": "获取系统负载、内存使用率、硬盘使用率情况", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAssetMachineDetail", "description": "获取资产管理主机资源详细信息", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "服务器Quuid", "example": "de92dec8-d312-49c5-b3e4-505584ee****" }, { "name": "Uuid", "type": "string", "required": true, "description": "服务器Uuid", "example": "de92dec8-d312-49c5-b3e4-505584ee****" } ], "required": [ "Quuid", "Uuid" ] }, { "name": "DescribeAssetMachineList", "description": "获取资产指纹页面的资源监控列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 MachineName 主机名称 InstanceID 实例ID IP 内网IP或公网IP OsType - String - 是否必填：否 - windows或linux CpuLoad - Int - 是否必填：否 - 0: 未知 1: 低负载 2: 中负载 3: 高负载 DiskLoad - Int - 是否必填：否 - 0: 0%或未知 1: 0%～20% 2: 20%～50% 3: 50%～80% 4: 80%～100% MemLoad - Int - 是否必填：否 - 0: 0%或未知 1: 0%～20% 2: 20%～50% 3: 50%～80% 4: 80%～100% Quuid：主机Quuid Os -String 是否必填: 否 - 操作系统( D...", "example": "[{\"MachineName\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "可选排序[FirstTime|PartitionCount]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetMachineTagTop", "description": "获取主机标签Top5", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAssetPlanTaskList", "description": "查询资产管理计划任务列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID User- string - 是否必填：否 - 用户 Status- int - 是否必填：否 - 默认启用状态：0未启用， 1启用", "example": "[{\"MachineName\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetPortCount", "description": "获取所有端口数量", "status": "online", "parameters": [ { "name": "Port", "type": "integer", "required": false, "description": "搜索条件：返回指定端口号数据", "example": "22" } ], "required": [] }, { "name": "DescribeAssetPortInfoList", "description": "获取资产管理端口列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "37b6df34-68f1-4ab8-a3d8-7b89de604c82" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Port - uint64 - 是否必填：否 - 端口 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID ProcessName - String - 是否必填：否 - 监听进程 Pid - uint64 - 是否必填：否 - PID User - String - 是否必填：否 - 运行用户 Group - String - 是否必填：否 - 所属用户组 Ppid - uint64 - 是否必填：否 - PPID Proto - string - 是否必填：否 - tcp/ud...", "example": "[{\"Name\": \"Proto\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime|StartTime]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetProcessCount", "description": "获取所有进程数量", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "搜索条件：搜索返回所有进程名包含Name的进程列表", "example": "1" } ], "required": [] }, { "name": "DescribeAssetProcessInfoList", "description": "获取资产管理进程列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "392f05bd-bf86-4911-8cf9-b8c2ac0f62ab" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Name - String - 是否必填：否 - 进程名 User - String - 是否必填：否 - 进程用户 Group - String - 是否必填：否 - 进程用户组 Pid - uint64 - 是否必填：否 - 进程ID Ppid - uint64 - 是否必填：否 - 父进程ID OsType - uint64 - 是否必填：否 - windows/linux Status - string - 是否必填：...", "example": "[{\"MachineName\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "12" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "100" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime|StartTime]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetRecentMachineInfo", "description": "获取主机最近趋势情况", "status": "online", "parameters": [ { "name": "BeginDate", "type": "string", "required": true, "description": "开始时间，如：2020-09-22", "example": "2020-10-10" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束时间，如：2020-09-22", "example": "2020-10-10" } ], "required": [ "BeginDate", "EndDate" ] }, { "name": "DescribeAssetSystemPackageList", "description": "获取资产管理系统安装包列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "主机Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Quuid", "type": "string", "required": false, "description": "主机Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name - String - 是否必填：否 - 包 名 StartTime - String - 是否必填：否 - 安装开始时间 EndTime - String - 是否必填：否 - 安装开始时间 Type - int - 是否必填：否 - 安装包类型： 1:rmp 2:dpkg 3:java 4:system", "example": "1", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "11" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc-升序 或 desc-降序。默认：desc-降序", "example": "1" }, { "name": "By", "type": "string", "required": false, "description": "排序方式可选：[FistTime|InstallTime:安装时间]", "example": "1" } ], "required": [] }, { "name": "DescribeAssetTotalCount", "description": "获取所有资源数量：主机、账号、端口、进程、软件、数据库、Web应用、Web框架、Web服务、Web站点", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAssetTypeTop", "description": "获取各种类型资源Top5", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAssetTypes", "description": "获取资产指纹类型列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAssetUserCount", "description": "获取所有账号数量", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "搜索条件：搜索名称中包含name的所有账号列表", "example": "staff" } ], "required": [] }, { "name": "DescribeAssetUserInfo", "description": "获取主机账号详情", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "云服务器UUID", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Uuid", "type": "string", "required": true, "description": "主机安全UUID", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Name", "type": "string", "required": true, "description": "账户名", "example": "test_user" } ], "required": [ "Quuid", "Uuid", "Name" ] }, { "name": "DescribeAssetUserKeyList", "description": "获取主机账号Key列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "f63e2bbb-1070-4178-9934-9639ef33****" }, { "name": "Uuid", "type": "string", "required": true, "description": "主机Uuid", "example": "f63e2bbb-1070-4178-9934-9639ef33****" }, { "name": "Name", "type": "string", "required": true, "description": "账号名", "example": "halt" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" } ], "required": [ "Quuid", "Uuid", "Name" ] }, { "name": "DescribeAssetUserList", "description": "获取账号列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Name - String - 是否必填：否 - 账户名（模糊匹配） NameStrict - String - 是否必填：否 - 账户名（严格匹配） Uid - uint64 - 是否必填：否 - Uid Guid - uint64 - 是否必填：否 - Guid LoginTimeStart - String - 是否必填：否 - 开始时间，如：2021-01-11 LoginTimeEnd - String - 是否必\ufffd...", "example": "1", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|LoginTime|PasswordChangeTime|PasswordDuaTime|PasswordLockDays]", "example": "LoginTime" } ], "required": [] }, { "name": "DescribeAssetWebAppCount", "description": "获取所有Web应用数量", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "搜索条件：返回名称包含Name的所有Web应用列表", "example": "php" } ], "required": [] }, { "name": "DescribeAssetWebAppList", "description": "获取资产管理Web应用列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Name - String - 是否必填：否 - 应用名 Domain - String - 是否必填：否 - 站点域名 Type - int - 是否必填：否 - 服务类型： 0：全部 1:Tomcat 2:Apache 3:Nginx 4:WebLogic 5:Websphere 6:JBoss 7:Jetty 8:IHS 9:Tengine OsType - String - 是否必填：否 - windows/linux Os -String 是否必填: 否 - 操作...", "example": "[{\"ExactMatch\": false, \"Name\": \"Domain\", \"Values\": [\"local****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "1" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|PluginCount]", "example": "1" } ], "required": [] }, { "name": "DescribeAssetWebAppPluginList", "description": "获取资产管理Web应用插件列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Uuid", "type": "string", "required": true, "description": "主机Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Id", "type": "string", "required": true, "description": "Web应用ID", "example": "23210436" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" } ], "required": [ "Quuid", "Uuid", "Id" ] }, { "name": "DescribeAssetWebFrameCount", "description": "获取所有Web框架数量", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "搜索条件：返回名称包含Name的所有Web框架列表", "example": "spring" } ], "required": [] }, { "name": "DescribeAssetWebFrameList", "description": "获取资产管理Web框架列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Name - String - 是否必填：否 - 框架名 NameStrict - String - 是否必填：否 - 框架名（严格匹配） Lang - String - 是否必填：否 - 框架语言:java/python Type - String - 是否必填：否 - 服务类型： 0：全部 1:Tomcat 2:Apache 3:Nginx 4:WebLogic 5:Websphere 6:JBoss 7:WildFly 8:Jetty 9:IHS 10:Ten...", "example": "[{\"ExactMatch\": false, \"Name\": \"Lang\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|JarCount]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetWebLocationCount", "description": "获取所有Web站点数量", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "搜索条件：返回名称包含Name的所有Web站点列表", "example": "localhost" } ], "required": [] }, { "name": "DescribeAssetWebLocationInfo", "description": "获取Web站点详情", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "服务器Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Uuid", "type": "string", "required": true, "description": "服务器Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Id", "type": "string", "required": true, "description": "站点Id", "example": "1" } ], "required": [ "Quuid", "Uuid", "Id" ] }, { "name": "DescribeAssetWebLocationList", "description": "获取Web站点列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "acdd5474-6360-4fd4-bfc7-843162cb8116" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Name - String - 是否必填：否 - 域名 User - String - 是否必填：否 - 运行用户 Port - uint64 - 是否必填：否 - 站点端口 Proto - uint64 - 是否必填：否 - 站点协议：1:HTTP,2:HTTPS ServiceType - uint64 - 是否必填：否 - 服务类型： 1:Tomcat 2：Apache 3:Nginx 4:WebLogic 5:Websphere 6:JBoss ...", "example": "[{\"MachineName\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "12" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|PathCount]", "example": "PathCount" } ], "required": [] }, { "name": "DescribeAssetWebLocationPathList", "description": "获取Web站点虚拟目录列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "服务器Quuid", "example": "77af405a-e9a5-4d61-810b-7799ef91614c" }, { "name": "Uuid", "type": "string", "required": true, "description": "服务器Uuid", "example": "77af405a-e9a5-4d61-810b-7799ef91614c" }, { "name": "Id", "type": "string", "required": true, "description": "Web站点Id", "example": "1002" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回列表数量，最多100，默认10", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，默认为0", "example": "0" } ], "required": [ "Quuid", "Uuid", "Id", "Limit", "Offset" ] }, { "name": "DescribeAssetWebServiceCount", "description": "获取所有Web服务数量", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "搜索条件：返回名称包含Name的所有Web服务列表", "example": "Tomcat" } ], "required": [] }, { "name": "DescribeAssetWebServiceInfoList", "description": "查询资产管理Web服务列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 User- string - 是否必填：否 - 运行用户 Name- string - 是否必填：否 - Web服务名： 1:Tomcat 2:Apache 3:Nginx 4:WebLogic 5:Websphere 6:JBoss 7:WildFly 8:Jetty 9:IHS 10:Tengine OsType- string - 是否必填：否 - Windows/linux Os -String 是否必填: 否 - 操作系统( DescribeMachineOsList 接口 值 )", "example": "[{\"ExactMatch\": false, \"Name\": \"User\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|ProcessCount]", "example": "FirstTime" } ], "required": [] }, { "name": "DescribeAssetWebServiceProcessList", "description": "获取Web服务关联进程列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Uuid", "type": "string", "required": true, "description": "主机Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Id", "type": "string", "required": true, "description": "Web服务ID", "example": "12869" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" } ], "required": [ "Quuid", "Uuid", "Id" ] }, { "name": "DescribeAttackEventInfo", "description": "网络攻击事件详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "事件id", "example": "49754647" } ], "required": [ "Id" ] }, { "name": "DescribeAttackEvents", "description": "按分页形式展示网络攻击检测事件列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Type - String 攻击状态 0: 尝试攻击 1: 攻击成功 - 是否必填: 否 Status - String 事件处理状态 0：待处理 1：已处理 2： 已加白 3： 已忽略 4：已删除 - 是否必填: 否 SrcIP - String 来源IP - 是否必填: 否 Uuids - String 主机安全uuid - 是否必填: 否 Quuids - String cvm uuid - 是否必填: 否 DstPort - String 攻击目标端口 - 是否必填: 否 MachineName - String 主机名称 - 是否必填: 否 InstanceID - String 主机\ufffd...", "example": "[{\"MachineName\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "By", "type": "string", "required": false, "description": "排序", "example": "Merge****" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 ASC,DESC", "example": "DESC" } ], "required": [] }, { "name": "DescribeAttackStatistics", "description": "网络攻击数据统计", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAttackTop", "description": "网络攻击top5数据列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 BeginTime - String 起始时间,默认近7天- 是否必填: 否", "example": "[{\"Name\": \"Begin****\", \"Values\": [\"2024-10-25 10:0****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeAttackTrends", "description": "网络攻击趋势数据", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 BeginTime - String 起始时间,默认近7天- 是否必填: 否", "example": "[{\"Name\": \"Begin****\", \"Values\": [\"2024-10-25 10:0****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeAttackVulTypeList", "description": "获取网络攻击威胁类型列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBanMode", "description": "获取爆破阻断模式", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBanRegions", "description": "获取阻断地域", "status": "online", "parameters": [ { "name": "Mode", "type": "string", "required": true, "description": "阻断模式，STANDARD_MODE：标准阻断，DEEP_MODE：深度阻断", "example": "STANDARD_MODE" } ], "required": [ "Mode" ] }, { "name": "DescribeBanStatus", "description": "获取阻断按钮状态", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBanWhiteList", "description": "获取阻断白名单列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 查询关键字", "example": "[{\"MachineName\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeBaselineAnalysisData", "description": "根据基线策略id查询基线策略数据概览统计", "status": "online", "parameters": [ { "name": "StrategyId", "type": "integer", "required": true, "description": "基线策略id", "example": "1" } ], "required": [ "StrategyId" ] }, { "name": "DescribeBaselineBasicInfo", "description": "查询基线基础信息列表", "status": "online", "parameters": [ { "name": "BaselineName", "type": "string", "required": false, "description": "基线名称", "example": "等保二级name" } ], "required": [] }, { "name": "DescribeBaselineDefaultStrategyList", "description": "查询基线默认策略列表信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBaselineDetail", "description": "根据基线id查询基线详情接口", "status": "online", "parameters": [ { "name": "BaselineId", "type": "integer", "required": true, "description": "基线id", "example": "1" } ], "required": [ "BaselineId" ] }, { "name": "DescribeBaselineDetectList", "description": "获取基线检测详情记录", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "PolicyName - string - 是否必填：否 - 策略名称 PolicyDetectStatus - int - 是否必填：否 - 1:检测中 2:检测完成 FirstTime - string - 是否必填：否 - 开始时间 LastTime - string - 是否必填：否 - 结束时间", "example": "[{\"PolicyName\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [HostCount|StartTime|StopTime]", "example": "HostCount" } ], "required": [] }, { "name": "DescribeBaselineDetectOverview", "description": "获取基线检测概览", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": false, "description": "策略Id", "example": "1" } ], "required": [] }, { "name": "DescribeBaselineDownloadList", "description": "获取基线下载列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "Status - int - 是否必填：否 - 0:导出中 1:已完成 StartTime - string - 是否必填：否 - 开始时间 EndTime - string - 是否必填：否 - 结束时间 TaskName - string - 是否必填：否 - 任务名称", "example": "[{\"Name\": \"Start****\", \"Values\": [\"2024-11-01 00:0****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [StartTime|EndTime]", "example": "Start****" } ], "required": [] }, { "name": "DescribeBaselineEffectHostList", "description": "根据基线id查询基线影响主机列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "0" }, { "name": "BaselineId", "type": "integer", "required": true, "description": "基线id", "example": "12" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 AliasName- String- 主机别名 Status- Uint- 1已通过 0未通过 5检测中", "example": "[{\"Name\": \"Status\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "StrategyId", "type": "integer", "required": false, "description": "策略id", "example": "1124" }, { "name": "UuidList", "type": "array", "required": false, "description": "主机uuid数组", "example": "[\"24c9be55-c743-4a75-a5c7-*******\"]", "item_type": "string" } ], "required": [ "Limit", "Offset", "BaselineId" ] }, { "name": "DescribeBaselineFixList", "description": "获取基线修复列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "ItemName- string - 是否必填：否 - 项名称", "example": "[{\"[{\"MachineName\":\"Name\",\"Values\":[\"dev\"]}]\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [CreateTime|MoifyTime|FixTime]", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeBaselineHostDetectList", "description": "获取基线检测主机列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "PolicyId - int64 - 是否必填：否 - 策略Id HostName - string - 是否必填：否 - 主机名称 HostIp - string - 是否必填：否 - 主机Ip ItemId - int64 - 是否必填：否 - 项Id RuleId - int64 - 是否必填：否 - 规则Id DetectStatus - int - 是否必填：否 - 检测状态 Level - int - 是否必填：否 - 风险等级 StartTime - string - 是否必填：否 - 开时时间 EndTime - string - 是否必填：否 - 结束时间", "example": "[{\"ExactMatch\": true, \"Name\": \"RuleId\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [LastTime|ItemCount|PassedItemCount|NotPassedItemCount|FirstTime]", "example": "LastTime" } ], "required": [] }, { "name": "DescribeBaselineHostIgnoreList", "description": "获取忽略规则主机列表", "status": "online", "parameters": [ { "name": "RuleID", "type": "integer", "required": true, "description": "请求的规则", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" } ], "required": [ "RuleID" ] }, { "name": "DescribeBaselineHostRiskTop", "description": "获取基线服务器风险TOP5", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": false, "description": "策略ID", "example": "861027" } ], "required": [] }, { "name": "DescribeBaselineHostTop", "description": "接口返回TopN的风险服务器", "status": "online", "parameters": [ { "name": "Top", "type": "integer", "required": true, "description": "动态top值", "example": "1" }, { "name": "StrategyId", "type": "integer", "required": true, "description": "策略id", "example": "1" } ], "required": [ "Top", "StrategyId" ] }, { "name": "DescribeBaselineItemDetectList", "description": "获取基线检测项的列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "HostId - string - 是否必填：否 - 主机Id RuleId - int64 - 是否必填：否 - 规则Id PolicyId - int64 - 是否必填：否 - 规则Id ItemName - string - 是否必填：否 - 项名称 DetectStatus - int - 是否必填：否 - 检测状态 Level - int - 是否必填：否 - 风险等级 StartTime - string - 是否必填：否 - 开始时间 EndTime - string - 是否必填：否 - 结束时间", "example": "[{\"ExactMatch\": true, \"Name\": \"HostId\", \"Values\": [\"38c0cda2-ce4b-462f-8ebe-b6191db7****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [HostCount|FirstTime|LastTime]", "example": "HostCount" } ], "required": [] }, { "name": "DescribeBaselineItemIgnoreList", "description": "获取忽略规则项列表", "status": "online", "parameters": [ { "name": "RuleID", "type": "integer", "required": true, "description": "忽略规则ID", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "请求偏移默认0", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "CatgoryId - int64 - 是否必填：否 - 规则Id", "example": "[{\n \"Name\": \"CatgoryId\",\n \"Values\": [“1005”],\n \"ExactMatch\": false\n}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列 [ID]", "example": "ID" } ], "required": [ "RuleID" ] }, { "name": "DescribeBaselineItemInfo", "description": "获取基线检测项信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "ItemId - int64 - 是否必填：否 - 项Id Level - int - 是否必填：否 - 风险等级 ItemName - string - 是否必填：否 - 检测项名字 RuleId - int - 是否必填：否 - 规则Id", "example": "[{\"Name\":\"RuleId\",\"Values\":[50,51]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "1" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列", "example": "1" } ], "required": [] }, { "name": "DescribeBaselineItemList", "description": "获取基线项检测结果列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "PolicyId - int64 - 是否必填：否 - 策略Id RuleId - int64 - 是否必填：否 - 规则Id HostId - string - 是否必填：否 - 主机Id HostName - string - 是否必填：否 - 主机名 HostIp - string - 是否必填：否 - 主机IP ItemId - String - 是否必填：否 - 检测项Id ItemName - String - 是否必填：否 - 项名称 DetectStatus - int - 是否必填：否 - 检测状态[0:未通过|3:通过|5:检测中] Level - int - 是否必填：否 - 风险等级 StartTime - string...", "example": "[{\"ExactMatch\": true, \"Name\": \"HostId\", \"Values\": [\"b86dccfe-8894-4836-91bb-96c967e4****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列", "example": "LastTime" } ], "required": [] }, { "name": "DescribeBaselineItemRiskTop", "description": "获取基线检测项TOP5", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": false, "description": "策略ID", "example": "1" } ], "required": [] }, { "name": "DescribeBaselineList", "description": "查询基线列表信息", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 StrategyId- Uint64 - 基线策略id Status - Uint64 - 处理状态 1-已通过 0-未通过 Level - Uint64 - 威胁等级 1-低危 2-中危 3-高危 4-严重 BaselineName - String - 基线名称 Quuid- String - 主机quuid Uuid- String - 主机uuid", "example": "[{\"Name\": \"Strate****\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeBaselinePolicyList", "description": "获取基线策略列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "PolicyName - String - 是否必填：否 - 策略名称", "example": "[{\"[{\"MachineName\":\"Name\",\"Values\":[\"dev\"]}]\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [RuleCount|ItemCount|HostCount]", "example": "ID" } ], "required": [] }, { "name": "DescribeBaselineRule", "description": "根据基线id查询下属检测项信息", "status": "online", "parameters": [ { "name": "BaselineId", "type": "integer", "required": true, "description": "基线id", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "0" }, { "name": "Level", "type": "array", "required": false, "description": "危害等级", "example": "1", "item_type": "integer" }, { "name": "Status", "type": "integer", "required": false, "description": "状态", "example": "0" }, { "name": "Quuid", "type": "string", "required": false, "description": "主机quuid", "example": "e5b4724c-49af-46ab-bd84-cdbae897e7e0\"" }, { "name": "Uuid", "type": "string", "required": false, "description": "主机uuid", "example": "e5b4724c-49af-46ab-bd84-cdbae897e7e0\"" } ], "required": [ "BaselineId", "Limit", "Offset" ] }, { "name": "DescribeBaselineRuleCategoryList", "description": "获取基线分类列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBaselineRuleDetectList", "description": "获取基线规则检测列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "PolicyId - int64 - 是否必填：否 - 策略Id ItemId - int64 - 是否必填：否 - 策略Id RuleName - string - 是否必填：否 - 规则名称 DetectStatus - int - 是否必填：否 - 检测状态 StartTime - string - 是否必填：否 - 开时时间 EndTime - string - 是否必填：否 - 结束时间", "example": "[{\"ExactMatch\": true, \"Name\": \"PolicyId\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [HostCount|FirstTime|LastTime]", "example": "HostC****" } ], "required": [] }, { "name": "DescribeBaselineRuleIgnoreList", "description": "获取基线忽略规则列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "RuleName - String - 是否必填：否 - 规则名称 ItemId- int - 是否必填：否 - 检测项Id", "example": "[{\n \"Name\": \"RuleName\",\n \"Values\": [“name01”],\n \"ExactMatch\": false\n}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [HostCount]", "example": "HostC****" } ], "required": [] }, { "name": "DescribeBaselineRuleList", "description": "获取基线规则列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "RuleName - String - 是否必填：否 - 规则名称 CategoryId - int64 - 是否必填：否 自定义筛选为-1 - 规则分类 RuleType - int - 是否必填：否 0:系统 1:自定义 - 规则类型", "example": "[{\"Name\": \"RuleName\", \"Values\": [\"auto_****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列", "example": "ID" } ], "required": [] }, { "name": "DescribeBaselineScanSchedule", "description": "根据任务id查询基线检测进度", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务id", "example": "1" } ], "required": [ "TaskId" ] }, { "name": "DescribeBaselineStrategyDetail", "description": "根据基线策略id查询策略详情", "status": "online", "parameters": [ { "name": "StrategyId", "type": "integer", "required": true, "description": "用户基线策略id", "example": "1" } ], "required": [ "StrategyId" ] }, { "name": "DescribeBaselineStrategyList", "description": "查询一个用户下的基线策略信息", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "0" }, { "name": "Enabled", "type": "integer", "required": true, "description": "规则开关，1：打开 0：关闭 2:全部", "example": "1" } ], "required": [ "Limit", "Offset", "Enabled" ] }, { "name": "DescribeBaselineTop", "description": "根据策略id查询基线检测项TOP", "status": "online", "parameters": [ { "name": "Top", "type": "integer", "required": true, "description": "动态top值", "example": "5" }, { "name": "StrategyId", "type": "integer", "required": true, "description": "策略id", "example": "1" } ], "required": [ "Top", "StrategyId" ] }, { "name": "DescribeBaselineWeakPasswordList", "description": "获取基线弱口令列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "WeakPassword - string - 是否必填：否 - 弱口令", "example": "{\"Name\":\"WeakPassword\",\"Values\":[\"passwd\"],\"ExactMatch\":false}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列 [CreateTime|ModifyTime]", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeBashEvents", "description": "获取高危命令列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 HostName - String - 是否必填：否 - 主机名 Hostip - String - 是否必填：否 - 主机内网IP RuleCategory - Int - 是否必填：否 - 策略类型,全部或者单选(0:系统 1:用户) RuleName - String - 是否必填：否 - 策略名称 RuleLevel - Int - 是否必填：否 - 威胁等级,可以多选 Status - Int - 是否必填：否 - 处理状态,可多选(0:待处理 1:已处理 2:已加白 3:已忽略 4:已删除 5:已拦截) DetectBy - Int - 是否必填：否...", "example": "[{\"Name\": \"Start****\", \"Values\": [\"2024-11-01 09:0****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：根据请求次数排序：asc-升序/desc-降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段：CreateTime-发生时间。ModifyTime-处理时间", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeBashEventsInfo", "description": "查询高危命令事件详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "事件id", "example": "12" } ], "required": [ "Id" ] }, { "name": "DescribeBashEventsInfoNew", "description": "查询高危命令事件详情(新)", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "事件id", "example": "13" } ], "required": [ "Id" ] }, { "name": "DescribeBashEventsNew", "description": "获取高危命令列表(新)", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 HostName - String - 是否必填：否 - 主机名 Hostip - String - 是否必填：否 - 主机内网IP HostIp - String - 是否必填：否 - 主机内网IP RuleCategory - Int - 是否必填：否 - 策略类型,全部或者单选(0:系统 1:用户) RuleName - String - 是否必填：否 - 策略名称 RuleLevel - Int - 是否必填：否 - 威胁等级,可以多选 Status - Int - 是否必填：否 - 处理状态,可多选(0:待处理 1:已处理 2:已加白 3:已忽略 4:已\ufffd...", "example": "[{\"Name\": \"Status\", \"Values\": [\"2\"], \"ExactMatch\": false}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：根据请求次数排序：asc-升序/desc-降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段：CreateTime-发生时间。ModifyTime-处理时间", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeBashPolicies", "description": "获取高危命令策略列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name - String - 是否必填：否 - 规则名称 Rule - String - 是否必填：否 - 规则内容 Level - Int - 是否必填：否 - 威胁等级 White - Int - 是否必填：否 - 白名单类型 Category - Int - 是否必填：否 - 策略类型 BashAction - Int - 是否必填：否 - 操作动作 Enable - Int - 是否必填：否 - 生效状态 Id - Int - 是否必填：否 - 策略ID PolicyId - Int - 是否必填：否 - 策略ID RuleId - Int - 是否必填：否 - 策略ID", "example": "[{\"Name\": \"Category\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeBashRules", "description": "获取高危命令规则列表", "status": "online", "parameters": [ { "name": "Type", "type": "integer", "required": true, "description": "0-系统规则; 1-用户规则", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name - String - 是否必填：否 - 规则名称 Rule - String - 是否必填：否 - 规则内容 Level - Int - 是否必填：否 - 威胁等级 White - Int - 是否必填：否 - 白名单类型 RuleCategory - Int - 是否必填：否 - 策略类型 BashAction - Int - 是否必填：否 - 操作动作 Status - Int - 是否必填：否 - 生效状态", "example": "[{\"Name\": \"Keywords\", \"Values\": [\"yaxte****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [ "Type" ] }, { "name": "DescribeBruteAttackList", "description": "获取密码破解列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 Uuid - String - 是否必填：否 - 主机安全唯一Uuid Quuid - String - 是否必填：否 - 云服务器uuid Status - String - 是否必填：否 - 状态筛选：失败：FAILED 成功：SUCCESS UserName - String - 是否必填：否 - UserName筛选 SrcIp - String - 是否必填：否 - 来源ip筛选 CreateBeginTime - String - 是否必填：否 - 首次攻击时间筛选，开始时间 CreateEndTime - Str...", "example": "[{\"Name\":\"MachineName\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：根据请求次数排序：asc-升序/desc-降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段：CreateTime-首次攻击时间", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeBruteAttackRules", "description": "获取爆破破解规则", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCanFixVulMachine", "description": "漏洞修护-查询可修护主机信息", "status": "online", "parameters": [ { "name": "VulIds", "type": "array", "required": true, "description": "漏洞id 支持多个漏洞", "example": "[1,3]", "item_type": "integer" }, { "name": "Quuids", "type": "array", "required": false, "description": "需要修复的主机，和VulIds是and 的关系", "example": "[\"xxxxx\",\"xxxxx\"]", "item_type": "string" } ], "required": [ "VulIds" ] }, { "name": "DescribeCanNotSeparateMachine", "description": "获取木马不可隔离的主机", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "需要修改的事件id 数组，支持批量", "example": "[1,2]", "item_type": "integer" }, { "name": "UpdateAll", "type": "boolean", "required": false, "description": "是否更新全部，即是否对所有的事件进行操作，当ids 不为空时，此参数无效", "example": "false" }, { "name": "ExcludeId", "type": "array", "required": false, "description": "排除的事件id,当操作全部事件时，需要排除这次id", "example": "[1,2]", "item_type": "integer" }, { "name": "Filters", "type": "array", "required": false, "description": "IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 FilePath - String - 是否必填：否 - 路径筛选 VirusName - String - 是否必填：否 - 描述筛选 CreateBeginTime - String - 是否必填：否 - 创建时间筛选-开始时间 CreateEndTime - String - 是否必填：否 - 创建时间筛选-结束时间 Status - String - 是否必填：否 - 状态筛选 4待处理,5信任,6已隔离,10隔离中,11恢复隔离中", "example": "[{\"IpOrAlias\":\"Name\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "DescribeClientException", "description": "获取客户端异常事件", "status": "online", "parameters": [ { "name": "ExceptionType", "type": "integer", "required": true, "description": "客户端异常类型 1:客户端离线，2:客户端卸载", "example": "1" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页的偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页单页限制数目，不为0，最大值100", "example": "10" }, { "name": "StartTime", "type": "string", "required": false, "description": "起始时间 `2006-01-02 15:04:05` 格式", "example": "2006-01-02 15:04:05" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间 `2006-01-02 15:04:05` 格式", "example": "2006-01-02 15:04:05" } ], "required": [ "ExceptionType", "Offset", "Limit" ] }, { "name": "DescribeDefenceEventDetail", "description": "获取漏洞防御事件详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "漏洞事件id", "example": "13844" } ], "required": [ "Id" ] }, { "name": "DescribeDirectConnectInstallCommand", "description": "获取专线agent安装命令，包含token", "status": "online", "parameters": [ { "name": "RegionCode", "type": "string", "required": true, "description": "地域标示", "example": "gz" }, { "name": "VpcId", "type": "string", "required": true, "description": "Vpc的ID", "example": "dadas" }, { "name": "ExpireDate", "type": "string", "required": true, "description": "命令过期时间", "example": "2021-11-11" } ], "required": [ "RegionCode", "VpcId", "ExpireDate" ] }, { "name": "DescribeESAggregations", "description": "获取ES字段聚合结果", "status": "online", "parameters": [ { "name": "Query", "type": "string", "required": true, "description": "ES聚合条件JSON", "example": "{\"cwp\":\"dev\"}" } ], "required": [ "Query" ] }, { "name": "DescribeEmergencyVulList", "description": "获取应急漏洞列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Status - String - 是否必填：是 - 漏洞状态筛选，0//未检测 1有风险 ，2无风险 ，3 检查中展示progress Level - String - 是否必填：否 - 漏洞等级筛选 1:低 2:中 3:高 4:提示 VulName- String - 是否必填：否 - 漏洞名称搜索 Uuids- String - 是否必填：否 - 主机uuid IsSupportDefense - int- 是否必填：否 - 是否支持防御 0:不支持 1:支持", "example": "[{\"ExactMatch\": true, \"Name\": \"AttackL****\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 desc , asc", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段 PublishDate LastScanTime HostCount", "example": "PublishDate" }, { "name": "HotspotAttack", "type": "boolean", "required": false, "description": "是否热点漏洞", "example": "true" } ], "required": [] }, { "name": "DescribeEventByTable", "description": "根据事件表名和id查询告警事件详情", "status": "online", "parameters": [ { "name": "TableName", "type": "string", "required": true, "description": "事件表名", "example": "table" }, { "name": "Ids", "type": "array", "required": true, "description": "事件表id号", "example": "1", "item_type": "integer" } ], "required": [ "TableName", "Ids" ] }, { "name": "DescribeExportMachines", "description": "本接口 (DescribeExportMachines) 用于导出区域主机列表。", "status": "online", "parameters": [ { "name": "MachineType", "type": "string", "required": true, "description": "云主机类型。 CVM：表示虚拟主机 BM: 表示黑石物理机", "example": "CVM" }, { "name": "MachineRegion", "type": "string", "required": true, "description": "机器所属地域。如：ap-guangzhou，ap-shanghai", "example": "ap-guangzhou" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 查询关键字 Status - String - 是否必填：否 - 客户端在线状态（OFFLINE: 离线 | ONLINE: 在线 | UNINSTALLED：未安装） Version - String 是否必填：否 - 当前防护版本（ PRO_VERSION：专业版 | BASIC_VERSION：基础版） 每个过滤条件只支持一个值，暂不支持多个值“或”关系查询", "example": "[{\"Name\": \"Cloud****\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "ProjectIds", "type": "array", "required": false, "description": "机器所属业务ID列表", "example": "[1002,1003]", "item_type": "integer" } ], "required": [ "MachineType", "MachineRegion" ] }, { "name": "DescribeFastAnalysis", "description": "日志快速分析统计", "status": "online", "parameters": [ { "name": "From", "type": "integer", "required": true, "description": "起始时间，单位ms", "example": "10" }, { "name": "To", "type": "integer", "required": true, "description": "结束时间，单位ms", "example": "20" }, { "name": "Query", "type": "string", "required": true, "description": "查询语句，语句长度最大为4096", "example": "{\"a=b\"}" }, { "name": "FieldName", "type": "string", "required": true, "description": "日志字段名称", "example": "Name" } ], "required": [ "From", "To", "Query", "FieldName" ] }, { "name": "DescribeFileTamperEventRuleInfo", "description": "查看产生事件时规则详情接口", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "事件id", "example": "12" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页多少个 控制返回的uuids条数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "控制返回的uuids条数", "example": "0" } ], "required": [ "Id" ] }, { "name": "DescribeFileTamperEvents", "description": "核心文件监控事件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Status - String - 是否必填：否 - 处理状态 0 -- 待处理 1 -- 已加白 2 -- 已删除 3 - 已忽略 ModifyTime - String - 是否必填：否 - 最近发生时间 Uuid- String - 是否必填：否 - 主机uuid查询 RuleCategory- string - 是否必填：否 - 规则类别 0 系统规则 1 自定义规则 FileAction- string - 是否必填：否 - 威胁行为 read 读取文件 write 写文件", "example": "[{\"Name\":\"Status\",\"Values\":[\"2,3\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 ASC,DESC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段 CreateTime、ModifyTime", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeFileTamperRuleCount", "description": "查询主机关联文件监控规则数量", "status": "online", "parameters": [ { "name": "Uuids", "type": "array", "required": true, "description": "查询的主机uuids 一次性最多只能查100个", "example": "[\"xxxxx\",\"xxxxx\"]", "item_type": "string" } ], "required": [ "Uuids" ] }, { "name": "DescribeFileTamperRuleInfo", "description": "查询某个监控规则的详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "规则id", "example": "12" }, { "name": "Limit", "type": "integer", "required": false, "description": "控制返回的uuids 数量", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "控制返回的uuids 数量，起始位置", "example": "0" } ], "required": [ "Id" ] }, { "name": "DescribeFileTamperRules", "description": "核心文件监控规则列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 RuleCategory- string- 规则类别 0=系统规则，1=用户规则 Name- String - 规则名称", "example": "[{\"ExactMatch\": true, \"Name\": \"Level\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 ASC,DESC", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段 CreateTime、ModifyTime、HostCount", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeGeneralStat", "description": "获取主机相关统计", "status": "online", "parameters": [ { "name": "MachineType", "type": "string", "required": false, "description": "云主机类型。 CVM：表示腾讯云服务器 BM: 表示黑石物理机 ECM: 表示边缘计算服务器 LH: 表示轻量应用服务器 Other: 表示混合云机器", "example": "CVM" }, { "name": "MachineRegion", "type": "string", "required": false, "description": "机器所属地域。如：ap-guangzhou，ap-shanghai", "example": "ap-guangzhou" } ], "required": [] }, { "name": "DescribeHistoryAccounts", "description": "本接口 (DescribeHistoryAccounts) 用于获取账号变更历史列表数据。", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": true, "description": "云镜客户端唯一Uuid。", "example": "uuid" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Username - String - 是否必填：否 - 帐号名", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [ "Uuid" ] }, { "name": "DescribeHistoryService", "description": "查询日志检索服务信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeHostInfo", "description": "主机信息与标签信息查询", "status": "online", "parameters": [ { "name": "QuuidList", "type": "array", "required": false, "description": "主机Quuid数组", "example": "[\"24c9be55-c743-4a75-a5c7-2a2912341234\",\"24c9be55-c743-4a75-a5c7-2a2912341235\"]", "item_type": "string" }, { "name": "Uuids", "type": "array", "required": false, "description": "Uuids 查询，Quuid查询时填空", "example": "[\"24c9be55-c743-4a75-a5c7-2a2912341234\",\"24c9be55-c743-4a75-a5c7-2a2912341235\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeHostLoginList", "description": "获取异常登录列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。Quuid - String - 是否必填：否 - 云服务器uuidUuid - String - 是否必填：否 - 主机安全唯一UuidMachineName - String - 是否必填：否 - 主机别名Ip - String - 是否必填：否 - 主机ipInstanceID - String - 是否必填：否 - 主机实例IDSrcIp - String - 是否必填：否 - 来源ip筛选UserName - String - 是否必填：否 - 用户名筛选Status - string - 是否必填：否 - 状态筛选：2:待处理；5：已加白,14:已处理，15：已忽...", "example": "[{\"Name\": \"Status\", \"Values\": [null], \"ExactMatch\": false}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：根据请求次数排序：asc-升序/desc-降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段：LoginTime-发生时间", "example": "LoginTime" } ], "required": [] }, { "name": "DescribeHotVulTop", "description": "获取全网热点漏洞", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeIgnoreBaselineRule", "description": "查询已经忽略的检测项信息", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "0" }, { "name": "RuleName", "type": "string", "required": false, "description": "检测项名称", "example": "rulename" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeIgnoreHostAndItemConfig", "description": "获取一键忽略受影响的检测项和主机信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "ItemId - int64 - 是否必填：否 - 项Id RuleId - int64 - 是否必填：否 - 规则Id HostId - string - 是否必填：否 - 主机Id", "example": "[{\"Name\": \"HostId\", \"Values\": [\"2a2bcfb7-b649-43e5-9758-58035a7c****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeIgnoreRuleEffectHostList", "description": "根据检测项id与筛选条件查询忽略检测项影响主机列表信息", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "0" }, { "name": "RuleId", "type": "integer", "required": true, "description": "检测项id", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 AliasName- String- 主机别名", "example": "[{\"Name\":\"AliasName\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "TagNames", "type": "array", "required": false, "description": "主机标签名", "example": "[\"tag1\"]", "item_type": "string" } ], "required": [ "Limit", "Offset", "RuleId" ] }, { "name": "DescribeImportMachineInfo", "description": "查询批量导入机器信息", "status": "online", "parameters": [ { "name": "MachineList", "type": "array", "required": true, "description": "服务器内网IP（默认）/ 服务器名称 / 服务器ID 数组 (最大 1000条)", "example": "[\"10.244.64****\"]", "item_type": "string" }, { "name": "ImportType", "type": "string", "required": true, "description": "批量导入的数据类型：Ip、Name、Id 三选一", "example": "ip" }, { "name": "IsQueryProMachine", "type": "boolean", "required": false, "description": "该参数已作废.", "example": "true" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：Version - String 是否必填：否 - 当前防护版本（ PRO_VERSION：专业版 | BASIC_VERSION：基础版 | Flagship：旗舰版 | ProtectedMachines：专业版+旗舰版） | BASIC_PROPOST_GENERAL_DISCOUNT：轻量版+专业版按量计费+基础版主机 | UnFlagship：专业版预付费+专业版后付费+基础版+轻量版", "example": "[{\"Name\": \"Version\", \"Values\": [\"UnFlag****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [ "MachineList", "ImportType" ] }, { "name": "DescribeJavaMemShellInfo", "description": "查询java内存马事件详细信息", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "事件Id", "example": "184113" } ], "required": [ "Id" ] }, { "name": "DescribeJavaMemShellList", "description": "查询java内存马事件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：InstanceID、IP、 MachineName主机名模糊查询, Type，Status精确匹配，CreateBeginTime，CreateEndTime时间段", "example": "[{\"Name\":\"MachineName\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序，大小写无关：asc 升序，desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序列，严格相等：最近检测时间RecentFoundTime", "example": "RecentFoundTime" } ], "required": [] }, { "name": "DescribeJavaMemShellPluginInfo", "description": "查询给定主机java内存马插件信息", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机quuid", "example": "05f0bcab-726c-4ea4-8109-bcd03d5598f7" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：Pid精确匹配，MainClass模糊匹配", "example": "[{\"Name\":\"Pid\",\"Values\":[\"1021\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" } ], "required": [ "Quuid" ] }, { "name": "DescribeJavaMemShellPluginList", "description": "查询java内存马插件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：InstanceID、IP、 MachineName模糊查询, JavaShellStatus，Exception精确匹配", "example": "[{\"ExactMatch\": false, \"Name\": \"Keywords\", \"Values\": [\"ghdjsgh\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" } ], "required": [] }, { "name": "DescribeLicense", "description": "查询授权信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLicenseBindList", "description": "该接口可以获取设置中心-授权管理,某个授权下已绑定的授权机器列表", "status": "online", "parameters": [ { "name": "LicenseId", "type": "integer", "required": true, "description": "授权ID", "example": "1" }, { "name": "LicenseType", "type": "integer", "required": true, "description": "授权类型", "example": "0" }, { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID", "example": " " }, { "name": "Filters", "type": "array", "required": false, "description": "InstanceID、IP、 MachineName 模糊查询", "example": "[{\"Name\":\"MachineName\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10.", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0.", "example": "0" } ], "required": [ "LicenseId", "LicenseType", "ResourceId" ] }, { "name": "DescribeLicenseBindSchedule", "description": "查询授权绑定任务的进度", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10.", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数 Status 绑定进度状态 0 进行中 1 已完成 2 失败", "example": "[{\"Name\":\"Status\",\"Values\":[\"2\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [ "TaskId" ] }, { "name": "DescribeLicenseGeneral", "description": "授权管理-授权概览信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLicenseList", "description": "获取用户所有授权订单信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "多个条件筛选时取交集 LicenseStatus 授权状态信息,0 未使用,1 部分使用, 2 已用完, 3 不可用 4 可使用 BuyTime 购买时间 LicenseType 授权类型, 0 专业版-按量计费, 1专业版-包年包月 , 2 旗舰版-包年包月 DeadlineStatus 到期状态 NotExpired 未过期, Expire 已过期(包含已销毁) NearExpiry 即将到期 ResourceId 资源ID Keywords IP筛选 PayMode 付费模式 0 按量计费 , 1 包年包月 OrderStatus 订单状态 1 正常 2 隔离 3 销...", "example": "[{\"Name\":\"Keywords\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10.", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0.", "example": "0" }, { "name": "Tags", "type": "array", "required": false, "description": "标签筛选,平台标签能力,这里传入 标签键,标签值作为一个对象", "example": "[{\"TagKey\":\"cwp\", \"TagValue\":\"dev\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "business1" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "businessValue" } ] }, { "name": "Order", "type": "string", "required": false, "description": "ASC 正序, DESC 倒序", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "LicenseCnt 授权数量", "example": "LicenseCnt" } ], "required": [] }, { "name": "DescribeLicenseWhiteConfig", "description": "查询授权白名单的可用配置", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称,例如: cwp", "example": "cwp" } ], "required": [ "RuleName" ] }, { "name": "DescribeLogDeliveryKafkaOptions", "description": "查询日志投递kafka可选项列表", "status": "online", "parameters": [ { "name": "InstanceID", "type": "string", "required": false, "description": "kafka实例id", "example": "ckafka-xxxx" } ], "required": [] }, { "name": "DescribeLogExports", "description": "获取日志下载任务列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "分页的偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100", "example": "10" } ], "required": [ "Offset" ] }, { "name": "DescribeLogHistogram", "description": "获取日志直方图信息", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "要查询的日志的起始时间，Unix时间戳，单位ms", "example": "1656585671706" }, { "name": "EndTime", "type": "integer", "required": true, "description": "要查询的日志的结束时间，Unix时间戳，单位ms", "example": "1656586571706" }, { "name": "QueryString", "type": "string", "required": true, "description": "查询语句", "example": "item_id :ins-0jsx****" }, { "name": "Interval", "type": "integer", "required": true, "description": "时间间隔: 单位ms", "example": "1" } ], "required": [ "StartTime", "EndTime", "QueryString", "Interval" ] }, { "name": "DescribeLogIndex", "description": "查询索引", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLogKafkaDeliverInfo", "description": "获取kafka投递信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLogStorageConfig", "description": "获取日志存储配置", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLogStorageRecord", "description": "获取日志存储量记录", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLogStorageStatistic", "description": "获取日志检索容量使用统计", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLogType", "description": "日志分析功能-获取日志类型，使用该接口返回的结果暂时可过滤的日志类型", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLoginWhiteCombinedList", "description": "获取异地登录白名单合并后列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选UserName - String - 是否必填：否 - 用户名筛选SrcIP - String - 是否必填：否 - 来源IP筛选Location - String - 是否必填：否 - 登录地筛选ModifyBeginTime - String - 是否必填：否 - 按照修改时间段筛选，开始时间ModifyEndTime - String - 是否必填：否 - 按照修改时间段筛选，结束时间", "example": "[{\"ExactMatch\": false, \"Name\": \"Uuid\", \"Values\": [\"loginwhite****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeLoginWhiteHostList", "description": "查询合并后白名单机器列表", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "白名单ID", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "需要返回的数量，最大值为1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选", "example": "[ { \"Name\": \"IpOrAlias\", \"Values\": [ \"1.1.2.3\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] } ], "required": [ "Id", "Limit", "Offset" ] }, { "name": "DescribeLoginWhiteList", "description": "获取异地登录白名单列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IpOrAlias - String - 是否必填：否 - 查询关键字 UserName - String - 是否必填：否 - 用户名筛选 ModifyBeginTime - String - 是否必填：否 - 按照修改时间段筛选，开始时间 ModifyEndTime - String - 是否必填：否 - 按照修改时间段筛选，结束时间", "example": "[{\"Name\":\"IpOrAlias\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeMachineClearHistory", "description": "查询机器清理历史记录", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "筛选条件 多个条件筛选时 Keywords,TimeBetween,取交集 Keywords 实例名称/内网/公网IP TimeBetween 时间区间", "example": "[{\"Name\":\"Keywords\",\"Values\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10 ,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "正序, ASC , 倒序 DESC , 默认ASC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "AgentLastOfflineTime 客户端最后离线时间 AutoClearTime 清理时间", "example": "AgentLastOfflineTime" } ], "required": [] }, { "name": "DescribeMachineDefenseCnt", "description": "查询主机高级防御事件数统计", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Uuids- String - 是否必填：否 - 主机uuid", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeMachineFileTamperRules", "description": "查询主机相关核心文件监控规则列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": true, "description": "主机uuid", "example": "10ee1dad-ed42-4f98-8c9e-bfaa48fcb787" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "1" } ], "required": [ "Uuid" ] }, { "name": "DescribeMachineGeneral", "description": "查询主机概览信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMachineInfo", "description": "本接口（DescribeMachineInfo）用于获取机器详细信息。", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "主机安全客户端唯一Uuid。", "example": "e5b4724c-49af-46ab-bd84-cdbae897e7e0" }, { "name": "Quuid", "type": "string", "required": false, "description": "Quuid , Uuid 必填一项", "example": "e5b4724c-49af-46ab-bd84-cdbae897e7e0" } ], "required": [] }, { "name": "DescribeMachineLicenseDetail", "description": "本接口 (DescribeMachineLicenseDetail)查询机器授权信息", "status": "online", "parameters": [ { "name": "Quuids", "type": "array", "required": true, "description": "主机quuid", "example": "[\"17d8ad3a-afbb-44a8-8b9e-99a92160f367\"]", "item_type": "string" } ], "required": [ "Quuids" ] }, { "name": "DescribeMachineList", "description": "用于网页防篡改获取区域主机列表。", "status": "online", "parameters": [ { "name": "MachineType", "type": "string", "required": true, "description": "云主机类型。 CVM：表示虚拟主机 BM: 表示黑石物理机 ECM: 表示边缘计算服务器 LH: 表示轻量应用服务器 Other: 表示混合云机器", "example": "CVM" }, { "name": "MachineRegion", "type": "string", "required": true, "description": "机器所属地域。如：ap-guangzhou，ap-shanghai", "example": "ap-guangzhou" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 查询关键字 Status - String - 是否必填：否 - 客户端在线状态（OFFLINE: 离线 | ONLINE: 在线 | UNINSTALLED：未安装） Version - String 是否必填：否 - 当前防护版本（ PRO_VERSION：专业版 | BASIC_VERSION：基础版） 每个过滤条件只支持一个值，暂不支持多个值“或”关系查询", "example": "[{\"Keywords\":[\"CVE\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] } ], "required": [ "MachineType", "MachineRegion" ] }, { "name": "DescribeMachineOsList", "description": "查询可筛选操作系统列表.", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMachineRegionList", "description": "查询主机地域列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMachineRegions", "description": "获取机器地域列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMachineRiskCnt", "description": "查询主机入侵检测事件统计", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Uuids- String - 是否必填：否 - 主机uuid", "example": "[{\"Name\": \"Uuids\", \"Values\": [\"a037ce3a-8195-4bd0-b2b2-3272f212****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeMachineSnapshot", "description": "漏洞修护-查询主机创建的快照", "status": "online", "parameters": [ { "name": "Quuids", "type": "array", "required": true, "description": "cvm id 集合", "example": "[\"ejiwdk\"]", "item_type": "string" }, { "name": "Type", "type": "integer", "required": true, "description": "查询快照类型0 最近一个 1所有", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页个数", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页步长", "example": "0" } ], "required": [ "Quuids", "Type", "Limit", "Offset" ] }, { "name": "DescribeMachines", "description": "本接口 (DescribeMachines) 用于获取区域主机列表。", "status": "online", "parameters": [ { "name": "MachineType", "type": "string", "required": true, "description": "机器所属专区类型 CVM 云服务器 BM 黑石 ECM 边缘计算 LH 轻量应用服务器 Other 混合云专区", "example": "CVM" }, { "name": "MachineRegion", "type": "string", "required": true, "description": "机器所属地域。如：ap-guangzhou，ap-shanghai，非腾讯云主机使用：ap-others", "example": "ap-guangzhou" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Ips - String - 是否必填：否 - 通过ip查询 Names - String - 是否必填：否 - 通过实例名查询 InstanceIds - String - 是否必填：否 - 通过实例id查询 Version - String 是否必填：否 - 当前防护版本（ PRO_VERSION：专业版 | BASIC_VERSION：基础版 | Flagship : 旗舰版 | ProtectedMachines: 专业版+旗舰版） Risk - String 是否必填: 否 - 风险主机( yes ) Os -String 是否必填: 否 - 操作系统( DescribeMachineOsList 接口 \ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "ProjectIds", "type": "array", "required": false, "description": "机器所属业务ID列表", "example": "[1024]", "item_type": "integer" } ], "required": [ "MachineType", "MachineRegion" ] }, { "name": "DescribeMachinesSimple", "description": "本接口 (DescribeMachinesSimple) 用于获取主机列表。", "status": "online", "parameters": [ { "name": "MachineType", "type": "string", "required": true, "description": "机器所属专区类型 CVM 云服务器 BM 黑石 ECM 边缘计算 LH 轻量应用服务器 Other 混合云专区", "example": "CVM" }, { "name": "MachineRegion", "type": "string", "required": true, "description": "机器所属地域。如：ap-guangzhou，ap-shangha，非腾讯云主机使用：ap-others", "example": "ap-guangzhou" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 查询关键字 Version - String 是否必填：否 - 当前防护版本（ PRO_VERSION：专业版 | BASIC_VERSION：基础版 | Flagship : 旗舰版 | ProtectedMachines: 专业版+旗舰版 | UnFlagship : 非旗舰版 | PRO_POST_PAY：专业版按量计费 | PRO_PRE_PAY：专业版包年包月） TagId - String - 是否必填：否 - 标签ID", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "ProjectIds", "type": "array", "required": false, "description": "机器所属业务ID列表", "example": "[1042,1043]", "item_type": "integer" } ], "required": [ "MachineType", "MachineRegion" ] }, { "name": "DescribeMalWareList", "description": "入侵检测获取木马列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 FilePath - String - 是否必填：否 - 路径筛选 VirusName - String - 是否必填：否 - 描述筛选 CreateBeginTime - String - 是否必填：否 - 创建时间筛选-开始时间 CreateEndTime - String - 是否必填：否 - 创建时间筛选-结束时间 Status - String - 是否必填：否 - 状态筛选 4待处理,5信任,6已隔离,10隔离中,11恢复隔离中,14 已处理", "example": "[{\"Name\": \"CreateBegin****\", \"Values\": [\"2024-10-03 00:0****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "By", "type": "string", "required": false, "description": "检测排序 CreateTime", "example": "CreateTime" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 ASC,DESC", "example": "ASC" } ], "required": [] }, { "name": "DescribeMaliciousRequestWhiteList", "description": "查询恶意请求白名单列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Domain - String - 基线名称", "example": "[{\"ExactMatch\": true, \"Name\": \"Domain\", \"Values\": [\"d3d3LlpmU0ou****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 [asc:升序|desc:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段", "example": "CreateTime" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeMalwareFile", "description": "获取木马文件下载地址", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "木马记录ID", "example": "1" } ], "required": [ "Id" ] }, { "name": "DescribeMalwareInfo", "description": "查看恶意文件详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "唯一ID", "example": "1023290" } ], "required": [ "Id" ] }, { "name": "DescribeMalwareRiskOverview", "description": "获取文件查杀概览信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMalwareRiskWarning", "description": "打开入侵检测-恶意文件检测,弹出风险预警内容", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMalwareTimingScanSetting", "description": "查询定时扫描配置", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMalwareWhiteList", "description": "获取木马白名单列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 HostIp - String - 是否必填：否 - 主机ip查询 FileName - String - 是否必填：否 - 文件名称查询 FileDirectory - String - 是否必填：否 - 文件目录查询 FileExtension - String - 是否必填：否 - 文件后缀查询 Mode - String - 是否必填：否 - 规则类型 0 MD5,1自定义 Md5 - String - 是否必填：否 - MD5查询", "example": "[{\"ExactMatch\": false, \"Name\": \"HostIp\", \"Values\": [\"1.1.1.1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [EventsCount|CreateTime|ModifyTime]", "example": "EventsCount" } ], "required": [] }, { "name": "DescribeMalwareWhiteListAffectList", "description": "获取木马白名单受影响列表", "status": "online", "parameters": [ { "name": "WhiteListId", "type": "integer", "required": true, "description": "白名单规则id", "example": "2" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 HostIp - String - 是否必填：否 - 主机ip查询 FileName - String - 是否必填：否 - 文件名称查询 FileDirectory - String - 是否必填：否 - 文件目录查询 FileExtension - String - 是否必填：否 - 文件后缀查询 Mode - String - 是否必填：否 - 规则类型 0 MD5,1自定义 Md5 - String - 是否必填：否 - MD5查询", "example": "[{\"ExactMatch\": false, \"Name\": \"HostIp\", \"Values\": [\"1.1.1.1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [CreateTime]", "example": "CreateTime" } ], "required": [ "WhiteListId" ] }, { "name": "DescribeNetAttackSetting", "description": "查询网络攻击设置", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeNetAttackWhiteList", "description": "获取网络攻击白名单列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip查询 SrcIP- String - 是否必填：否 - 白名单ip查询", "example": "[{\"ExactMatch\": false, \"Name\": \"SrcIP \", \"Values\": [\"1.1.1.1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [CreateTime]", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeOpenPortStatistics", "description": "本接口 (DescribeOpenPortStatistics) 用于获取端口统计列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Port - Uint64 - 是否必填：否 - 端口号", "example": "[ { \"Name\": \"Port\", \"Values\": [ \"8080\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeOverviewStatistics", "description": "获取概览统计数据。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribePatchEffectHostList", "description": "查询补丁影响的主机信息列表", "status": "online", "parameters": [ { "name": "KbId", "type": "integer", "required": true, "description": "补丁id", "example": "782334" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页limit 最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件： HostVersion : uint64类型 非必填 版本信息 : 0-基础版 1-专业版 2-旗舰版 3-轻量版 InstanceState : string类型 非必填 主机状态 : \"PENDING\"-创建中 \"LAUNCH_FAILED\"-创建失败 \"RUNNING\"-运行中 \"STOPPED\"-关机 \"STARTING\"-开机中 \"STOPPING\"-关机中 \"REBOOTING\"-重启中 \"SHUTDOWN\"-待销毁 \"TERMINATING\"-销毁中 \"UNKNOWN\"-未知（针对非腾讯云机器，且客户端离线的场景） Status : uint64类型 非必填 处理状态 0表示待处...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [ "KbId", "Limit", "Offset" ] }, { "name": "DescribePatchInfo", "description": "补丁详情", "status": "online", "parameters": [ { "name": "KbId", "type": "integer", "required": true, "description": "补丁id", "example": "5060526" } ], "required": [ "KbId" ] }, { "name": "DescribePrivilegeEventInfo", "description": "本地提权信息详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "事件id", "example": "12" } ], "required": [ "Id" ] }, { "name": "DescribePrivilegeEvents", "description": "获取本地提权事件列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 关键词(主机IP)", "example": "[{\"Name\": \"Status\", \"Values\": [\"value\"], \"ExactMatch\": false}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：根据请求次数排序：asc-升序/desc-降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段：CreateTime-发现时间", "example": "CreateTime" } ], "required": [] }, { "name": "DescribePrivilegeRules", "description": "获取本地提权规则列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 关键字(进程名称)", "example": "[{\"ExactMatch\": false, \"Name\": \"SMode\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeProVersionInfo", "description": "用于获取专业版概览信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeProVersionStatus", "description": "用于获取单台主机或所有主机是否开通专业版状态。", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": true, "description": "主机安全客户端UUID、填写\"all\"表示所有主机。", "example": "e8f91530-02c7-3e98-d84d-26df60d981ef" } ], "required": [ "Uuid" ] }, { "name": "DescribeProcessStatistics", "description": "本接口 (DescribeProcessStatistics) 用于获取进程统计列表数据。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 ProcessName - String - 是否必填：否 - 进程名", "example": "[{\"ProcessName\":[\"CVE\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeProductStatus", "description": "产品试用状态查询接口", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeProtectDirList", "description": "网页防篡改防护目录列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页条数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "DirName 网站名称 DirPath 网站防护目录地址", "example": "[{\"ExactMatch\": false, \"Name\": \"Status\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Order", "type": "string", "required": false, "description": "asc：升序/desc：降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段", "example": "ProtectServerNum, NoProtectServerNum, LatestProtectTime, RelatedServerNum" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeProtectDirRelatedServer", "description": "查询防护目录关联服务器列表信息", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "唯一ID", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页条数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数 ProtectStatus", "example": "[{\"Name\":\"ProtectStatus\",\"Values\":[\"1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序值", "example": "LatestProtectTime" } ], "required": [ "Id", "Limit", "Offset" ] }, { "name": "DescribePublicProxyInstallCommand", "description": "获取公网接入代理安装命令", "status": "online", "parameters": [ { "name": "Ip", "type": "string", "required": false, "description": "nginx主机IP列表，逗号分隔", "example": "1.1.1.1" } ], "required": [] }, { "name": "DescribeRansomDefenseBackupList", "description": "查询主机快照备份列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "1" }, { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Status - Int - 是否必填：否 - 通过勒索状态查询：0未勒索，1已勒索 CreateTimeBegin - string - 是否必填：否 - 创建时间开始 CreateTimeEnd - string - 是否必填：否 - 创建时间结束", "example": "[{\"ExactMatch\": true, \"Name\": \"\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime", "example": "CreateTime" } ], "required": [ "Limit", "Offset", "Quuid" ] }, { "name": "DescribeRansomDefenseEventsList", "description": "查询防勒索事件列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 HostName- string- 主机名称 Status - Uint64 - 0待处理，1已处理，2已信任 HostIp- String - 主机ip", "example": "[{\"Name\": \"Status\", \"Values\": [null], \"ExactMatch\": false}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime", "example": "CreateTime" }, { "name": "CreateBeginTime", "type": "string", "required": false, "description": "事件创建起始时间", "example": "2025-02-10 16:00:01" }, { "name": "CreateEndTime", "type": "string", "required": false, "description": "事件创建结束时间", "example": "2025-02-10 16:00:01" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeRansomDefenseMachineList", "description": "查询备份详情列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Ips - String - 是否必填：否 - 通过ip查询 MachineNames - String - 是否必填：否 - 通过实例名查询 Names - String - 是否必填：否 - 通过策略名查询 Status - String - 是否必填：否 - 策略状态：0备份中，1备份成功，2备份失败, 9暂无备份 LastBackupStatus - String - 是否必填：否 - 上次备份状态：0备份中，1备份成功，2备份失败, 9暂无备份 LastBackupTimeBegin - String - 是否必填：否 - 最近一次\ufffd\ufffd...", "example": "[ { \"Name\": \"Ips\", \"Values\": [ \"1.1.2.3\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime、LastBackupTime、BackupCount", "example": "CreateTime" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeRansomDefenseMachineStrategyInfo", "description": "获取主机绑定策略列表", "status": "online", "parameters": [ { "name": "Quuids", "type": "array", "required": true, "description": "主机Quuid列表", "example": "[\"e5b4724c-49af-46ab-bd84-cdbae897e7e0\"]", "item_type": "string" } ], "required": [ "Quuids" ] }, { "name": "DescribeRansomDefenseRollBackTaskList", "description": "查询回滚任务列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Ips- string- 主机名称 Status - Uint64 - 0进行中，1成功，2失败 Names- String - 主机名称", "example": "[ { \"Name\": \"Ips\", \"Values\": [ \"1.1.2.3\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime、ModifyTime", "example": "CreateTime" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeRansomDefenseState", "description": "获取用户防勒索趋势", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeRansomDefenseStrategyDetail", "description": "获取策略详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "策略ID", "example": "1" } ], "required": [ "Id" ] }, { "name": "DescribeRansomDefenseStrategyList", "description": "查询防勒索策略列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Ips - String - 是否必填：否 - 通过ip查询 MachineNames - String - 是否必填：否 - 通过实例名查询 Names - String - 是否必填：否 - 通过防勒索策略名查询 Dirs - String - 是否必填：否 - 诱饵目录 Status - String - 是否必填：否 - 策略状态：0关闭，1开启 BackupType - String - 是否必填：否 - 备份模式：0-按周;1-按天", "example": "[ { \"Name\": \"Ips\", \"Values\": [ \"1.1.2.3\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime, MachineCount", "example": "CreateTime" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeRansomDefenseStrategyMachines", "description": "查询防勒索策略绑定机器列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页参数 最大100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Ips- string- 主机名称 Status - Uint64 - 0未绑定，1已绑定 Names- String - 主机名称", "example": "[ { \"Name\": \"Ips\", \"Values\": [ \"1.1.2.3\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime", "example": "CreateTime" }, { "name": "Id", "type": "integer", "required": false, "description": "防勒索策略ID", "example": "5570" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeRansomDefenseTrend", "description": "获取全网勒索态势", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeRaspMaxCpu", "description": "查看漏洞防御最大cpu限制", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeRaspRuleVuls", "description": "获取漏洞防御白名单漏洞列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": true, "description": "过滤条件。Name=WhiteType的必选，0：表示自定义范围的漏洞列表，1：表示全部请求范围的列表", "example": "[{\"Name\":\"WhiteType\",\"Values\":[\"0\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为1000。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [ "Filters" ] }, { "name": "DescribeRaspRules", "description": "查询漏洞防御白名单", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 关键字(进程名称)", "example": "[{\"Name\":\"Keywords\",\"Values\":[\"加白内容\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "By", "type": "string", "required": false, "description": "排序字段，目前有：CreateTime、ModifyTime，默认按照ModifyTime排序", "example": "ModifyTime" }, { "name": "Order", "type": "string", "required": false, "description": "排序升序还是倒序，DESC有ASC、", "example": "ASC" } ], "required": [] }, { "name": "DescribeRecommendedProtectCpu", "description": "查询推荐购买防护核数", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeReverseShellEventInfo", "description": "反弹shell信息详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "事件id", "example": "12" } ], "required": [ "Id" ] }, { "name": "DescribeReverseShellEvents", "description": "获取反弹Shell列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 关键字(主机内网IP|进程名)", "example": "[{\"Name\": \"CreateEnd****\", \"Values\": [\"2024-11-01 10:0****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：根据请求次数排序：asc-升序/desc-降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段：CreateTime-发生时间", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeReverseShellRules", "description": "获取反弹Shell规则列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 关键字(进程名称)", "example": "[{\"ExactMatch\": false, \"Name\": \"Keywords\", \"Values\": [\"key1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeRiskBatchStatus", "description": "查询入侵检测事件更新状态任务是否完成", "status": "online", "parameters": [ { "name": "RiskType", "type": "string", "required": true, "description": "操作事件类型，文件查杀：MALWARE，异常登录：HOST_LOGIN，密码破解：BRUTE_ATTACK，恶意请求：MALICIOUS_REQUEST，高危命令：BASH_EVENT，本地提权：PRIVILEGE_EVENT，反弹shell：REVERSE_SHELL", "example": "MALWARE" } ], "required": [ "RiskType" ] }, { "name": "DescribeRiskDnsEventInfo", "description": "查询恶意请求事件详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "恶意请求事件Id", "example": "1" } ], "required": [ "Id" ] }, { "name": "DescribeRiskDnsEventList", "description": "获取恶意请求事件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "MachineName 主机名称 InstanceID 实例ID IP 内网IP或公网IP- 是否必填：否 - 主机Ip或别名筛选 HostId - String - 是否必填：否 - 主机Id AgentId - String - 是否必填：否 - 客户端Id PolicyType - String - 是否必填：否 - 策略类型,0:系统策略1:用户自定义策略 Domain - String - 是否必填：否 - 域名(先对域名做urlencode,再base64) HandleStatus - String - 是否必填：否 - 状态筛选0:待处理；2:信任；3:不信任 BeginTime - Stri...", "example": "[ { \"Name\": \"MachineName\", \"Values\": [ \"name1\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：根据请求次数排序：[asc:升序|desc:降序]", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段：[AccessCount:请求次数|LastTime:最近请求时间]", "example": "AccessCount" } ], "required": [] }, { "name": "DescribeRiskDnsInfo", "description": "查询恶意请求详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "恶意请求-事件Id", "example": "1" } ], "required": [ "Id" ] }, { "name": "DescribeRiskDnsList", "description": "入侵检测，获取恶意请求列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 Url - String - 是否必填：否 - Url筛选 Status - String - 是否必填：否 - 状态筛选0:待处理；2:信任；3:不信任 MergeBeginTime - String - 是否必填：否 - 最近访问开始时间 MergeEndTime - String - 是否必填：否 - 最近访问结束时间", "example": "[ { \"Name\": \"IpOrAlias\", \"Values\": [ \"1.1.1.1\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：根据请求次数排序：asc-升序/desc-降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段：AccessCount-请求次数。MergeTime-最近请求时间", "example": "AccessCount" } ], "required": [] }, { "name": "DescribeRiskDnsPolicyList", "description": "获取恶意请求策略列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "PolicyType - int - 是否必填：否 - 策略类型 PolicyName - string - 是否必填：否 - 策略名称 Domain - string - 是否必填：否 - 域名(先对域名做urlencode,再base64) PolicyAction- int - 是否必填：否 - 策略动作 IsEnabled - int - 是否必填：否 - 是否生效", "example": "[{\"Name\": \"Policy\", \"Values\": [\"PolicyName\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [HostScope|UpdateTime]", "example": "HostScope" } ], "required": [] }, { "name": "DescribeRiskProcessEvents", "description": "获取异常进程列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 HostId - String - 是否必填：否 - 主机ID IpOrName - String - 是否必填：否 - 主机IP或主机名 VirusName - String - 是否必填：否 - 病毒名 ProcessId - String - 是否必填：否 - 进程ID FilePath - String - 是否必填：否 - 进程路径 BeginTime - String - 是否必填：否 - 进程启动时间-开始 EndTime - String - 是否必填：否 - 进程启动时间-结束 Status - String - 是否必填：否 - 状态筛选 0待处理；1查杀中；2已\ufffd...", "example": "[{\"Name\": \"HostId\", \"Values\": [\"a5b2bbbc-b89c-40b2-a0a9-f24aed7f****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 [ASC|DESC]", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "[StartTime:进程启动时间|DetectTime:最后检测时间]", "example": "StartTime" } ], "required": [] }, { "name": "DescribeSafeInfo", "description": "查询安全通知信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScanMalwareSchedule", "description": "查询木马扫描进度", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScanSchedule", "description": "根据taskid查询检测进度", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务id", "example": "1" } ], "required": [ "TaskId" ] }, { "name": "DescribeScanState", "description": "DescribeScanState 该接口能查询对应模块正在进行的扫描任务状态", "status": "online", "parameters": [ { "name": "ModuleType", "type": "string", "required": true, "description": "模块类型 当前提供 Malware 木马 , Vul 漏洞 , Baseline 基线", "example": "Vul" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数; StrategyId 基线策略ID ,仅ModuleType 为 Baseline 时需要", "example": "[ { \"Name\": \"StrategyId\", \"Values\": [ \"1\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [ "ModuleType" ] }, { "name": "DescribeScanTaskDetails", "description": "DescribeScanTaskDetails 查询扫描任务详情 , 可以查询扫描进度信息/异常;", "status": "online", "parameters": [ { "name": "ModuleType", "type": "string", "required": true, "description": "模块类型 当前提供 Malware 木马 , Vul 漏洞 , Baseline 基线", "example": "Vul" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": "[ { \"Name\": \"Keyworkd\", \"Values\": [ \"busi\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [ "ModuleType", "TaskId" ] }, { "name": "DescribeScanTaskStatus", "description": "DescribeScanTaskStatus 查询机器扫描状态列表用于过滤筛选", "status": "online", "parameters": [ { "name": "ModuleType", "type": "string", "required": true, "description": "模块类型 当前提供 Malware 木马 , Vul 漏洞 , Baseline 基线", "example": "Malware" } ], "required": [ "ModuleType" ] }, { "name": "DescribeScanVulSetting", "description": "查询定期检测的配置", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScreenAttackHotspot", "description": "大屏可视化获取全网攻击热点", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScreenBroadcasts", "description": "大屏可视化安全播报", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScreenDefenseTrends", "description": "大屏可视化防趋势接口", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2021-03-30 19:17:28" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2021-03-30 19:17:28" } ], "required": [] }, { "name": "DescribeScreenEmergentMsg", "description": "大屏可视化紧急通知", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScreenEventsCnt", "description": "大屏可视化获取安全概览相关事件统计数据接口", "status": "online", "parameters": [ { "name": "BusinessType", "type": "integer", "required": false, "description": "数据类型：0:待处理风险总数 1:影响资产总数，默认为0", "example": "0" } ], "required": [] }, { "name": "DescribeScreenGeneralStat", "description": "大屏可视化获取主机相关统计", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScreenHostInvasion", "description": "大屏可视化主机入侵详情", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机quuid", "example": "e8f91530-02c7-3e98-d84d-26df60d981ef" } ], "required": [ "Quuid" ] }, { "name": "DescribeScreenMachineRegions", "description": "大屏可视化主机区域选项列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScreenMachines", "description": "大屏可视化主机区域列表", "status": "online", "parameters": [ { "name": "MachineRegion", "type": "string", "required": false, "description": "主机区域", "example": "ap-guangzhou" }, { "name": "MachineIpOrAlias", "type": "string", "required": false, "description": "IP 支持内网IP,主机别名", "example": "127.0.2.1" }, { "name": "SecurityStatus", "type": "integer", "required": false, "description": "风险状态类型：0：全部类型，1：风险主机，2：潜在风险主机 ， 3：已关机/离线主机，4：无风险主机", "example": "0" } ], "required": [] }, { "name": "DescribeScreenProtectionCnt", "description": "大屏可视化主机安全防护引擎介绍", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScreenProtectionStat", "description": "大屏获取安全防护状态", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScreenRiskAssetsTop", "description": "大屏可视化风险资产top5（今日），统计今日风险资产", "status": "online", "parameters": [ { "name": "BusinessType", "type": "integer", "required": true, "description": "统计类型：0:潜在威胁 1:失陷 2:漏洞 3:基线", "example": "1" } ], "required": [ "BusinessType" ] }, { "name": "DescribeSearchLogs", "description": "获取历史搜索记录", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSearchTemplates", "description": "获取快速检索列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" } ], "required": [] }, { "name": "DescribeSecurityBroadcastInfo", "description": "查询安全播报文章信息", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "文章id", "example": "1" } ], "required": [ "Id" ] }, { "name": "DescribeSecurityBroadcasts", "description": "安全播报列表页", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10 ，0=全部", "example": "10" }, { "name": "BeginDate", "type": "string", "required": false, "description": "筛选发布日期：开始时间", "example": "2021-03-30" }, { "name": "EndDate", "type": "string", "required": false, "description": "筛选发布日期：结束时间", "example": "2021-03-30" }, { "name": "BroadcastType", "type": "string", "required": false, "description": "过滤安全播报类型：0-紧急通知，1-功能更新，2-行业荣誉，3-版本发布，4-实践教程", "example": "0" } ], "required": [] }, { "name": "DescribeSecurityDynamics", "description": "本接口 (DescribeSecurityDynamics) 用于获取安全事件动态消息数据。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [] }, { "name": "DescribeSecurityEventStat", "description": "获取安全事件统计", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "该接口无过滤条件", "example": "[{ \"Name\": \"SecurityRisk\", \"Values\": [“HighLevelVul”], \"ExactMatch\": false }]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "DescribeSecurityEventsCnt", "description": "获取安全概览相关事件统计数据接口", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSecurityTrends", "description": "本接口 (DescribeSecurityTrends) 用于获取安全事件统计数据。", "status": "online", "parameters": [ { "name": "BeginDate", "type": "string", "required": true, "description": "开始时间，如：2021-07-10", "example": "2021-07-10" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束时间，如：2021-07-10", "example": "2021-09-10" } ], "required": [ "BeginDate", "EndDate" ] }, { "name": "DescribeServerRelatedDirInfo", "description": "查询服务区关联目录详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "唯一ID", "example": "1" } ], "required": [ "Id" ] }, { "name": "DescribeServersAndRiskAndFirstInfo", "description": "获取待处理风险文件数+影响服务器数+是否试用检测+最近检测时间", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeStrategyExist", "description": "根据策略名查询策略是否存在", "status": "online", "parameters": [ { "name": "StrategyName", "type": "string", "required": true, "description": "策略名", "example": "sname" } ], "required": [ "StrategyName" ] }, { "name": "DescribeTagMachines", "description": "获取指定标签关联的服务器信息", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "标签ID", "example": "1" } ], "required": [ "Id" ] }, { "name": "DescribeTags", "description": "获取所有主机标签", "status": "online", "parameters": [ { "name": "MachineType", "type": "string", "required": false, "description": "云主机类型。 CVM：表示云服务器 BM: 表示黑石物理机 ECM: 表示边缘计算服务器 LH: 表示轻量应用服务器 Other: 表示混合云服务器", "example": "CVM" }, { "name": "MachineRegion", "type": "string", "required": false, "description": "机器所属地域。如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 查询关键字(机器名称/机器IP Status - String - 是否必填：否 - 客户端在线状态（OFFLINE: 离线 | ONLINE: 在线 | UNINSTALLED：未安装 | SHUTDOWN 已关机） Version - String 是否必填：否 - 当前防护版本（ PRO_VERSION：专业版 | BASIC_VERSION：基础版） Risk - String 是否必填: 否 - 风险主机( yes ) Os -String 是否必填: 否 - 操作系统( DescribeMachineOsList 接口 值 ) 每个过\ufffd...", "example": "[{\"Name\": \"Risk\", \"Values\": [\"1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "DescribeTrialReport", "description": "查询主机安全授权试用报告(仅限控制台申领的)", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeUndoVulCounts", "description": "获取漏洞管理模块指定类型的待处理漏洞数、主机数和非专业版主机数量", "status": "online", "parameters": [ { "name": "VulCategory", "type": "integer", "required": false, "description": "漏洞分类，1: web-cms漏洞 2:应用漏洞 4: Linux软件漏洞 5: Windows系统漏洞", "example": "1" }, { "name": "IfEmergency", "type": "string", "required": false, "description": "是否应急漏洞筛选, 是 : yes", "example": "0" } ], "required": [] }, { "name": "DescribeUsersConfig", "description": "用于查询用户自定义配置", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": true, "description": "配置名称 license_monitor 授权监控配置 0 关闭, 1开启", "example": "license_mon" } ], "required": [ "ConfigName" ] }, { "name": "DescribeUsualLoginPlaces", "description": "此接口（DescribeUsualLoginPlaces）用于查询常用登录地。", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": true, "description": "主机安全客户端UUID", "example": "d1245804-b922-4c3b-8499-f95dce26b33c" } ], "required": [ "Uuid" ] }, { "name": "DescribeVdbAndPocInfo", "description": "获取病毒库及POC的更新信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVersionCompareChart", "description": "获取版本对比信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVersionStatistics", "description": "用于统计专业版和基础版机器数。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVertexDetail", "description": "获取指定点属性信息", "status": "online", "parameters": [ { "name": "VertexIds", "type": "array", "required": true, "description": "点id列表", "example": "[\"dd8c40c6737f75a0c24244d6f4fa6173\"]", "item_type": "string" }, { "name": "IncidentId", "type": "string", "required": true, "description": "事件id", "example": "468314cc-4004-492d-a974-7bf5666cb11b" }, { "name": "TableName", "type": "string", "required": true, "description": "事件所在表名", "example": "incidents_dwewd" } ], "required": [ "VertexIds", "IncidentId", "TableName" ] }, { "name": "DescribeVulCountByDates", "description": "漏洞管理模块，获取近日指定类型的漏洞数量和主机数量", "status": "online", "parameters": [ { "name": "LastDays", "type": "array", "required": false, "description": "需要查询最近几天的数据，需要都 -1后传入", "example": "[1]", "item_type": "integer" }, { "name": "VulCategory", "type": "integer", "required": false, "description": "漏洞的分类: 1: web-cms漏洞 2:应用漏洞 4: Linux软件漏洞 5: Windows系统漏洞", "example": "1" }, { "name": "IfEmergency", "type": "string", "required": false, "description": "是否为应急漏洞筛选 是: yes", "example": "0" } ], "required": [] }, { "name": "DescribeVulCveIdInfo", "description": "CveId查询漏洞详情", "status": "online", "parameters": [ { "name": "CveIds", "type": "array", "required": true, "description": "漏洞cve_id 列表", "example": "1", "item_type": "string" } ], "required": [ "CveIds" ] }, { "name": "DescribeVulDefenceEvent", "description": "获取漏洞防御事件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：Keywords: ip或者主机名, VulKeywords漏洞名或者CveId模糊查询; Quuid，VulId，EventType，Status精确匹配，CreateBeginTime，CreateEndTime时间段查询", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "数据限制", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序，大小写无关：asc 升序，desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序列，严格相等：CreateTime创建时间，MergeTime合并时间，Count事件数量", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeVulDefenceList", "description": "查询漏洞防御列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：Level、Keywords", "example": "[{ \"Name\": \"Keywords\", \"Values\": [“127.0.0.1”], \"ExactMatch\": false }]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移", "example": "12" }, { "name": "Limit", "type": "integer", "required": false, "description": "数据限制", "example": "20" }, { "name": "Order", "type": "string", "required": false, "description": "排序，大小写无关：asc 升序，desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序列，严格相等：PublishTime发布时间", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeVulDefenceOverview", "description": "获取漏洞防御概览信息，包括事件趋势及插件开启情况", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVulDefencePluginDetail", "description": "获取单台主机漏洞防御插件信息", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "d92d723e-4aac-4f4a-bbf9-e5430e29d289" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：Keywords: ip或者主机名,Exception，Status精确匹配", "example": "[ { \"Name\": \"Status\", \"Values\": [ \"1\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移", "example": "12" }, { "name": "Limit", "type": "integer", "required": false, "description": "数据限制", "example": "10" } ], "required": [ "Quuid" ] }, { "name": "DescribeVulDefencePluginExceptionCount", "description": "获取当前异常插件数", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVulDefencePluginStatus", "description": "获取各主机漏洞防御插件状态", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Keywords - String - 是否必填：否 - 主机ip或别名筛选 Exception - String - 是否必填：否 - 插件状态 0:正常,1:异常,2:无java进程注入", "example": "[ { \"Name\": \"Exception\", \"Values\": [ \"1\" ], \"ExactMatch\": false } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移", "example": "12" }, { "name": "Limit", "type": "integer", "required": false, "description": "数据限制", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序，大小写无关：asc 升序，desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序列，严格相等：CreateTime创建时间，ModifyTime更新时间", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeVulDefenceSetting", "description": "获取当前漏洞防御插件设置", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVulEffectHostList", "description": "漏洞影响主机列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页limit 最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页Offset", "example": "0" }, { "name": "VulId", "type": "integer", "required": true, "description": "漏洞id", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件： AliasName - String - 主机名筛选 TagIds - String - 主机标签id串，多个用英文用逗号分隔 Status - String - 状态：0-待处理 1-忽略 3-已修复 5-检测中 6-修复中 8-修复失败 Uuid - String数组 - Uuid串数组 Version - String数组 - 付费版本数组：\"Flagship\"-旗舰版 \"PRO_VERSION\"-专业版 \"BASIC_VERSION\"-基础版 InstanceState - String数组 - 实例状态数组：\"PENDING\"-创建中 \"LAUNCH_FAILED\"-创建失败 \"RUNNING\"-运行中 \"STOP...", "example": "[{\"Name\":\"AliasName\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [ "Limit", "Offset", "VulId" ] }, { "name": "DescribeVulEffectModules", "description": "漏洞影响组件列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页limit 最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页Offset", "example": "0" }, { "name": "VulId", "type": "integer", "required": true, "description": "漏洞id", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件： Uuid - String数组 - Uuid串数组", "example": "[{\"Name\":\"Uuid\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [ "Limit", "Offset", "VulId" ] }, { "name": "DescribeVulEmergentMsg", "description": "获取漏洞紧急通知", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVulFixStatus", "description": "漏洞修护-查找主机漏洞修护进度", "status": "online", "parameters": [ { "name": "FixId", "type": "integer", "required": false, "description": "任务id 传VulId可以不用传FixId", "example": "1" }, { "name": "VulId", "type": "integer", "required": false, "description": "漏洞id 传FixId可以不用传VulId", "example": "12" }, { "name": "Quuid", "type": "string", "required": false, "description": "主机quuid 和VulId 组合可查 某主机最近一次修复任务详情", "example": "05f0bcab-726c-4ea4-8109-bcd03d5598f7" }, { "name": "KbId", "type": "integer", "required": false, "description": "补丁 id", "example": "1" } ], "required": [] }, { "name": "DescribeVulHostCountScanTime", "description": "获取待处理漏洞数+影响主机数", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVulHostTop", "description": "获取服务器风险top列表", "status": "online", "parameters": [ { "name": "Top", "type": "integer", "required": true, "description": "获取top值，1-100", "example": "1" }, { "name": "VulCategory", "type": "integer", "required": false, "description": "1:web-cms 漏洞，2.应用漏洞 4: Linux软件漏洞 5: windows系统漏洞 6:应急漏洞，不填或者填0时返回 1，2，4，5 的总统计数据", "example": "2" }, { "name": "IsFollowVul", "type": "integer", "required": false, "description": "是否仅统计重点关注漏洞 1=仅统计重点关注漏洞, 0=统计全部漏洞", "example": "1" } ], "required": [ "Top" ] }, { "name": "DescribeVulInfoCvss", "description": "漏洞详情，带CVSS版本", "status": "online", "parameters": [ { "name": "VulId", "type": "integer", "required": true, "description": "漏洞id", "example": "1" }, { "name": "Source", "type": "string", "required": false, "description": "兼容应用防护漏洞防御容器视角告警里漏洞详情，默认是主机视角，可选字段，Source=tcss则为容器视角漏洞详情，后端会把VulId转为主机vul_vuls里的VulId", "example": "tcss" } ], "required": [ "VulId" ] }, { "name": "DescribeVulLabels", "description": "获取用户漏洞所有标签列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVulLevelCount", "description": "漏洞数量等级分布统计", "status": "online", "parameters": [ { "name": "VulCategory", "type": "integer", "required": false, "description": "1:web-cms 漏洞，2.应用漏洞 3:安全基线 4: Linux软件漏洞 5: windows系统漏洞 6:应急漏洞，不填或者填0时返回 1，2，4，5 的总统计数据", "example": "1" }, { "name": "IsFollowVul", "type": "integer", "required": false, "description": "是否仅统计重点关注漏洞 1=仅统计重点关注漏洞, 0=统计全部漏洞", "example": "1" } ], "required": [] }, { "name": "DescribeVulList", "description": "获取漏洞列表数据", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。Status - String - 是否必填：否 - 处理状态 0-待处理 1-已加白 2-已删除 3-已修复 5-检测中 6-修复中 8-修复失败ModifyTime - String - 是否必填：否 - 最近发生时间Uuid- String - 是否必填：否 - 主机uuid查询VulName- string -VulCategory- string - 是否必填：否 - 漏洞类别 1: web-cms漏洞 2:应用漏洞 4: Linux软件漏洞 5: Windows系统漏洞IsSupportDefense - int- 是否必填：否 - 是否支持防御 0:不支持 1:支持La...", "example": "[{\"ExactMatch\": true, \"Name\": \"VulCate****\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "By", "type": "string", "required": false, "description": "可选排序字段 Level，LastTime，HostCount", "example": "Level" }, { "name": "Order", "type": "string", "required": false, "description": "排序顺序：desc 默认asc", "example": "desc" } ], "required": [] }, { "name": "DescribeVulOverview", "description": "获取漏洞概览数据", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVulStoreList", "description": "获取漏洞库列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "VulName- string - 是否必填：否 - 漏洞名称 CveId- string - 是否必填：否 - cveid VulCategory- string - 是否必填：否 - 漏洞分类 1 Web-CMS漏洞 ,2 应用漏洞 ,4 Linux软件漏洞,5 Windows系统漏洞 Method- string - 是否必填：否 - 检测方法 0版本对比,1 poc检测 SupportDefense- string - 是否必填：否 - 是否支持防御 0不支持,1支持 FixSwitch- string - 是否必填：否 - 是否支持自动修复 0不支持,1支持", "example": "[ { \"Name\": \"VulName\", \"Values\": [ \"CVE-2023-46604\" ], \"ExactMatch\": true } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10,最大100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量,默认0", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [PublishDate]", "example": "PublishDate" } ], "required": [] }, { "name": "DescribeVulTop", "description": "漏洞top统计", "status": "online", "parameters": [ { "name": "Top", "type": "integer", "required": true, "description": "漏洞风险服务器top，1-100", "example": "1" }, { "name": "VulCategory", "type": "integer", "required": false, "description": "1:web-cms 漏洞，2.应用漏洞 4: Linux软件漏洞 5: windows系统漏洞 6:应急漏洞，不填或者填0时返回 1，2，4，5 的总统计数据", "example": "3" }, { "name": "IsFollowVul", "type": "integer", "required": false, "description": "是否仅统计重点关注漏洞 1=仅统计重点关注漏洞, 0=统计全部漏洞", "example": "1" } ], "required": [ "Top" ] }, { "name": "DescribeVulTrend", "description": "获取漏洞态势信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeWarningHostConfig", "description": "查询告警机器范围配置", "status": "online", "parameters": [ { "name": "Type", "type": "integer", "required": true, "description": "告警类型", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目, 0表示不分页", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0", "example": "0" } ], "required": [ "Type" ] }, { "name": "DescribeWarningList", "description": "获取当前用户告警列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeWebHookPolicy", "description": "查询告警策略", "status": "online", "parameters": [ { "name": "Filter", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "100" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 [asc:升序|desc:降序]", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段", "example": "Id" } ], "required": [] }, { "name": "DescribeWebHookReceiver", "description": "查询告警接收人列表", "status": "online", "parameters": [ { "name": "Filter", "type": "array", "required": false, "description": "过滤条件", "example": "[{\"ExactMatch\": false, \"Name\": \"Keywords\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "100" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 [asc:升序|desc:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段", "example": "field" } ], "required": [] }, { "name": "DescribeWebHookReceiverUsage", "description": "查询指定告警接收人的关联策略使用信息", "status": "online", "parameters": [ { "name": "List", "type": "array", "required": false, "description": "告警接收人列表", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "id", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "接收人名称", "example": "告警webhook" }, { "name": "Addr", "type": "string", "required": false, "description": "webhook地址", "example": "www.webhook.com" }, { "name": "Type", "type": "integer", "required": false, "description": "类型", "example": "0" }, { "name": "SCFRegion", "type": "string", "required": false, "description": "目标地域", "example": "ap-guangzhou" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "ns" }, { "name": "FunctionName", "type": "string", "required": false, "description": "函数名称", "example": "fn" }, { "name": "FunctionVersion", "type": "string", "required": false, "description": "版本", "example": "latest" }, { "name": "Alias", "type": "string", "required": false, "description": "别名", "example": "alias" } ] } ], "required": [] }, { "name": "DescribeWebHookRule", "description": "获取企微机器人规则详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "规则Id", "example": "1" } ], "required": [] }, { "name": "DescribeWebHookRules", "description": "获取企微机器人规则列表", "status": "online", "parameters": [ { "name": "Filter", "type": "array", "required": false, "description": "过滤条件", "example": "[{\"Name\":\"RuleName\",\"Values\":[\"机器人\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式 [asc:升序|desc:降序]", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段", "example": "CreateTime" } ], "required": [] }, { "name": "DescribeWebPageEventList", "description": "查询篡改事件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 EventType - String - 是否必填：否 - 事件类型 EventStatus - String - 是否必填：否 - 事件状态", "example": "[{\"Name\":\"IpOrAlias\",\"Values\":[\"机器人\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为10，最大值为100。", "example": "10" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：CreateTime 或 RestoreTime，默认为CreateTime", "example": "CreateTime" }, { "name": "Order", "type": "integer", "required": false, "description": "排序方式，0降序，1升序，默认为0", "example": "0" } ], "required": [] }, { "name": "DescribeWebPageGeneralize", "description": "查询网站防篡改概览信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeWebPageProtectStat", "description": "网站防篡改-查询动态防护信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeWebPageServiceInfo", "description": "网站防篡改-查询网页防篡改服务器购买信息及服务器信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeWindowsPatchList", "description": "获取补丁信息列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "分页参数", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序顺序：desc 默认asc", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "可选排序字段 PublishTime LastScanTime HostCount", "example": "HostCount" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Status : string类型 非必填 处理状态 0待处理,1忽略,3修复ShowNew : int类型 非必填 展示最新版本 1-开启 0-关闭Name : string类型 非必填 补丁名称KbNo : string类型 非必填 补丁编号VulName : string类型 非必填 漏洞名称CVEId : string类型 非必填 漏洞CVE编号Uuid : string类型 非必填 主机uuid", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "DestroyOrder", "description": "DestroyOrder 该接口可以对资源销毁.", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID", "example": "resource_id" }, { "name": "LicenseType", "type": "integer", "required": true, "description": "授权类型 0 专业版-按量计费, 1专业版-包年包月 , 2 旗舰版-包年包月", "example": "0" } ], "required": [ "ResourceId", "LicenseType" ] }, { "name": "EditBashRules", "description": "新增或修改高危命令规则", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "规则ID（新增时不填）", "example": "1" }, { "name": "Uuids", "type": "array", "required": false, "description": "客户端ID数组", "example": "05f0bcab-726c-4ea4-8109-bcd03d5598f7", "item_type": "string" }, { "name": "HostIp", "type": "string", "required": false, "description": "主机IP", "example": "1.1.1.1" }, { "name": "Name", "type": "string", "required": false, "description": "规则名称，编辑时不可修改规则名称", "example": "规则名称" }, { "name": "Level", "type": "integer", "required": false, "description": "危险等级(0:无，1: 高危 2:中危 3: 低危)", "example": "1" }, { "name": "Rule", "type": "string", "required": false, "description": "正则表达式 ，编辑时不可修改正则表达式，需要对内容QueryEscape后再base64", "example": "sh cmdline" }, { "name": "IsGlobal", "type": "integer", "required": false, "description": "是否全局规则(默认否)：1-全局，0-非全局", "example": "1" }, { "name": "White", "type": "integer", "required": false, "description": "0=黑名单， 1=白名单", "example": "1" }, { "name": "EventId", "type": "integer", "required": false, "description": "事件列表点击“加入白名单”时,需要传EventId 事件的id", "example": "10023" }, { "name": "DealOldEvents", "type": "integer", "required": false, "description": "是否处理旧事件为白名单 0=不处理 1=处理", "example": "1" }, { "name": "Descript", "type": "string", "required": false, "description": "策略描述", "example": "desc" }, { "name": "Status", "type": "integer", "required": false, "description": "生效与否 0:不生效 1:生效", "example": "1" }, { "name": "BashAction", "type": "integer", "required": false, "description": "0:告警 1:白名单 2:拦截", "example": "1" }, { "name": "Scope", "type": "integer", "required": false, "description": "生效范围（0:一组quuid 1:所有专业版 2:所有专业版+旗舰版 3:所有主机）", "example": "1" }, { "name": "Quuids", "type": "array", "required": false, "description": "生效主机的QUUID集合", "example": "[\"05f0bcab-726c-4ea4-8109-bcd03d5598f7\"]", "item_type": "string" } ], "required": [] }, { "name": "EditPrivilegeRules", "description": "新增或修改本地提权规则（支持多服务器选择）", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "规则ID(新增时请留空)", "example": "1" }, { "name": "Uuids", "type": "array", "required": false, "description": "客户端ID数组", "example": "[\"d99a1b46-cc2d-4633-a11f-4a7663d25***\"]", "item_type": "string" }, { "name": "HostIp", "type": "string", "required": false, "description": "主机IP", "example": "10.0.0.1" }, { "name": "ProcessName", "type": "string", "required": false, "description": "进程名", "example": "yaxtest****" }, { "name": "SMode", "type": "integer", "required": false, "description": "是否S权限进程", "example": "1" }, { "name": "IsGlobal", "type": "integer", "required": false, "description": "是否全局规则(默认否)", "example": "1" }, { "name": "EventId", "type": "integer", "required": false, "description": "事件列表和详情点击加白时关联的事件id (新增规则时请留空)", "example": "1" } ], "required": [] }, { "name": "EditReverseShellRules", "description": "编辑反弹Shell规则（支持多服务器选择）", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "规则ID(新增时请留空)", "example": "1" }, { "name": "Uuids", "type": "array", "required": false, "description": "客户端ID数组", "example": "[\"d99a1b46-cc2d-4633-a11f-4a7663d25\"]", "item_type": "string" }, { "name": "HostIp", "type": "string", "required": false, "description": "主机IP", "example": "10.0.1.92" }, { "name": "DestIp", "type": "string", "required": false, "description": "目标IP", "example": "1.2.3.4" }, { "name": "DestPort", "type": "string", "required": false, "description": "目标端口", "example": "80" }, { "name": "ProcessName", "type": "string", "required": false, "description": "进程名", "example": "/bin/api_****" }, { "name": "IsGlobal", "type": "integer", "required": false, "description": "是否全局规则(默认否)", "example": "1" }, { "name": "EventId", "type": "integer", "required": false, "description": "事件列表和详情点击加白时关联的事件id (新增规则时请留空)", "example": "10001" } ], "required": [] }, { "name": "EditTags", "description": "新增或编辑标签", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "标签名", "example": "tag-name" }, { "name": "Id", "type": "integer", "required": false, "description": "标签ID", "example": "1" }, { "name": "Quuids", "type": "array", "required": false, "description": "Quuid", "example": "[\"dd90a245-ca7a-4268-9051-1fce4291****\"]", "item_type": "string" } ], "required": [ "Name" ] }, { "name": "ExportAssetAppList", "description": "导出资产管理应用列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。AppName- string - 是否必填：否 - 应用名搜索IP - String - 是否必填：否 - 主机ipMachineName - String - 是否必填：否 - 主机名称InstanceID - string - 是否必填：否 - 实例IDType - int - 是否必填：否 - 类型 : 仅linux0: 全部1: 运维2 : 数据库3 : 安全4 : 可疑应用5 : 系统架构6 : 系统应用7 : WEB服务99:其他OsType - uint64 - 是否必填：否 - Windows/Linux", "example": "[{\"Name\":\"InstanceID\",\"Values\":[\"ins-shdn**\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime|ProcessCount]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetCoreModuleList", "description": "导出资产管理内核模块列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name- string - 是否必填：否 - 包名 User- string - 是否必填：否 - 用户名", "example": "[{\"Name\":\"InstanceID\",\"Values\":[\"ins-shdn**\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序依据[FirstTime|Size|ProcessCount|ModuleCount]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetDatabaseList", "description": "导出资产管理数据库列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 User- string - 是否必填：否 - 运行用户 Ip - String - 是否必填：否 - 绑定IP Port - Int - 是否必填：否 - 端口 Name - Int - 是否必填：否 - 数据库名称 0:全部 1:MySQL 2:Redis 3:Oracle 4:MongoDB 5:MemCache 6:PostgreSQL 7:HBase 8:DB2 9:Sybase 10:TiDB Proto - String - 是否必填：否 - 协议：1:TCP, 2:UDP, 3:未知 OsType - String - 是否必填：否 - 操作系统: linux/windows", "example": "[{\"Name\":\"InstanceID\",\"Values\":[\"ins-shdn**\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetEnvList", "description": "导出资产管理环境变量列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name- string - 是否必填：否 - 环境变量名 Type- int - 是否必填：否 - 类型：0用户变量，1系统变量", "example": "[{\"Name\":\"InstanceID\",\"Values\":[\"ins-shdn**\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetInitServiceList", "description": "导出资产管理启动服务列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name- string - 是否必填：否 - 包名 User- string - 是否必填：否 - 用户 Status- string - 是否必填：否 - 默认启用状态：0未启用， 1启用 仅linux Type- string - 是否必填：否 - 类型：类型 仅windows： 1:编码器 2:IE插件 3:网络提供者 4:镜像劫持 5:LSA提供者 6:KnownDLLs 7:启动执行 8:WMI 9:计划任务 10:Winsock提供者 11:打印监控器 12:资源管理器 13:驱动服务 14:登录", "example": "[{\"ExactMatch\": true, \"Name\": \"xx\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetJarList", "description": "导出Jar包列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name- string - 是否必填：否 - 包名 Type- uint - 是否必填：否 - 类型 1: 应用程序 2 : 系统类库 3 : Web服务自带库 4 : 其他依赖包 Status- string - 是否必填：否 - 是否可执行：0否，1是", "example": "ExportAssetJarList", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetMachineDetail", "description": "导出资产管理主机资源详细信息", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "服务器Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "Uuid", "type": "string", "required": true, "description": "服务器Uuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" } ], "required": [ "Quuid", "Uuid" ] }, { "name": "ExportAssetMachineList", "description": "导出资源监控列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID OsType - String - 是否必填：否 - windows或linux CpuLoad - Int - 是否必填：否 - 0: 0%或未知 1: 0%～20% 2: 20%～50% 3: 50%～80% 4: 80%～100% DiskLoad - Int - 是否必填：否 - 0: 0%或未知 1: 0%～20% 2: 20%～50% 3: 50%～80% 4: 80%～100% MemLoad - Int - 是否必填：否 - 0: 0%或未知 1: 0%～20% 2: ...", "example": "ExportAssetMachineList", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "可选排序[FirstTime|PartitionCount]", "example": "PartitionCount" } ], "required": [] }, { "name": "ExportAssetPlanTaskList", "description": "导出资产管理计划任务列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "服务器Uuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Quuid", "type": "string", "required": false, "description": "服务器Quuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 User- string - 是否必填：否 - 用户 Status- int - 是否必填：否 - 默认启用状态：0未启用， 1启用", "example": "ExportAssetPlanTaskList", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetPortInfoList", "description": "导出资产管理端口列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "977205b6-0ebe-4149-97df-89f65322e75c" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Port - uint64 - 是否必填：否 - 端口 Ip - String - 是否必填：否 - 绑定IP ProcessName - String - 是否必填：否 - 监听进程 Pid - uint64 - 是否必填：否 - PID User - String - 是否必填：否 - 运行用户 Group - String - 是否必填：否 - 所属用户组 Ppid - uint64 - 是否必填：否 - PPID Proto - string - 是否必填：否 - tcp/udp或“”(空字符串筛选未知状态) OsType - uint64 - 是否必填：否 - windows/linux RunTimeStart ...", "example": "[{\"Name\":\"InstanceID\",\"Values\":[\"ins-shdn**\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime|StartTime]", "example": "StartTime" } ], "required": [] }, { "name": "ExportAssetProcessInfoList", "description": "导出资产管理进程列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name - String - 是否必填：否 - 进程名 User - String - 是否必填：否 - 进程用户 Group - String - 是否必填：否 - 进程用户组 Pid - uint64 - 是否必填：否 - 进程ID Ppid - uint64 - 是否必填：否 - 父进程ID OsType - uint64 - 是否必填：否 - windows/linux Status - string - 是否必填：否 - 进程状态： 0:全部 1:R 可执行 2:S 可中断 3:不可中断 RunTimeStart - String - 是否必填：否 - 运行开始时间 RunTimeEnd - St...", "example": "[{\"Name\":\"Name\",\"Values\":[\"sh\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式：[FirstTime|StartTime]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetRecentMachineInfo", "description": "导出主机最近趋势情况（最长最近90天）", "status": "online", "parameters": [ { "name": "BeginDate", "type": "string", "required": true, "description": "开始时间。", "example": "2020-10-10" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束时间。", "example": "2020-10-20" } ], "required": [ "BeginDate", "EndDate" ] }, { "name": "ExportAssetSystemPackageList", "description": "导出资产管理系统安装包列表", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": false, "description": "主机Uuid", "example": "1" }, { "name": "Quuid", "type": "string", "required": false, "description": "主机Quuid", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name - String - 是否必填：否 - 包 名 StartTime - String - 是否必填：否 - 安装开始时间 EndTime - String - 是否必填：否 - 安装开始时间 Type - int - 是否必填：否 - 安装包类型： 1:rpm 2:dpkg 3:java 4:system", "example": "[ { \"Name\": \"TaskId\", \"Value\": [ \"10001\" ] } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "desc" }, { "name": "By", "type": "string", "required": false, "description": "排序方式可选：[FistTime|InstallTime:安装时间]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetUserList", "description": "导出账号列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。Name - String - 是否必填：否 - 账户名 Uid - uint64 - 是否必填：否 - UidGuid - uint64 - 是否必填：否 - Guid LoginTimeStart - String - 是否必填：否 - 开始时间，如：2021-01-11LoginTimeEnd - String - 是否必填：否 - 结束时间，如：2021-01-11 LoginType - uint64 - 是否必填：否 - 0-不可登录；1-只允许key登录；2只允许密码登录；3-允许key和密码 仅linux OsType - String - 是否必填：否 - windows或linuxStatus - ui...", "example": "1", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|LoginTime|ChangePasswordTime|PasswordDuaTime] PasswordLockDays", "example": "1" } ], "required": [] }, { "name": "ExportAssetWebAppList", "description": "导出资产管理Web应用列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "69E78F7F-FFC7-47D1-B406-13C9852******" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name - String - 是否必填：否 - 应用名 Domain - String - 是否必填：否 - 站点域名 Type - int - 是否必填：否 - 服务类型： 0：全部 1:Tomcat 2:Apache 3:Nginx 4:WebLogic 5:Websphere 6:JBoss 7:Jetty 8:IHS 9:Tengine OsType - String - 是否必填：否 - windows/linux", "example": "[{\"Name\":\"Name\",\"Values\":[\"php\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "1" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|PluginCount]", "example": "1" } ], "required": [] }, { "name": "ExportAssetWebFrameList", "description": "导出资产管理Web框架列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "b495b6bb-ada7-2f99-868a-5d29af2bc8df" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name - String - 是否必填：否 - 框架名 Lang - String - 是否必填：否 - 框架语言:java/python Type - String - 是否必填：否 - 服务类型： 0：全部 1:Tomcat 2:Apache 3:Nginx 4:WebLogic 5:Websphere 6:JBoss 7:WildFly 8:Jetty 9:IHS 10:Tengine OsType - String - 是否必填：否 - windows/linux", "example": "[{\"Name\":\"Name\",\"Values\":[\"think\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|JarCount]", "example": "FirstTime" } ], "required": [] }, { "name": "ExportAssetWebLocationList", "description": "导出Web站点列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "69E78F7F-FFC7-47D1-B406-13C9852******" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Name - String - 是否必填：否 - 域名 User - String - 是否必填：否 - 运行用户 Port - uint64 - 是否必填：否 - 站点端口 Proto - uint64 - 是否必填：否 - 站点协议：1:HTTP,2:HTTPS ServiceType - uint64 - 是否必填：否 - 服务类型： 1:Tomcat 2：Apache 3:Nginx 4:WebLogic 5:Websphere 6:JBoss 7:WildFly 8:Jetty 9:IHS 10:Tengine OsType - String - 是否必填：否 - windows/linux", "example": "[{\"Name\":\"Name\",\"Values\":[\"www.tencent.com\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "1" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|PathCount]", "example": "PathCount" } ], "required": [] }, { "name": "ExportAssetWebServiceInfoList", "description": "导出资产管理Web服务列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": false, "description": "查询指定Quuid主机的信息", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 User- string - 是否必填：否 - 运行用户 Name- string - 是否必填：否 - Web服务名： 1:Tomcat 2:Apache 3:Nginx 4:WebLogic 5:Websphere 6:JBoss 7:WildFly 8:Jetty 9:IHS 10:Tengine OsType- string - 是否必填：否 - Windows/linux", "example": "[{\"Name\":\"Name\",\"Values\":[\"Tomcat\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，asc升序 或 desc降序", "example": "1" }, { "name": "By", "type": "string", "required": false, "description": "可选排序：[FirstTime|ProcessCount]", "example": "1" } ], "required": [] }, { "name": "ExportAttackEvents", "description": "导出网络攻击事件", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤参数。 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 FilePath - String - 是否必填：否 - 路径筛选 VirusName - String - 是否必填：否 - 描述筛选 CreateBeginTime - String - 是否必填：否 - 创建时间筛选-开始时间 CreateEndTime - String - 是否必填：否 - 创建时间筛选-结束时间 Status - String - 是否必填：否 - 状态筛选", "example": "[{\"ExactMatch\": true, \"Name\": \"Status\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "By", "type": "string", "required": false, "description": "排序值 CreateTime", "example": "CreateTime" }, { "name": "Order", "type": "string", "required": false, "description": "排序 方式 ，ASC，DESC", "example": "ASC" } ], "required": [] }, { "name": "ExportBaselineEffectHostList", "description": "导出基线影响主机列表", "status": "online", "parameters": [ { "name": "BaselineId", "type": "integer", "required": true, "description": "基线id", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "筛选条件 AliasName- String- 主机别名", "example": "[{\"Name\":\"AliasName\",\"Values\":[\"机器别名\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "StrategyId", "type": "integer", "required": false, "description": "策略id", "example": "2" }, { "name": "UuidList", "type": "array", "required": false, "description": "主机uuid数组", "example": "[\"1ce68339-8828-457f-b358-d5b1b34e4fe9\"]", "item_type": "string" }, { "name": "BaselineName", "type": "string", "required": false, "description": "基线名称", "example": "name1" } ], "required": [ "BaselineId" ] }, { "name": "ExportBaselineFixList", "description": "导出修复列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "ItemName - String - 是否必填：否 - 项名称", "example": "[{\"Name\":\"ItemName\",\"Values\":[\"value\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "ExportAll", "type": "integer", "required": false, "description": "0:过滤的结果导出；1:全部导出", "example": "1" } ], "required": [] }, { "name": "ExportBaselineHostDetectList", "description": "导出基线主机检测", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "HostTag - string - 是否必填：否 - 主机标签ItemId - int64 - 是否必填：否 - 项IdRuleId - int64 - 是否必填：否 - 规则IdIsPassed - int - 是否必填：否 - 是否通过RiskTier - int - 是否必填：否 - 风险等级", "example": "[{ \"Name\": \"HostTag\", \"Values\": [“tag”], \"ExactMatch\": false }]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "ExportAll", "type": "integer", "required": false, "description": "0:过滤的结果导出；1:全部导出", "example": "1" }, { "name": "IsExportDetail", "type": "integer", "required": false, "description": "0:导出界面展示；1:导出全部结果事件", "example": "0" } ], "required": [] }, { "name": "ExportBaselineItemDetectList", "description": "导出基线检测项", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "HostId - string - 是否必填：否 - 主机IdRuleId - int64 - 是否必填：否 - 规则IdIsPassed - int - 是否必填：否 - 是否通过RiskTier - int - 是否必填：否 - 风险等级", "example": "[{ \"Name\": \"HostId\", \"Values\": [“uu-a8”], \"ExactMatch\": false }]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "ExportAll", "type": "integer", "required": false, "description": "0:过滤的结果导出；1:全部导出", "example": "1" }, { "name": "IsExportDetail", "type": "integer", "required": false, "description": "0:导出界面展示；1:导出全部结果事件", "example": "1" } ], "required": [] }, { "name": "ExportBaselineItemList", "description": "导出检测项结果列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "PolicyId - int64 - 是否必填：否 - 策略Id RuleId - int64 - 是否必填：否 - 规则Id HostId - string - 是否必填：否 - 主机Id HostName - string - 是否必填：否 - 主机名 HostIp - string - 是否必填：否 - 主机IP ItemId - String - 是否必填：否 - 检测项Id ItemName - String - 是否必填：否 - 项名称 DetectStatus - int - 是否必填：否 - 检测状态[0:未通过|3:通过|5:检测中] Level - int - 是否必填：否 - 风险等级 StartTime - string...", "example": "[{\"ExactMatch\": true, \"Name\": \"HostId\", \"Values\": [\"aa4ff585-3791-4541-8ca3-f2409053****\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "ExportAll", "type": "integer", "required": false, "description": "0:过滤的结果导出；1:全部导出", "example": "1" } ], "required": [] }, { "name": "ExportBaselineList", "description": "导出基线列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件： StrategyId- Uint64 - 基线策略id Status - Uint64 - 事件状态：0-未通过，1-忽略，3-通过，5-检测中 BaselineName - String - 基线名称 AliasName- String - 服务器名称/服务器ip Uuid- String - 主机uuid", "example": "[ { \"Name\": \"TaskId\", \"Value\": [ \"10001\" ] } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "IfDetail", "type": "integer", "required": false, "description": "已废弃", "example": "1" } ], "required": [] }, { "name": "ExportBaselineRuleDetectList", "description": "导出基线检测规则", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "RuleName - string - 是否必填：否 - 规则名称IsPassed - int - 是否必填：否 - 是否通过RiskTier - int - 是否必填：否 - 风险等级", "example": "[{\"Name\": \"RuleId\", \"Values\": [\"name1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "ExportAll", "type": "integer", "required": false, "description": "0:过滤的结果导出；1:全部导出", "example": "1" }, { "name": "IsExportDetail", "type": "integer", "required": false, "description": "0:导出界面展示；1:导出全部结果事件", "example": "1" } ], "required": [] }, { "name": "ExportBaselineWeakPasswordList", "description": "导出弱口令配置列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "WeakPassword - string - 是否必填：否 - 弱口令", "example": "[{\"Name\":\"WeakPassword\",\"Values\":[\"value\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "ExportAll", "type": "integer", "required": false, "description": "0:过滤的结果导出；1:全部导出", "example": "0" } ], "required": [] }, { "name": "ExportBashEvents", "description": "导出高危命令事件", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": " [ { \"Name\": \"TaskId\", \"Value\": [ \"10001\" ] } ] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "ExportBashEventsNew", "description": "导出高危命令事件(新)", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": "[{\"ExactMatch\": true, \"Name\": \"RuleL****\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "ExportBashPolicies", "description": "导出高危命令策略", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": "[{\"Name\":\"Name\",\"Values\":[\"value\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "ExportBruteAttacks", "description": "本接口 (ExportBruteAttacks) 用于导出密码破解记录成CSV文件。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": " [ { \"Name\": \"TaskId\", \"Value\": [ \"10001\" ] } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "ExportFileTamperEvents", "description": "导出核心文件事件", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Status - String - 是否必填：否 - 处理状态 0 -- 待处理 1 -- 已加白 2 -- 已删除 3 - 已忽略 ModifyTime - String - 是否必填：否 - 最近发生时间 Uuid- String - 是否必填：否 - 主机uuid查询 RuleCategory- string - 是否必填：否 - 规则类别 0 系统规则 1 自定义规则", "example": "[{\"Name\":\"Status\",\"Values\":[\"1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Where", "type": "array", "required": false, "description": "需要导出的字段", "example": "[\"fieldA\",\"fieldB\"]\t", "item_type": "string" } ], "required": [] }, { "name": "ExportFileTamperRules", "description": "导出核心文件监控规则", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 RuleCategory- string- 规则类别 0=系统规则，1=用户规则 Name- String - 规则名称", "example": "[{\"ExactMatch\": true, \"Name\": \"Level\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "ExportIgnoreBaselineRule", "description": "导出已忽略基线检测项信息", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": false, "description": "检测项名称", "example": "tetname" } ], "required": [] }, { "name": "ExportIgnoreRuleEffectHostList", "description": "根据检测项id导出忽略检测项影响主机列表", "status": "online", "parameters": [ { "name": "RuleId", "type": "integer", "required": true, "description": "检测项id", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 AliasName- String- 主机别名", "example": "[{\"Name\":\"AliasName\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [ "RuleId" ] }, { "name": "ExportJavaMemShellPlugins", "description": "导出java内存马插件信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：Keywords: ip或者主机名模糊查询, Pid精确匹配，MainClass模糊匹配", "example": "[{\"Name\": \"Keywords\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Where", "type": "array", "required": false, "description": "导出字段", "example": "[\"HostIp\"]", "item_type": "string" } ], "required": [] }, { "name": "ExportJavaMemShells", "description": "导出java内存马事件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：InstanceID、IP、 MachineName主机名模糊查询, Type，Status精确匹配，CreateBeginTime，CreateEndTime时间段", "example": "[{\"ExactMatch\": false, \"Name\": \"Status\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Where", "type": "array", "required": false, "description": "导出字段", "example": "[\"HostIp\"]", "item_type": "string" }, { "name": "Order", "type": "string", "required": false, "description": "排序，大小写无关：asc 升序，desc降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序列，严格相等：最近检测时间RecentFoundTime", "example": "RecentFoundTime" } ], "required": [] }, { "name": "ExportLicenseDetail", "description": "导出授权列表对应的绑定信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "多个条件筛选时 LicenseStatus,DeadlineStatus,ResourceId,Keywords 取交集 LicenseType 授权类型, 0 专业版-按量计费, 1专业版-包年包月 , 2 旗舰版-包年包月 ResourceId 资源ID", "example": "[{\"Keywords\":[\"CVE\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "IsHistory", "type": "boolean", "required": false, "description": "是否导出全部授权详情", "example": "false" }, { "name": "Tags", "type": "array", "required": false, "description": "标签筛选,平台标签能力,这里传入 标签键,标签值作为一个对象", "example": "[{\"TagKey\":\"TagKey\",\"TagValue\":\"TagValue\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "business1" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "businessValue" } ] }, { "name": "ExportMonth", "type": "string", "required": false, "description": "导出月份, 该参数仅在IsHistory 时可选.", "example": "2022-03" } ], "required": [] }, { "name": "ExportMaliciousRequests", "description": "本接口 (ExportMaliciousRequests) 用于导出下载恶意请求文件。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": "[{\"Name\": \"Quuid\",\"Values\": [\"d4cc302e-09e5-436f-b99b-5ab9c9070323\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "ExportMalwares", "description": "本接口 (ExportMalwares) 用于导出木马记录CSV文件。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "限制条数,默认10", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量 默认0", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数。 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 FilePath - String - 是否必填：否 - 路径筛选 VirusName - String - 是否必填：否 - 描述筛选 CreateBeginTime - String - 是否必填：否 - 创建时间筛选-开始时间 CreateEndTime - String - 是否必填：否 - 创建时间筛选-结束时间 Status - String - 是否必填：否 - 状态筛选", "example": "[{\"FilePath\":[\"CVE\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "By", "type": "string", "required": false, "description": "排序值 CreateTime", "example": "CreateTime" }, { "name": "Order", "type": "string", "required": false, "description": "排序 方式 ，ASC，DESC", "example": "ASC" } ], "required": [] }, { "name": "ExportNonlocalLoginPlaces", "description": "本接口 (ExportNonlocalLoginPlaces) 用于导出异地登录事件记录CSV文件。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "Status - int - 是否必填：否 - 状态筛选1:正常登录；2：异地登录", "example": " [{\"Name\": \"Status\",\"Values\": [\"1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "ExportPatchEffectHostList", "description": "导出补丁影响主机列表", "status": "online", "parameters": [ { "name": "KbId", "type": "integer", "required": true, "description": "补丁id", "example": "244545456" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件： ProtectType : uint64类型 非必填 防护版本类型 0表示BASIC_VERSION，1表示Flagship InstanceState : string类型 非必填 主机状态 : \"PENDING\"-创建中 \"LAUNCH_FAILED\"-创建失败 \"RUNNING\"-运行中 \"STOPPED\"-关机 \"STARTING\"-开机中 \"STOPPING\"-关机中 \"REBOOTING\"-重启中 \"SHUTDOWN\"-待销毁 \"TERMINATING\"-销毁中 \"UNKNOWN\"-未知（针对非腾讯云机器，且客户端离线的场景） Status : uint64类型 非必填 处理状态 0表示待处理\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [ "KbId" ] }, { "name": "ExportPrivilegeEvents", "description": "导出本地提权事件", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": "[{\"ExactMatch\": false, \"Name\": \"Status\", \"Values\": [\"1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "ExportProtectDirList", "description": "导出网页防篡改防护目录列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "DirName 网站名称 DirPath 网站防护目录地址", "example": "[{\"DirName\":[\"CVE\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "Order", "type": "string", "required": false, "description": "asc：升序/desc：降序", "example": "asc" }, { "name": "By", "type": "string", "required": false, "description": "排序字段", "example": "ProtectServerNum" } ], "required": [] }, { "name": "ExportRansomDefenseBackupList", "description": "导出主机快照备份列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "935e27b1-d675-4509-80bf-96fbf0764237" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Status - Int - 是否必填：否 - 通过勒索状态查询：0未勒索，1已勒索 CreateTimeBegin - string - 是否必填：否 - 创建时间开始 CreateTimeEnd - string - 是否必填：否 - 创建时间结束", "example": "[{\"ExactMatch\": true, \"Name\": \"\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime", "example": "CreateTime" } ], "required": [ "Quuid" ] }, { "name": "ExportRansomDefenseEventsList", "description": "导出防勒索事件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 HostName- string- 主机名称 Status - Uint64 - 0待处理，1已处理，2已信任 HostIp- String - 主机ip", "example": "[{\"ExactMatch\": true, \"Name\": \"\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime", "example": "CreateTime" } ], "required": [] }, { "name": "ExportRansomDefenseMachineList", "description": "导出备份详情列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Ips - String - 是否必填：否 - 通过ip查询 MachineNames - String - 是否必填：否 - 通过实例名查询 Names - String - 是否必填：否 - 通过实例名查询 Status - String - 是否必填：否 - 策略状态：0备份中，1备份成功，2备份失败 LastBackupTimeBegin - String - 是否必填：否 - 最近一次备份时间开始 LastBackupTimeEnd - String - 是否必填：否 - 最近一次备份时间结束", "example": "[{\"MachineNames\":[\"CVE\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime、MachineCount", "example": "CreateTime" } ], "required": [] }, { "name": "ExportRansomDefenseStrategyList", "description": "导出防勒索策略列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Ips - String - 是否必填：否 - 通过ip查询 MachineNames - String - 是否必填：否 - 通过实例名查询 Names - String - 是否必填：否 - 通过实例名查询 Dirs - String - 是否必填：否 - 诱饵目录 Status - String - 是否必填：否 - 策略状态：0关闭，1开启 BackupType - String - 是否必填：否 - 备份模式：0-按周;1-按天", "example": "[{\"ExactMatch\": true, \"Name\": \"Backup****\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime、MachineCount", "example": "CreateTime" } ], "required": [] }, { "name": "ExportRansomDefenseStrategyMachines", "description": "导出勒索防御策略绑定机器列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Ips - String - 是否必填：否 - 通过ip查询 MachineNames - String - 是否必填：否 - 通过实例名查询 Names - String - 是否必填：否 - 通过实例名查询 Status - String - 是否必填：否 - 策略状态：0备份中，1备份成功，2备份失败 LastBackupTimeBegin - String - 是否必填：否 - 最近一次备份时间开始 LastBackupTimeEnd - String - 是否必填：否 - 最近一次备份时间结束", "example": "[{\"ExactMatch\": true, \"Name\": \"\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方法 ASC DESC", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段支持CreateTime、MachineCount", "example": "CreateTime" }, { "name": "Id", "type": "integer", "required": false, "description": "策略id", "example": "12" } ], "required": [] }, { "name": "ExportReverseShellEvents", "description": "导出反弹Shell事件", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": "[{\"Name\": \"Quuid\",\"Values\": [\"d4cc302e-09e5-436f-b99b-5ab9c9070323\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [] }, { "name": "ExportRiskDnsEventList", "description": "导出恶意请求事件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "MachineName 主机名称 InstanceID 实例ID IP 内网IP或公网IP - 是否必填：否 - 主机Ip或别名筛选 HostId - String - 是否必填：否 - 主机Id AgentId - String - 是否必填：否 - 客户端Id PolicyType - String - 是否必填：否 - 策略类型,0:系统策略1:用户自定义策略 Domain - String - 是否必填：否 - 域名(先对域名做urlencode,再base64) HandleStatus - String - 是否必填：否 - 状态筛选0:待处理；2:信任；3:不信任 BeginTime - Str...", "example": "[{\"MachineName\":[\"CVE\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：[ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "排序字段：[AccessCount:请求次数|LastTime:最近请求时间]", "example": "AccessCount" } ], "required": [] }, { "name": "ExportRiskDnsPolicyList", "description": "导出恶意请求策略列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "PolicyType - int - 是否必填：否 - 策略类型 PolicyName - string - 是否必填：否 - 策略名称 Domain - string - 是否必填：否 - 域名(先对域名做urlencode,再base64) PolicyAction- int - 是否必填：否 - 策略动作 IsEnabled - int - 是否必填：否 - 是否生效", "example": "[{\"PolicyName\":[\"CVE\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式: [ASC:升序|DESC:降序]", "example": "DESC" }, { "name": "By", "type": "string", "required": false, "description": "可选排序列: [PolicyName|HostType]", "example": "PolicyName" } ], "required": [] }, { "name": "ExportRiskProcessEvents", "description": "导出异常进程事件", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 HostId - String - 是否必填：否 - 主机ID IpOrName - String - 是否必填：否 - 主机IP或主机名 VirusName - String - 是否必填：否 - 病毒名 ProcessId - String - 是否必填：否 - 进程ID ProcessPath - String - 是否必填：否 - 进程路径 BeginTime - String - 是否必填：否 - 进程启动时间-开始 EndTime - String - 是否必填：否 - 进程启动时间-结束 Status - String - 是否必填：否 - 状态筛选 0待处理；1查杀中；2\ufffd...", "example": "[{ \"Name\": \"HostId\", \"Values\": [\"hosted\"], \"ExactMatch\": false}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Order", "type": "string", "required": false, "description": "排序方式：[ASC:升序|DESC:降序]", "example": "ASC" }, { "name": "By", "type": "string", "required": false, "description": "[StartTime:进程启动时间|DetectTime:最后检测时间]", "example": "StartTime" } ], "required": [] }, { "name": "ExportScanTaskDetails", "description": "根据任务id导出指定扫描任务详情", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "本次检测的任务id（不同于出参的导出本次检测Excel的任务Id）", "example": "1596595610" }, { "name": "ModuleType", "type": "string", "required": true, "description": "模块类型，当前提供：Malware 木马 , Vul 漏洞 , Baseline 基线", "example": "Malware " }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数：ipOrAlias（服务器名/ip）", "example": "[{\"Name\":\"ipOrAlias\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] } ], "required": [ "TaskId", "ModuleType" ] }, { "name": "ExportSecurityTrends", "description": "导出风险趋势", "status": "online", "parameters": [ { "name": "BeginDate", "type": "string", "required": true, "description": "开始时间。", "example": "2020-06-01" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束时间。", "example": "2020-06-02" } ], "required": [ "BeginDate", "EndDate" ] }, { "name": "ExportTasks", "description": "用于异步导出数据量大的日志文件", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID", "example": "24563" } ], "required": [ "TaskId" ] }, { "name": "ExportVulDefenceEvent", "description": "导出漏洞防御事件", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：Keywords: ip或者主机名, VulKeywords漏洞名或者CveId模糊查询; Quuid，VulId，EventType，Status精确匹配，CreateBeginTime，CreateEndTime时间段查询", "example": "[{\"Name\":\"Status\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Where", "type": "array", "required": false, "description": "导出字段，默认全导出", "example": "[\"fieldA\",\"fieldB\"]\t", "item_type": "string" } ], "required": [] }, { "name": "ExportVulDefenceList", "description": "导出漏洞防御列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件：Keywords: 漏洞名称或CVE编号模糊匹配, Level精确匹配", "example": "[{\"Name\":\"Status\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Where", "type": "array", "required": false, "description": "导出字段，默认全导出", "example": "[\"fieldA\",\"fieldB\"]\t", "item_type": "string" } ], "required": [] }, { "name": "ExportVulDefencePluginEvent", "description": "导出漏洞防御插件事件", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "Keywords: ip或者主机名模糊匹配，Quuid，Exception、Status精确匹配", "example": "[{\"Name\":\"Status\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "Where", "type": "array", "required": false, "description": "导出字段，默认全导出", "example": "[\"fieldA\",\"fieldB\"]", "item_type": "string" } ], "required": [] }, { "name": "ExportVulDetectionExcel", "description": "导出本次漏洞检测Excel", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "本次漏洞检测任务id（不同于出参的导出本次漏洞检测Excel的任务Id）", "example": "1596595610" } ], "required": [ "TaskId" ] }, { "name": "ExportVulDetectionReport", "description": "导出漏洞检测报告。", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "漏洞扫描任务id（不同于出参的导出检测报告的任务Id）", "example": "1596595610" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数", "example": "[{\"Name\":\"Status\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "需要返回的数量，默认为10，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [ "TaskId" ] }, { "name": "ExportVulEffectHostList", "description": "导出漏洞影响主机列表", "status": "online", "parameters": [ { "name": "VulId", "type": "integer", "required": true, "description": "漏洞id", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 AliasName - String - 主机名筛选", "example": "[{\"Name\": \"Status\", \"Values\": [null]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [ "VulId" ] }, { "name": "ExportVulInfo", "description": "导出漏洞信息，包括影响主机列表，组件信息", "status": "online", "parameters": [ { "name": "VulId", "type": "integer", "required": true, "description": "漏洞id", "example": "1" } ], "required": [ "VulId" ] }, { "name": "ExportVulList", "description": "漏洞管理-导出漏洞列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 VulCategory - int - 是否必填：否 - 漏洞分类筛选1: web-cms漏洞 2:应用漏洞 4: Linux软件漏洞 5: Windows系统漏洞 IfEmergency - String - 是否必填：否 - 是否为应急漏洞，查询应急漏洞传:yes Status - String - 是否必填：是 - 漏洞状态筛选，0: 待处理 1:忽略 3:已修复 5:检测中， 控制台仅处理0,1,3,5四种状态 Level - String - 是否必填：否 - 漏洞等级筛选 1:低 2:中 3:高 4:提示 VulName- String - 是否...", "example": "[{\"ExactMatch\": true, \"Name\": \"VulCate****\", \"Values\": [\"null\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "IfDetail", "type": "integer", "required": false, "description": "是否导出详情,1是 0不是", "example": "1" } ], "required": [] }, { "name": "ExportWebPageEventList", "description": "导出篡改事件列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 EventType - String - 是否必填：否 - 事件类型 EventStatus - String - 是否必填：否 - 事件状态", "example": "[{\"Name\":\"IpOrAlias\",\"Values\":[\"1.0.0.4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "IpOrA****" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[None]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊查询", "example": "False" } ] }, { "name": "By", "type": "string", "required": false, "description": "排序方式：CreateTime 或 RestoreTime，默认为CreateTime", "example": "CreateTime,RestoreTime" }, { "name": "Order", "type": "integer", "required": false, "description": "排序方式，0降序，1升序，默认为0", "example": "1" } ], "required": [] }, { "name": "ExportWindowsPatchList", "description": "导出Windows补丁列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Status : String类型 非必填 处理状态 0待处理,1忽略,3修复 ShowNew : int类型 非必填 展示最新版本 0-开启 1-关闭 Name : string类型 非必填 补丁名称 KbNo : string类型 非必填 补丁编号 Uuid : string类型 非必填 主机uuid", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [] }, { "name": "FixBaselineDetect", "description": "修复基线检测", "status": "online", "parameters": [ { "name": "HostId", "type": "string", "required": true, "description": "主机Id", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "ItemId", "type": "integer", "required": true, "description": "项Id", "example": "10001" }, { "name": "Data", "type": "array", "required": false, "description": "修复内容", "example": "[\"1ce68339-8828-457f-b358-d5b1b34e4fe9\"]", "item_type": "string" } ], "required": [ "HostId", "ItemId" ] }, { "name": "GetLocalStorageItem", "description": "获取本地存储数据", "status": "online", "parameters": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "test_key" } ], "required": [ "Key" ] }, { "name": "KeysLocalStorage", "description": "获取本地存储键值列表", "status": "online", "parameters": [], "required": [] }, { "name": "ModifyAutoOpenProVersionConfig", "description": "用于设置新增主机自动开通专业防护配置。", "status": "online", "parameters": [ { "name": "Status", "type": "string", "required": true, "description": "设置自动开通状态。 CLOSE：关闭 OPEN：打开", "example": "OPEN" }, { "name": "ProtectType", "type": "string", "required": false, "description": "加固防护模式 PROVERSION_POSTPAY 专业版-按量计费 PROVERSION_PREPAY 专业版-包年包月 FLAGSHIP_PREPAY 旗舰版-包年包月", "example": "FLAGSHIP_PREPAY" }, { "name": "AutoRepurchaseSwitch", "type": "integer", "required": false, "description": "自动加购/扩容授权开关,默认 1, 0关闭, 1开启", "example": "1" }, { "name": "AutoRepurchaseRenewSwitch", "type": "integer", "required": false, "description": "自动加购的订单是否自动续费,默认0 ,0关闭, 1开启", "example": "1" }, { "name": "RepurchaseRenewSwitch", "type": "integer", "required": false, "description": "手动购买的订单是否自动续费,默认0, 0关闭 ,1 开启", "example": "0" }, { "name": "AutoBindRaspSwitch", "type": "integer", "required": false, "description": "新增机器自动绑定rasp,0 关闭 1开启", "example": "0" }, { "name": "AutoOpenRaspSwitch", "type": "integer", "required": false, "description": "新增机器自动开启rasp防护,默认关闭,0 关闭 1开启", "example": "0" }, { "name": "AutoDowngradeSwitch", "type": "integer", "required": false, "description": "自动缩容开关,0 关闭 1开启", "example": "0" } ], "required": [ "Status" ] }, { "name": "ModifyBanMode", "description": "修改爆破阻断模式", "status": "online", "parameters": [ { "name": "Mode", "type": "string", "required": true, "description": "阻断模式，STANDARD_MODE：标准阻断，DEEP_MODE：深度阻断", "example": "STANDARD_MODE" }, { "name": "Ttl", "type": "integer", "required": false, "description": "阻断时间，用于标准阻断模式", "example": "2" } ], "required": [ "Mode" ] }, { "name": "ModifyBanStatus", "description": "设置阻断开关状态", "status": "online", "parameters": [ { "name": "Status", "type": "integer", "required": true, "description": "阻断开关状态: 0 -- 关闭 1 -- 高级阻断 2 -- 基础阻断(只阻断情报库黑ip)", "example": "1" }, { "name": "OpenSmartMode", "type": "boolean", "required": false, "description": "是否开启智能过白模式", "example": "TRUE" } ], "required": [ "Status" ] }, { "name": "ModifyBanWhiteList", "description": "修改阻断白名单列表", "status": "online", "parameters": [ { "name": "Rules", "type": "object", "required": true, "description": "修改白名单规则项", "example": "{\"Id\":\"id_10001\",\"Remark\":\"别名\",\"SrcIp\":\"1.1.1.1\"}", "children": [ { "name": "Id", "type": "string", "required": false, "description": "白名单ID。", "example": "id_10001" }, { "name": "Remark", "type": "string", "required": false, "description": "白名单别名。", "example": "别名" }, { "name": "SrcIp", "type": "string", "required": false, "description": "阻断来源IP。", "example": "1.1.1.1" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改白名单时间。", "example": "2021-01-01 00:00:00" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建白名单时间。", "example": "2021-01-01 00:00:00" }, { "name": "Uuid", "type": "string", "required": false, "description": "白名单所属机器。", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "IsGlobal", "type": "boolean", "required": false, "description": "白名单是否全局", "example": "false" }, { "name": "Quuids", "type": "array", "required": false, "description": "白名单所属机器列表", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9", "item_type": "string" } ] } ], "required": [ "Rules" ] }, { "name": "ModifyBaselinePolicy", "description": "更改基线策略设置", "status": "online", "parameters": [ { "name": "Data", "type": "object", "required": true, "description": "无", "example": "{\"PolicyName\": \"\\u5b89\\u5168\\u4e2d\\u5fc3\\u4e00\\u952e\\u4f53\\u68c0\\u5f31****\", \"DetectInterval\": 7, \"DetectTime\": \"01:35:30\", \"AssetType\": 1, \"PolicyId\": 566577, \"RuleIds\": [50], \"HostIds\": [\"fee37230-1536-47f7-9bec-38314216****\"]}", "children": [ { "name": "PolicyName", "type": "string", "required": true, "description": "策略名称,长度不超过128英文字符", "example": "国际标准基线" }, { "name": "DetectInterval", "type": "integer", "required": true, "description": "检测间隔[1:1天|3:3天|5:5天|7:7天]", "example": "7" }, { "name": "DetectTime", "type": "string", "required": true, "description": "检测时间", "example": "09:00:00" }, { "name": "IsEnabled", "type": "integer", "required": true, "description": "是否开启[0:未开启|1:开启]", "example": "0" }, { "name": "AssetType", "type": "integer", "required": true, "description": "资产类型[0:所有专业版旗舰版|1:id|2:ip]", "example": "0" }, { "name": "PolicyId", "type": "integer", "required": false, "description": "策略Id", "example": "902471" }, { "name": "RuleCount", "type": "integer", "required": false, "description": "关联基线项数目", "example": "12" }, { "name": "ItemCount", "type": "integer", "required": false, "description": "关联基线项数目", "example": "1419" }, { "name": "HostCount", "type": "integer", "required": false, "description": "关联基线主机数目", "example": "0" }, { "name": "RuleIds", "type": "array", "required": false, "description": "规则Id", "example": "[11]", "item_type": "integer" }, { "name": "HostIds", "type": "array", "required": false, "description": "主机Id", "example": "['116d84e9-22d3-4fa3-a31b-a1e58f2b****']", "item_type": "string" }, { "name": "HostIps", "type": "array", "required": false, "description": "主机Ip", "example": "1.1.1.1或1.1.1.1-2.2.2.2", "item_type": "string" }, { "name": "IsDefault", "type": "integer", "required": false, "description": "是否是系统默认", "example": "0" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "RuleName - String - 是否必填：否 - 规则名称 CategoryId - int64 - 是否必填：否 自定义筛选为-1 - 规则分类 RuleType - int - 是否必填：否 0:系统 1:自定义 - 规则类型", "example": "[{\"Name\":\"RuleName\",\"Values\":[\"rule4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "SelectAll", "type": "integer", "required": false, "description": "是否按照过滤的全选", "example": "1" } ], "required": [ "Data" ] }, { "name": "ModifyBaselinePolicyState", "description": "更改基线策略状态", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "策略Id", "example": "638392" }, { "name": "IsEnabled", "type": "integer", "required": true, "description": "开启状态[1:开启|0:未开启]", "example": "1" } ], "required": [ "PolicyId", "IsEnabled" ] }, { "name": "ModifyBaselineRule", "description": "更改基线检测规则", "status": "online", "parameters": [ { "name": "Data", "type": "object", "required": true, "description": "无", "example": "{\"Items\": [{\"ItemId\": 1000, \"ItemName\": \"Redis \\u57fa\\u7ebf****\"}], \"RuleDesc\": \"\\u63a5\\u53e3\\u6d4b\\u8bd5\\u6570\\u636e****\", \"RuleName\": \"auto_****\"}", "children": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称,长度不超过128英文字符", "example": "国际标准-CentOS 6安全基线检查Le****" }, { "name": "RuleId", "type": "integer", "required": false, "description": "规则Id", "example": "11" }, { "name": "RuleType", "type": "integer", "required": false, "description": "规则类型 [0:系统|1:自定义]", "example": "1" }, { "name": "CategoryId", "type": "integer", "required": false, "description": "规则分类", "example": "1" }, { "name": "RuleDesc", "type": "string", "required": false, "description": "规则描述", "example": "国际标准-CentOS 6安全基线检查Le****" }, { "name": "HostCount", "type": "integer", "required": false, "description": "主机数", "example": "0" }, { "name": "Items", "type": "array", "required": false, "description": "适配项ID列表", "example": "[{'ItemId': 1905, 'ItemName': '确保在/home分区上设置了nod****', 'CustomItemValues': None, 'CategoryId': 11}]", "item_type": "object", "children": [ { "name": "ItemId", "type": "integer", "required": true, "description": "Id", "example": "100" }, { "name": "ItemName", "type": "string", "required": false, "description": "名称", "example": "itemname" }, { "name": "CustomItemValues", "type": "array", "required": false, "description": "自定义阈值", "example": "1000", "item_type": "integer" }, { "name": "CategoryId", "type": "integer", "required": false, "description": "检测项所属分类", "example": "50" } ] }, { "name": "AssetType", "type": "integer", "required": false, "description": "[0:所有专业版旗舰版|1:hostID|2:ip]", "example": "1" }, { "name": "HostIds", "type": "array", "required": false, "description": "主机Id集合", "example": "[\"F00A8503-6233-452E-913E-DAFEE9******\", \"E3CB79D9-8892-408C-AE2D-A90059******\"]", "item_type": "string" }, { "name": "HostIps", "type": "array", "required": false, "description": "主机IP", "example": "[\"10.0.1.11\",\"10.0.0.12\"]", "item_type": "string" } ] }, { "name": "SelectAll", "type": "integer", "required": false, "description": "是否过滤全选", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "ItemName - string - 是否必填：否 - 项名称", "example": "[{\"Name\":\"ItemName\",\"Values\":[\"item\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] }, { "name": "IdType", "type": "integer", "required": false, "description": "0:检测项，1:检测项分类", "example": "0" }, { "name": "ExcludeIds", "type": "array", "required": false, "description": "需要排除的检测项id", "example": "[142]", "item_type": "integer" }, { "name": "CategoryIds", "type": "array", "required": false, "description": "勾选的检测项分类", "example": "[100,101]", "item_type": "integer" } ], "required": [ "Data" ] }, { "name": "ModifyBaselineRuleIgnore", "description": "更改基线忽略规则", "status": "online", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称", "example": "auto_173042751****" }, { "name": "AssetType", "type": "integer", "required": true, "description": "资产类型[0:所有专业版旗舰版|1:id|2:ip]", "example": "0" }, { "name": "RuleId", "type": "integer", "required": false, "description": "规则Id", "example": "100" }, { "name": "ItemIds", "type": "array", "required": false, "description": "关联项", "example": "[1000]", "item_type": "integer" }, { "name": "HostIds", "type": "array", "required": false, "description": "主机Id", "example": "[\"4c4c4544-0053-4d10-8052-c4c04f53****\"]\t", "item_type": "string" }, { "name": "HostIps", "type": "array", "required": false, "description": "主机Ip", "example": "[\"172.10.0.0\"]", "item_type": "string" }, { "name": "SelectAll", "type": "integer", "required": false, "description": "是否全选过滤", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "ItemName - string - 是否必填：否 - 项名称", "example": "[{\"Name\":\"ItemName\",\"Values\":[\"itemname\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Keywords" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "1.1.1.1", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "模糊搜索", "example": "false" } ] } ], "required": [ "RuleName", "AssetType" ] }, { "name": "ModifyBaselineWeakPassword", "description": "更改或新增弱口令", "status": "online", "parameters": [ { "name": "Data", "type": "array", "required": true, "description": "无", "example": "[{\"PasswordId\": 523, \"WeakPassword\": \"automationTe****\"}]", "item_type": "object", "children": [ { "name": "PasswordId", "type": "integer", "required": true, "description": "密码Id", "example": "1002" }, { "name": "WeakPassword", "type": "string", "required": true, "description": "密码", "example": "passwd-01" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2006-01-02 15:04:05" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间", "example": "2006-01-02 15:04:05" } ] } ], "required": [ "Data" ] }, { "name": "ModifyBashPolicy", "description": "新增或修改高危命令策略", "status": "online", "parameters": [ { "name": "Policy", "type": "object", "required": true, "description": "具体的策略配置", "example": "{\"BashAction\": 0, \"Category\": 1, \"Descript\": \"\\u63a5\\u53e3\\u81ea\\u52a8\\u5316\\u6570****\", \"Enable\": 1, \"Id\": 19806, \"Level\": 1, \"Name\": \"\\u63a5\\u53e3\\u81ea\\u52a8\\u5316\\u6570\\u636e\", \"Quuids\": [\"2a2bcfb7-b649-43e5-9758-58035a7c****\"], \"Rule\": \"MQ==\", \"Scope\": 0, \"White\": 0}", "children": [ { "name": "Name", "type": "string", "required": true, "description": "策略名称", "example": "policy" }, { "name": "Enable", "type": "integer", "required": true, "description": "1:有效 0:无效", "example": "0" }, { "name": "White", "type": "integer", "required": true, "description": "0:黑名单 1:白名单", "example": "1" }, { "name": "BashAction", "type": "integer", "required": true, "description": "0:告警 1:白名单 2:拦截", "example": "1" }, { "name": "Rule", "type": "string", "required": true, "description": "正则表达式 base64 加密,该字段废弃,如果写入则自动替换为Rules.Process.CmdLine", "example": "rule-reg-*" }, { "name": "Level", "type": "integer", "required": true, "description": "危险等级(0:无，1: 高危 2:中危 3: 低危)", "example": "1" }, { "name": "Scope", "type": "integer", "required": true, "description": "生效范围（0:一组quuid 1:所有专业版(包含旗舰版) 2:所有旗舰版 3:所有主机）", "example": "1" }, { "name": "Id", "type": "integer", "required": false, "description": "策略ID", "example": "1" }, { "name": "Descript", "type": "string", "required": false, "description": "策略描述", "example": "系统规则(标准)" }, { "name": "EventId", "type": "integer", "required": false, "description": "事件列表点击“加入白名单”时,需要传EventId 事件的id", "example": "1" }, { "name": "DealOldEvents", "type": "integer", "required": false, "description": "是否处理旧事件为白名单 0=不处理 1=处理", "example": "1" }, { "name": "Quuids", "type": "array", "required": false, "description": "生效主机的QUUID集合", "example": "['d99a1b46-cc2d-4633-a11f-4a7663d25***']", "item_type": "string" }, { "name": "Category", "type": "integer", "required": false, "description": "策略类型，0:系统 1:用户", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2020-12-12 00:00:00" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间", "example": "2020-12-12 00:00:00" }, { "name": "Uuids", "type": "array", "required": false, "description": "老版本兼容可能会用到", "example": "['d99a1b46-cc2d-4633-a11f-4a7663d25***']", "item_type": "string" }, { "name": "Rules", "type": "object", "required": false, "description": "规则表达式", "example": "{'Process': {'Exe': '', 'Cmdline': ''}, 'PProcess': None, 'AProcess': None}", "children": [ { "name": "Process", "type": "object", "required": false, "description": "进程", "example": "{\"Exe\":\"/tmp/test\",\"Cmdline\":\"/tmp/test\"}", "children": [ { "name": "Exe", "type": "string", "required": false, "description": "路径,需要base64加密", "example": "/tmp/test" }, { "name": "Cmdline", "type": "string", "required": false, "description": "命令行,需要base64加密", "example": "sh test.sh" } ] }, { "name": "PProcess", "type": "object", "required": false, "description": "父进程", "example": "{\"Exe\":\"/tmp/test\",\"Cmdline\":\"/tmp/test\"}", "children": [ { "name": "Exe", "type": "string", "required": false, "description": "路径,需要base64加密", "example": "/tmp/test" }, { "name": "Cmdline", "type": "string", "required": false, "description": "命令行,需要base64加密", "example": "sh test.sh" } ] }, { "name": "AProcess", "type": "object", "required": false, "description": "祖先进程", "example": "{\"Exe\":\"/tmp/test\",\"Cmdline\":\"/tmp/test\"}", "children": [ { "name": "Exe", "type": "string", "required": false, "description": "路径,需要base64加密", "example": "/tmp/test" }, { "name": "Cmdline", "type": "string", "required": false, "description": "命令行,需要base64加密", "example": "sh test.sh" } ] } ] } ] } ], "required": [ "Policy" ] }, { "name": "ModifyBashPolicyStatus", "description": "切换高危命令策略状态", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "规则ID", "example": "1" }, { "name": "Enable", "type": "integer", "required": true, "description": "是否禁用", "example": "1" } ], "required": [ "Id", "Enable" ] }, { "name": "ModifyBruteAttackRules", "description": "修改暴力破解规则", "status": "online", "parameters": [ { "name": "Rules", "type": "array", "required": true, "description": "暴力破解判断规则", "example": "[\"TimeRange\":10,\"LoginFailTimes\":10]", "item_type": "object", "children": [ { "name": "TimeRange", "type": "integer", "required": true, "description": "爆破事件发生的时间范围，单位：秒", "example": "1" }, { "name": "LoginFailTimes", "type": "integer", "required": true, "description": "爆破事件失败次数", "example": "6" } ] } ], "required": [ "Rules" ] }, { "name": "ModifyEventAttackStatus", "description": "修改网络攻击事件状态", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": false, "description": "需要修改的事件id 数组，支持批量", "example": "[1,2]", "item_type": "integer" }, { "name": "All", "type": "boolean", "required": false, "description": "是否更新全部，即是否对所有的事件进行操作，当ids 不为空时，此参数无效", "example": "false" }, { "name": "Status", "type": "integer", "required": false, "description": "0：待处理 1：已处理 3： 已忽略 4：已删除", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 Type - String 攻击状态 0: 尝试攻击 1: 攻击成功 - 是否必填: 否 Status - String 事件处理状态 0：待处理 1：已处理 2： 已加白 3： 已忽略 4：已删除 - 是否必填: 否 SrcIP - String 来源IP - 是否必填: 否 DstPort - String 攻击目标端口 - 是否必填: 否 MachineName - String 主机名称 - 是否必填: 否 InstanceID - String 主机实例ID - 是否必填: 否 Quuids - String 主机cvm uuid - 是否必填: 否", "example": "[{\"Name\":\"Status\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "ExcludeId", "type": "array", "required": false, "description": "排除的id", "example": "[1,2]", "item_type": "integer" } ], "required": [] }, { "name": "ModifyFileTamperEvents", "description": "核心文件事件更新", "status": "online", "parameters": [ { "name": "Status", "type": "integer", "required": true, "description": "Status 1 -- 加白 2 -- 删除 3 - 忽略", "example": "1" }, { "name": "Ids", "type": "array", "required": true, "description": "对应事件id", "example": "[371333164]", "item_type": "integer" } ], "required": [ "Status", "Ids" ] }, { "name": "ModifyFileTamperRule", "description": "编辑、新增核心文件监控规则", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "规则名称", "example": "禁止特殊文件访问" }, { "name": "Rules", "type": "array", "required": true, "description": "规则内容", "example": "[{\"Action\": \"skip\", \"FileAction\": \"read;w****\", \"ProcessPath\": \"JTJGdXNyJTJGYmluJTJGY3JvbnRh****\", \"Target\": \"JTJGdmFyJTJGc3Bvb2wlMkZjcm9uJTJGJTIzdG1wLm1hc3Rl****\"}]", "item_type": "object", "children": [ { "name": "ProcessPath", "type": "string", "required": true, "description": "进程路径", "example": "/tmp/*" }, { "name": "Target", "type": "string", "required": true, "description": "被访问文件路径", "example": "/etc/shadow" }, { "name": "Action", "type": "string", "required": true, "description": "执行动作 跳过：skip，告警：alert", "example": "alert" }, { "name": "FileAction", "type": "string", "required": false, "description": "监控行为 read 读取文件 write 修改文件 read-write 读取修改文件", "example": "read" }, { "name": "Args", "type": "string", "required": false, "description": "命令行参数 没有填*", "example": "timeout=200" } ] }, { "name": "IsGlobal", "type": "integer", "required": true, "description": "是否全局规则(默认否) 0：否 ，1：是，全局是Uuids 可为空", "example": "1" }, { "name": "Status", "type": "integer", "required": true, "description": "启用状态 0: 启用 1: 已关闭", "example": "1" }, { "name": "Id", "type": "integer", "required": false, "description": "规则id 不填或者0表示新增", "example": "1" }, { "name": "Uuids", "type": "array", "required": false, "description": "影响的主机uuid集合", "example": "[\"1ce68339-8828-457f-b358-d5b1b34e4fe9\"]", "item_type": "string" }, { "name": "Level", "type": "integer", "required": false, "description": "风险等级 0：无， 1: 高危， 2:中危， 3: 低危", "example": "1" }, { "name": "AddWhiteType", "type": "string", "required": false, "description": "加白处理类型 cur 仅对当前加白 all 所有符合条件加白", "example": "cur" } ], "required": [ "Name", "Rules", "IsGlobal", "Status" ] }, { "name": "ModifyFileTamperRuleStatus", "description": "核心文件规则状态更新，支持批量删除 关闭", "status": "online", "parameters": [ { "name": "Status", "type": "integer", "required": true, "description": "0: 启用1: 关闭2：删除", "example": "1" }, { "name": "Ids", "type": "array", "required": true, "description": "对应事件id", "example": "[11934]", "item_type": "integer" }, { "name": "RuleCategory", "type": "integer", "required": true, "description": "是否是系统规则 0=系统规则 1=用户自定义规则，系统规则Status 不支持删除", "example": "1" } ], "required": [ "Status", "Ids", "RuleCategory" ] }, { "name": "ModifyJavaMemShellPluginSwitch", "description": "开关java内存马插件", "status": "online", "parameters": [ { "name": "Quuids", "type": "array", "required": true, "description": "主机quuid数组", "example": "[\"05f0bcab-726c-4ea4-8109-bcd03d5598f7\"]", "item_type": "string" }, { "name": "JavaShellStatus", "type": "integer", "required": true, "description": "插件目标状态：0: 关闭 1: 开启", "example": "1" } ], "required": [ "Quuids", "JavaShellStatus" ] }, { "name": "ModifyJavaMemShellsStatus", "description": "修改java内存马事件状态", "status": "online", "parameters": [ { "name": "Status", "type": "integer", "required": true, "description": "目标处理状态： 0 - 待处理 1 - 已加白 2 - 已删除 3 - 已忽略 4 - 已手动处理", "example": "3" }, { "name": "Ids", "type": "array", "required": false, "description": "事件Id数组", "example": "[1,3]", "item_type": "integer" }, { "name": "UpdateAll", "type": "boolean", "required": false, "description": "是否更新全部，只支持忽略、已处理、删除", "example": "false" } ], "required": [ "Status" ] }, { "name": "ModifyLicenseBinds", "description": "设置中心-授权管理 对某个授权批量绑定机器", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID", "example": "1" }, { "name": "LicenseType", "type": "integer", "required": true, "description": "授权类型", "example": "0" }, { "name": "IsAll", "type": "boolean", "required": false, "description": "是否全部机器(当全部机器数大于当前订单可用授权数时,多余机器会被跳过)", "example": "ture" }, { "name": "QuuidList", "type": "array", "required": false, "description": "需要绑定的机器quuid列表, 当IsAll = false 时必填,反之忽略该参数. 最大长度=2000", "example": "[\"4c4c4544-004c-5410-805a-cac04f46****\"]", "item_type": "string" } ], "required": [ "ResourceId", "LicenseType" ] }, { "name": "ModifyLicenseOrder", "description": "编辑《主机安全-按量计费》授权订单", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID", "example": "cwplic-dwsds" }, { "name": "InquireNum", "type": "integer", "required": false, "description": "预期值,如果当前为10,扩容则输入原来大的值, 缩容则比原来小的值(缩容时不允许预期值比使用量小),如果保持不变则填写原值,", "example": "1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID,不修改则输入原值.", "example": "1" }, { "name": "Alias", "type": "string", "required": false, "description": "资源别名,不修改则输入原值.", "example": "别名" } ], "required": [ "ResourceId" ] }, { "name": "ModifyLicenseUnBinds", "description": "设置中心-授权管理 对某个授权批量解绑机器", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID", "example": "cwplic-92c9****" }, { "name": "LicenseType", "type": "integer", "required": true, "description": "授权类型", "example": "0" }, { "name": "IsAll", "type": "boolean", "required": false, "description": "是否全部机器(当全部机器数大于当前订单可用授权数时,多余机器会被跳过)", "example": "ture" }, { "name": "QuuidList", "type": "array", "required": false, "description": "需要绑定的机器quuid列表, 当IsAll = false 时必填,反之忽略该参数. 最大长度=100", "example": "[\"4c4c4544-0053-4d10-8052-c4c04f53****\"]", "item_type": "string" } ], "required": [ "ResourceId", "LicenseType" ] }, { "name": "ModifyLogKafkaAccess", "description": "新增或修改日志投递kafka接入配置", "status": "online", "parameters": [ { "name": "KafkaEnvName", "type": "string", "required": true, "description": "实例名称 如 主机安全测试环境", "example": "主机安全测试环境" }, { "name": "KafkaId", "type": "string", "required": true, "description": "实例ID", "example": "ckafka-ce80kte5" }, { "name": "AccessType", "type": "integer", "required": true, "description": "接入方式，1公网域名接入，2支撑环境接入", "example": "1" }, { "name": "AccessAddr", "type": "string", "required": true, "description": "接入地址", "example": "127.0.0.1:80" }, { "name": "Username", "type": "string", "required": true, "description": "用户名", "example": "username" }, { "name": "HasPwd", "type": "integer", "required": true, "description": "0不用密码，1有密码", "example": "1" }, { "name": "DeliverTypeDetails", "type": "array", "required": true, "description": "日志投递类型配置细节", "example": "[{\"LogName\": \"\", \"LogSetId\": \"\", \"LogType\": [], \"Region\": \"\", \"SecurityType\": 1, \"Switch\": 0, \"TopicId\": \"\", \"TopicName\": \"\"}]", "item_type": "object", "children": [ { "name": "SecurityType", "type": "integer", "required": true, "description": "安全模块类型 1: 入侵检测 2: 漏洞管理 3: 基线管理 4: 高级防御 5:客户端相关 6: 资产指纹 7 主机列表 8 客户端上报", "example": "1" }, { "name": "LogType", "type": "array", "required": true, "description": "安全模块下的日志类型", "example": "[1,2]", "item_type": "integer" }, { "name": "TopicId", "type": "string", "required": true, "description": "主题ID", "example": "topic-70s2****" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名", "example": "log-recive" }, { "name": "Switch", "type": "integer", "required": true, "description": "投递开关 0关闭 1开启", "example": "1" }, { "name": "Status", "type": "integer", "required": false, "description": "投递状态，0未开启 1正常 2异常", "example": "1" }, { "name": "ErrInfo", "type": "string", "required": false, "description": "错误信息", "example": "kafka: client has run out of available brokers to talk to: dial tcp 9.151.101.93:6232: i/o tim****" }, { "name": "StatusTime", "type": "integer", "required": false, "description": "最近一次状态上报时间戳", "example": "1" }, { "name": "LogName", "type": "string", "required": false, "description": "日志集名", "example": "web_logs" }, { "name": "LogSetId", "type": "string", "required": false, "description": "日志集ID", "example": "269e5897-009a-4c5e-9350-5898964******" }, { "name": "Region", "type": "string", "required": false, "description": "日志集所在地域", "example": "ap-guangzhou" } ] }, { "name": "InsVersion", "type": "string", "required": true, "description": "kafka版本", "example": "1.1.1" }, { "name": "Zone", "type": "string", "required": true, "description": "地域", "example": "广州六区" }, { "name": "Az", "type": "string", "required": true, "description": "可用区", "example": "广州" }, { "name": "VpcId", "type": "string", "required": true, "description": "vpcid地址", "example": "vpc-cwcs****" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网id", "example": "subnet-30lo****" }, { "name": "DeliverStatus", "type": "integer", "required": true, "description": "投递状态，1：健康，2：告警，3：异常", "example": "1" }, { "name": "BandWidth", "type": "integer", "required": true, "description": "峰值带宽", "example": "0" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "磁盘容量", "example": "0" }, { "name": "Pwd", "type": "string", "required": false, "description": "密码，aes加密", "example": "32e90b6eb059c07e5e80cfbc6ea0****" } ], "required": [ "KafkaEnvName", "KafkaId", "AccessType", "AccessAddr", "Username", "HasPwd", "DeliverTypeDetails", "InsVersion", "Zone", "Az", "VpcId", "SubnetId", "DeliverStatus", "BandWidth", "DiskSize" ] }, { "name": "ModifyLogKafkaDeliverType", "description": "修改指定日志类别投递配置、开关", "status": "online", "parameters": [ { "name": "SecurityType", "type": "integer", "required": true, "description": "安全模块类型 1: 入侵检测 2: 漏洞管理 3: 基线管理 4: 高级防御 5:客户端相关 6: 资产指纹", "example": "1" }, { "name": "LogType", "type": "array", "required": true, "description": "安全模块下的日志类型，", "example": "[1,2]", "item_type": "integer" }, { "name": "Switch", "type": "integer", "required": true, "description": "投递开关 0关闭 1开启", "example": "1" }, { "name": "TopicId", "type": "string", "required": true, "description": "kafka topic id", "example": "topic-1kkw****" }, { "name": "TopicName", "type": "string", "required": true, "description": "kafka topic name", "example": "yunjing" } ], "required": [ "SecurityType", "LogType", "Switch", "TopicId", "TopicName" ] }, { "name": "ModifyLogKafkaState", "description": "修改日志投递状态信息", "status": "online", "parameters": [ { "name": "KafkaEnvName", "type": "string", "required": true, "description": "实例名称 如 主机安全测试环境", "example": "主机安全测试环境" }, { "name": "KafkaId", "type": "string", "required": true, "description": "实例ID", "example": "ckafka-ce80kte5" }, { "name": "AccessType", "type": "integer", "required": true, "description": "接入方式，1公网域名接入，2支撑环境接入", "example": "1" }, { "name": "AccessAddr", "type": "string", "required": true, "description": "接入地址", "example": "127.0.0.1:80" }, { "name": "Username", "type": "string", "required": true, "description": "用户名", "example": "user1" }, { "name": "Zone", "type": "string", "required": true, "description": "区域", "example": "广州" }, { "name": "Az", "type": "string", "required": true, "description": "可用区", "example": "广州三区" }, { "name": "VpcId", "type": "string", "required": true, "description": "所属网络", "example": "vpc-1d*" }, { "name": "SubnetId", "type": "string", "required": true, "description": "所在子网", "example": "subnet-*" }, { "name": "DeliverStatus", "type": "integer", "required": true, "description": "投递状态，1：健康，2：告警，3：异常", "example": "1" }, { "name": "InsVersion", "type": "string", "required": true, "description": "kafka版本", "example": "0.10.2.1" }, { "name": "BandWidth", "type": "integer", "required": true, "description": "峰值带宽", "example": "1200" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "磁盘容量", "example": "2500" } ], "required": [ "KafkaEnvName", "KafkaId", "AccessType", "AccessAddr", "Username", "Zone", "Az", "VpcId", "SubnetId", "DeliverStatus", "InsVersion", "BandWidth", "DiskSize" ] }, { "name": "ModifyLogStorageConfig", "description": "修改日志存储配置", "status": "online", "parameters": [ { "name": "IsModifyPeriod", "type": "boolean", "required": true, "description": "是否修改有效期（已废弃）", "example": "false" }, { "name": "Type", "type": "array", "required": false, "description": "存储类型，string数组", "example": "[\"malware\"]", "item_type": "string" }, { "name": "Period", "type": "integer", "required": false, "description": "日志存储时长，3640表示不限", "example": "3640" }, { "name": "Granularity", "type": "string", "required": false, "description": "日志存储时长单位，年year/月month/天day", "example": "day" }, { "name": "MsgLanguage", "type": "string", "required": false, "description": "语言类型", "example": "zh" } ], "required": [ "IsModifyPeriod" ] }, { "name": "ModifyLoginWhiteInfo", "description": "更新登录审计白名单信息", "status": "online", "parameters": [ { "name": "HostLoginWhiteObj", "type": "object", "required": true, "description": "更新白名单信息实体", "example": " { \t\"Remark\":\"updateRemark1\", \t\"UserName\":\"uname\", \t\"SrcIp\":\"10.127.**.**\", \t\"Id\":128, \t\"Places\":[{\"CountryId\":1,\"ProvinceId\":11,\"CityId\":111}] }", "children": [ { "name": "Places", "type": "array", "required": true, "description": "地域信息数组", "example": "[ { \"CityId\": 0, \"ProvinceId\": 0, \"CountryId\": 10 }, { \"CityId\": 0, \"ProvinceId\": 0, \"CountryId\": 49 }, { \"CityId\": 0, \"ProvinceId\": 0, \"CountryId\": 36 } ]", "item_type": "object", "children": [ { "name": "CityId", "type": "integer", "required": true, "description": "城市 ID。", "example": "99" }, { "name": "ProvinceId", "type": "integer", "required": true, "description": "省份 ID。", "example": "23" }, { "name": "CountryId", "type": "integer", "required": true, "description": "国家ID，暂只支持境内：1。", "example": "104" }, { "name": "Location", "type": "string", "required": false, "description": "位置名称", "example": "中国:北京市:北京市" } ] }, { "name": "SrcIp", "type": "string", "required": true, "description": "来源ip", "example": "1.2.3.4" }, { "name": "UserName", "type": "string", "required": true, "description": "用户名", "example": "username" }, { "name": "Remark", "type": "string", "required": true, "description": "备注信息", "example": "updateRemark1" }, { "name": "Id", "type": "integer", "required": true, "description": "要更新的数据id", "example": "128" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "2024-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2024-01-01 23:59:59" } ] } ], "required": [ "HostLoginWhiteObj" ] }, { "name": "ModifyLoginWhiteRecord", "description": "更新合并后登录审计白名单信息（服务器列表数目应小于1000）", "status": "online", "parameters": [ { "name": "UserName", "type": "string", "required": true, "description": "白名单用户（多个用户逗号隔开）", "example": "root" }, { "name": "SrcIp", "type": "string", "required": true, "description": "更新后记录的白名单维度信息", "example": "127.0.0.1" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2020-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2024-01-01 00:00:00" }, { "name": "Remark", "type": "string", "required": true, "description": "备注", "example": "备注" }, { "name": "IsGlobal", "type": "integer", "required": true, "description": "是否对所有服务器生效，0-否，1-是", "example": "1" }, { "name": "Id", "type": "integer", "required": true, "description": "白名单ID", "example": "1" }, { "name": "Hosts", "type": "array", "required": false, "description": "服务器列表", "example": "[ { \"Quuid\": \"05f0bcab-726c-4ea4-8109-bcd03d5598f7\", \"Uuid\": \"05f0bcab-726c-4ea4-8109-bcd03d5598f7\" } ]", "item_type": "object", "children": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "d99a1b46-cc2d-4633-a11f-4a7663d2523e" }, { "name": "Uuid", "type": "string", "required": true, "description": "Uuid主机", "example": "d99a1b46-cc2d-4633-a11f-4a7663d2523e" } ] }, { "name": "Places", "type": "array", "required": false, "description": "地域列表", "example": "[ { \"CityId\": 1, \"ProvinceId\": 1, \"CountryId\": 1, \"Location\": \"1.1.1.1\" } ]", "item_type": "object", "children": [ { "name": "CityId", "type": "integer", "required": true, "description": "城市 ID。", "example": "99" }, { "name": "ProvinceId", "type": "integer", "required": true, "description": "省份 ID。", "example": "23" }, { "name": "CountryId", "type": "integer", "required": true, "description": "国家ID，暂只支持境内：1。", "example": "104" }, { "name": "Location", "type": "string", "required": false, "description": "位置名称", "example": "中国:北京市:北京市" } ] } ], "required": [ "UserName", "SrcIp", "StartTime", "EndTime", "Remark", "IsGlobal", "Id" ] }, { "name": "ModifyMachineAutoClearConfig", "description": "修改机器清理配置", "status": "online", "parameters": [ { "name": "ClearRule", "type": "integer", "required": true, "description": "清理规则时间, 0 表示关闭, 单位为天, 最大为 30天", "example": "1" } ], "required": [ "ClearRule" ] }, { "name": "ModifyMachineRemark", "description": "修改主机备注信息", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "5a540076-d38a-4078-aa98-e7c86371d322" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息", "example": "测试机" } ], "required": [ "Quuid" ] }, { "name": "ModifyMaliciousRequestWhiteList", "description": "更新恶意请求白名单", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "白名单id", "example": "1" }, { "name": "Domain", "type": "string", "required": true, "description": "白名单域名", "example": "www.tapd.com" }, { "name": "Mark", "type": "string", "required": false, "description": "备注", "example": "白名单" } ], "required": [ "Id", "Domain" ] }, { "name": "ModifyMalwareTimingScanSettings", "description": "定时扫描设置", "status": "online", "parameters": [ { "name": "CheckPattern", "type": "integer", "required": true, "description": "检测模式 0 全盘检测 1快速检测", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "检测周期 开始时间，如：02:00:00", "example": "00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "检测周期 超时结束时间，如：04:00:00", "example": "02:00:00" }, { "name": "IsGlobal", "type": "integer", "required": true, "description": "是否全部服务器 1 全部 2 自选", "example": "1" }, { "name": "EnableScan", "type": "integer", "required": true, "description": "定时检测开关 0 关闭 1开启", "example": "1" }, { "name": "MonitoringPattern", "type": "integer", "required": true, "description": "监控模式 0 标准 1深度", "example": "1" }, { "name": "Cycle", "type": "integer", "required": true, "description": "扫描周期 默认每天 1", "example": "1" }, { "name": "RealTimeMonitoring", "type": "integer", "required": true, "description": "实时监控 0 关闭 1开启", "example": "1" }, { "name": "QuuidList", "type": "array", "required": false, "description": "自选服务器时必须 主机quuid的string数组", "example": "[\"quuidA\"]", "item_type": "string" }, { "name": "AutoIsolation", "type": "integer", "required": false, "description": "是否自动隔离 1隔离 0 不隔离", "example": "1" }, { "name": "KillProcess", "type": "integer", "required": false, "description": "是否杀掉进程 1杀掉 0不杀掉", "example": "1" }, { "name": "DoClean", "type": "integer", "required": false, "description": "1 清理, 0 不清理 本操作会修复被篡改的系统命令，计划任务等系统文件，操作中请确保yum/apt 可用", "example": "1" }, { "name": "EngineType", "type": "integer", "required": false, "description": "1标准模式（只报严重、高危）、2增强模式（报严重、高危、中危）、3严格模式（报严重、高、中、低、提示）", "example": "1" }, { "name": "EnableInspiredEngine", "type": "integer", "required": false, "description": "启发引擎开关 0 关闭 1开启", "example": "1" }, { "name": "EnableMemShellScan", "type": "integer", "required": false, "description": "是否开启恶意进程查杀[0:未开启,1:开启]", "example": "1" }, { "name": "ProtectMode", "type": "integer", "required": false, "description": "防护模式 0 标准 1重保", "example": "0" }, { "name": "ProtectFileScope", "type": "integer", "required": false, "description": "查杀范围 0 脚本类之外的恶意文件，1全部恶意文件", "example": "0" }, { "name": "QuaraUuids", "type": "array", "required": false, "description": "自选的隔离主机集合", "example": "[\"quuidA\"]", "item_type": "string" }, { "name": "QuaraScope", "type": "integer", "required": false, "description": "用户选择的隔离范围，0：默认全隔离 1：用户自选", "example": "1" } ], "required": [ "CheckPattern", "StartTime", "EndTime", "IsGlobal", "EnableScan", "MonitoringPattern", "Cycle", "RealTimeMonitoring" ] }, { "name": "ModifyMalwareWhiteList", "description": "编辑木马白名单", "status": "online", "parameters": [ { "name": "Mode", "type": "integer", "required": true, "description": "白名单模式； 0MD5白名单，1自定义", "example": "1" }, { "name": "Id", "type": "integer", "required": true, "description": "规则唯一ID", "example": "1" }, { "name": "QuuidList", "type": "array", "required": false, "description": "quuid 列表", "example": "[\"1c26308c-5493-4eaf-a817-112ec25f499e\"]", "item_type": "string" }, { "name": "IsGlobal", "type": "integer", "required": false, "description": "是否全部主机； 0否，1是。", "example": "1" }, { "name": "MatchType", "type": "integer", "required": false, "description": "匹配模式 ；0 精确匹配，1模糊匹配(废弃)", "example": "1" }, { "name": "FileName", "type": "array", "required": false, "description": "文件名称(正则)；长度不超过200个", "example": "[\"filename.txt\"]", "item_type": "string" }, { "name": "FileDirectory", "type": "array", "required": false, "description": "文件目录(正则)；长度不超过200个，内容base64转义", "example": "[\"/data/dirname/\"]", "item_type": "string" }, { "name": "FileExtension", "type": "array", "required": false, "description": "文件后缀；长度不超过200个，内容base64转义（废弃）", "example": "[\".txt\"]", "item_type": "string" }, { "name": "Md5List", "type": "array", "required": false, "description": "MD5列表", "example": "[\"d7455d1d714ffc2b08d141332ed3e563\"]", "item_type": "string" } ], "required": [ "Mode", "Id" ] }, { "name": "ModifyNetAttackSetting", "description": "修改网络攻击设置", "status": "online", "parameters": [ { "name": "NetAttackEnable", "type": "integer", "required": true, "description": "0 关闭网络攻击检测，1开启网络攻击检测", "example": "1" }, { "name": "NetAttackAlarmStatus", "type": "integer", "required": true, "description": "0 新增告警事件默认待处理，1新增告警事件默认已处理，3新增告警事件默认忽略", "example": "1" }, { "name": "Scope", "type": "integer", "required": false, "description": "1 全部旗舰版主机，0 Quuids列表主机", "example": "1" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "自选主机", "example": "[\"d92d7\"]", "item_type": "string" }, { "name": "ExcludeInstanceIds", "type": "array", "required": false, "description": "自选排除的主机", "example": "[\"d92d\"]", "item_type": "string" }, { "name": "AutoInclude", "type": "integer", "required": false, "description": "新增资产自动包含 0 不包含 1包含", "example": "1" } ], "required": [ "NetAttackEnable", "NetAttackAlarmStatus" ] }, { "name": "ModifyNetAttackWhiteList", "description": "编辑网络攻击白名单", "status": "online", "parameters": [ { "name": "Scope", "type": "integer", "required": true, "description": "是否全部主机； 0否，1是。", "example": "1" }, { "name": "SrcIp", "type": "array", "required": true, "description": "来源IP 单IP:1.1.1.1 IP范围:1.1.1.1-1.1.2.1 IP范围：1.1.1.0/24", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "DealOldEvents", "type": "integer", "required": true, "description": "是否加白所有符合该规则的告警 ，1:处理,0:不处理", "example": "1" }, { "name": "Id", "type": "integer", "required": true, "description": "规则id", "example": "1" }, { "name": "QuuidList", "type": "array", "required": false, "description": "quuid 列表", "example": "[\"1c26308c-5493-4eaf-a817-112ec25f499e\"]", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述", "example": "接口测试，勿删" } ], "required": [ "Scope", "SrcIp", "DealOldEvents", "Id" ] }, { "name": "ModifyOrderAttribute", "description": "对订单属性编辑", "status": "online", "parameters": [ { "name": "LicenseType", "type": "integer", "required": true, "description": "授权类型 0 专业版-按量计费, 1专业版-包年包月 , 2 旗舰版-包年包月", "example": "1" }, { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID", "example": "resource_id" }, { "name": "AttrName", "type": "string", "required": true, "description": "可编辑的属性名称 ,当前支持的有: alias 资源别名 projectId 项目ID", "example": "alias" }, { "name": "AttrValue", "type": "string", "required": true, "description": "属性值 AttrName=alias时,任意字符串,最大字符15长度 AttrName=projectId时,项目ID必须是真实存在的", "example": "资源名称" } ], "required": [ "LicenseType", "ResourceId", "AttrName", "AttrValue" ] }, { "name": "ModifyRansomDefenseEventsStatus", "description": "修改防勒索事件状态", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "需要修改的事件id 数组，支持批量", "example": "[1,2]", "item_type": "integer" }, { "name": "Status", "type": "integer", "required": true, "description": "操作 0待处理，1已处理,2信任,9:删除记录", "example": "1" }, { "name": "All", "type": "boolean", "required": false, "description": "是否更新所有同路径事件", "example": "false" } ], "required": [ "Ids", "Status" ] }, { "name": "ModifyRansomDefenseStrategyStatus", "description": "批量修改防勒索策略状态", "status": "online", "parameters": [ { "name": "IsAll", "type": "integer", "required": true, "description": "是否对全部策略生效: 0否，1是", "example": "1" }, { "name": "Status", "type": "integer", "required": true, "description": "0关闭，1开启，9删除", "example": "1" }, { "name": "IdList", "type": "array", "required": false, "description": "策略ID列表", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "IsAll", "Status" ] }, { "name": "ModifyRaspMaxCpu", "description": "编辑漏洞防御最大cpu配置", "status": "online", "parameters": [ { "name": "RaspMaxCpu", "type": "integer", "required": false, "description": "rasp当前最大cpu限制，大于0，小于等于100，默认100表示不限制", "example": "80" } ], "required": [] }, { "name": "ModifyRaspRules", "description": "添加漏洞防御白名单", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "规则ID(新增时请留空，编辑时候必传)", "example": "34" }, { "name": "VulVulsIDs", "type": "array", "required": false, "description": "漏洞id数组", "example": "2", "item_type": "integer" }, { "name": "URLRegexp", "type": "string", "required": false, "description": "自定义请求范围加白正则表达式，选择全部请求范围时候为空，否则不能为空，base64编码", "example": "LiovdXNyL2Jpbi8=" }, { "name": "WhiteType", "type": "integer", "required": false, "description": "加白方式，0：自定义请求范围加白。1：全部请求加白", "example": "0" } ], "required": [] }, { "name": "ModifyReverseShellRulesAggregation", "description": "编辑反弹Shell规则（支持多服务器选择）", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "规则ID(新增时请留空)", "example": "1" }, { "name": "Uuids", "type": "array", "required": false, "description": "客户端ID数组", "example": "[\"a9fe0359-04d9-417f-ab6d-4941891d6c4b\"]", "item_type": "string" }, { "name": "HostIp", "type": "string", "required": false, "description": "主机IP", "example": "172.17.x.xx" }, { "name": "DestIp", "type": "string", "required": false, "description": "目标IP", "example": "172.17.x.xx" }, { "name": "DestPort", "type": "string", "required": false, "description": "目标端口", "example": "80" }, { "name": "ProcessName", "type": "string", "required": false, "description": "进程名", "example": "nginx" }, { "name": "IsGlobal", "type": "integer", "required": false, "description": "是否全局规则(默认否)", "example": "1" }, { "name": "EventId", "type": "integer", "required": false, "description": "事件列表和详情点击加白时关联的事件id (新增规则时请留空)", "example": "12" }, { "name": "WhiteType", "type": "integer", "required": false, "description": "加白方式， 0:常规加白 1:正则加白", "example": "1" }, { "name": "RuleRegexp", "type": "string", "required": false, "description": "正则表达式", "example": "sh cmdline" }, { "name": "HandleHistory", "type": "integer", "required": false, "description": "处理历史事件， 0:不处理 1:处理", "example": "1" }, { "name": "GroupID", "type": "string", "required": false, "description": "批次id", "example": "85c909fe-c87c-11e9-a100-5cb90191ae78" } ], "required": [] }, { "name": "ModifyRiskDnsPolicy", "description": "更改恶意请求策略", "status": "online", "parameters": [ { "name": "Data", "type": "object", "required": true, "description": "策略", "example": "{\"Domains\": [\"d3d3LmF1dG90ZXN0LmNv****\"], \"HostIds\": [], \"HostScope\": 1, \"IsEnabled\": 0, \"PolicyAction\": 0, \"PolicyDesc\": \"\\u63a5\\u53e3\\u81ea\\u52a8\\u5316\\u6d4b\\u8bd5\", \"PolicyName\": \"auto_****\", \"PolicyType\": 1}", "children": [ { "name": "PolicyName", "type": "string", "required": true, "description": "策略名称", "example": "policyName" }, { "name": "PolicyType", "type": "integer", "required": true, "description": "策略类型[0:系统,1:用户]", "example": "1" }, { "name": "PolicyAction", "type": "integer", "required": true, "description": "策略动作[0:告警,1:放行,2:拦截+告警]", "example": "1" }, { "name": "HostScope", "type": "integer", "required": true, "description": "主机范围[1: 所有专业版+旗舰版|2:所有旗舰版|0: 部分主机]", "example": "1" }, { "name": "HostIds", "type": "array", "required": true, "description": "主机ID", "example": "[a7c573cb-c228-4211-85e3-64e000f159a5]", "item_type": "string" }, { "name": "Domains", "type": "array", "required": true, "description": "域名,作为入参时需要进行base64 encode", "example": "[domainName1,domainName2]", "item_type": "string" }, { "name": "IsEnabled", "type": "integer", "required": true, "description": "是否生效[0:生效,1:不生效]", "example": "1" }, { "name": "PolicyId", "type": "integer", "required": false, "description": "策略ID", "example": "1" }, { "name": "PolicyDesc", "type": "string", "required": false, "description": "策略描述", "example": "接口自动化测试" }, { "name": "IsDealOldEvent", "type": "integer", "required": false, "description": "是否处理之前的事件[0:不处理|1:处理]", "example": "1" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间", "example": "2022-07-15 11:27:01" }, { "name": "EventId", "type": "integer", "required": false, "description": "事件ID", "example": "1" } ] } ], "required": [ "Data" ] }, { "name": "ModifyRiskDnsPolicyStatus", "description": "更改恶意请求策略状态", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "策略ID", "example": "5000001" }, { "name": "IsEnabled", "type": "integer", "required": true, "description": "是否生效[0:生效,1:不生效]", "example": "1" } ], "required": [ "PolicyId", "IsEnabled" ] }, { "name": "ModifyRiskEventsStatus", "description": "入侵检测所有事件的状态，包括：文件查杀，异常登录，密码破解，高危命令，反弹shell，本地提取", "status": "online", "parameters": [ { "name": "Operate", "type": "integer", "required": true, "description": "操作-0:标记已处理,1:忽略,2:删除记录,3:木马隔离,4:木马恢复隔离,5:木马信任,6:木马取消信任,7:查杀异常进程,8:加入白名单", "example": "1" }, { "name": "RiskType", "type": "string", "required": true, "description": "操作事件类型，文件查杀：MALWARE，异常登录：HOST_LOGIN，密码破解：BRUTE_ATTACK，恶意请求：MALICIOUS_REQUEST，高危命令：BASH_EVENT，本地提权：PRIVILEGE_EVENT，反弹shell：REVERSE_SHELL. 异常进程:PROCESS", "example": "MALWARE" }, { "name": "Ids", "type": "array", "required": false, "description": "需要修改的事件id 数组，支持批量", "example": "[1,2]", "item_type": "integer" }, { "name": "UpdateAll", "type": "boolean", "required": false, "description": "是否更新全部，即是否对所有的事件进行操作，当ids 不为空时，此参数无效", "example": "false" }, { "name": "ExcludeId", "type": "array", "required": false, "description": "排除的事件id,当操作全部事件时，需要排除这次id", "example": "[1,2]", "item_type": "integer" }, { "name": "KillProcess", "type": "boolean", "required": false, "description": "当Operate 是木马隔离时，表示是否要杀进程，其他操作无效", "example": "true" }, { "name": "Ip", "type": "array", "required": false, "description": "当RiskType 为异地登录且ids为空时，可以修改所有来源ip的事件的状态", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。RiskType为 MALWARE时 1、当RiskType为 MALWARE时： IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 FilePath - String - 是否必填：否 - 路径筛选 VirusName - String - 是否必填：否 - 描述筛选 CreateBeginTime - String - 是否必填：否 - 创建时间筛选-开始时间 CreateEndTime - String - 是否必填：否 - 创建时间筛选-结束时间 Status - String - 是否必填：否 - 状态筛选 4待处理,5信任,6已隔离,10隔离中,11...", "example": "[{\"Name\":\"Status\",\"Values\":[\"4\"]}] ", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "Name" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"value\"]", "item_type": "string" }, { "name": "ExactMatch", "type": "boolean", "required": false, "description": "是否模糊匹配，前端框架会带上，可以不管", "example": "false" } ] }, { "name": "DoClean", "type": "boolean", "required": false, "description": "当Operate 是木马隔离时 本操作会修复被篡改的系统命令，计划任务等系统文件，操作中请确保yum/apt 可用。", "example": "false" } ], "required": [ "Operate", "RiskType" ] }, { "name": "ModifyUsersConfig", "description": "用于创建/修改用户自定义配置", "status": "online", "parameters": [ { "name": "ConfigName", "type": "string", "required": true, "description": "配置名称 license_monitor 新增授权监控配置 0 关闭, 1开启", "example": "license_mon****" }, { "name": "ConfigValue", "type": "string", "required": true, "description": "配置值", "example": "1" } ], "required": [ "ConfigName", "ConfigValue" ] }, { "name": "ModifyVulDefenceEventStatus", "description": "修改漏洞防御事件状态（修复漏洞通过其他接口实现）", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "事件id", "example": "[13654,13655]", "item_type": "integer" }, { "name": "Status", "type": "integer", "required": true, "description": "0: 待处理 2:已处理 3: 已忽略 4: 已删除", "example": "3" } ], "required": [ "Ids", "Status" ] }, { "name": "ModifyVulDefenceSetting", "description": "修改漏洞防御插件设置 1）新增主机自动加入，scope为1，quuids为空 2）全量旗舰版不自动加入，scope为0，quuids为当前quuid列表， 3）给定quuid列表，scope为0，quuids为用户选择quuid", "status": "online", "parameters": [ { "name": "Enable", "type": "integer", "required": true, "description": "防御开关，0 关闭 1 开启", "example": "1" }, { "name": "Scope", "type": "integer", "required": true, "description": "1 全部旗舰版主机，0 Quuids列表主机", "example": "1" }, { "name": "Quuids", "type": "array", "required": false, "description": "作用范围内旗舰版主机列表", "example": "[\"d92d723e-4aac-4f4a-bbf9-e5430e29d289\"]", "item_type": "string" }, { "name": "ExcludeInstanceIds", "type": "array", "required": false, "description": "排除作用范围内旗舰版主机列表", "example": "[\"d92d\"]", "item_type": "string" }, { "name": "AutoInclude", "type": "integer", "required": false, "description": "新增资产自动包含 0 不包含 1包含", "example": "1" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "作用范围内旗舰版主机列表", "example": "[\"d92d7\"]", "item_type": "string" } ], "required": [ "Enable", "Scope" ] }, { "name": "ModifyWarningHostConfig", "description": "修改告警机器范围配置", "status": "online", "parameters": [ { "name": "Type", "type": "integer", "required": true, "description": "告警类型", "example": "1" }, { "name": "HostRange", "type": "integer", "required": true, "description": "告警主机范围类型，0:全部主机，1:按所属项目选，2:按腾讯云标签选，3:按主机安全标签选，4:自选主机", "example": "1" }, { "name": "ItemLabels", "type": "array", "required": false, "description": "项目或标签的名称列表，自选主机时为空", "example": "[\"labela\"]", "item_type": "string" }, { "name": "Quuids", "type": "array", "required": false, "description": "机器列表", "example": "[\"quuidA\"]", "item_type": "string" }, { "name": "ItemLabelIds", "type": "array", "required": false, "description": "项目或标签的id列表，自选主机时为空", "example": "[\"itemlabel\"]", "item_type": "string" }, { "name": "ExcludedQuuids", "type": "array", "required": false, "description": "需排除的机器列表", "example": "[\"quuidB\"]", "item_type": "string" } ], "required": [ "Type", "HostRange" ] }, { "name": "ModifyWarningSetting", "description": "修改告警设置", "status": "online", "parameters": [ { "name": "WarningObjects", "type": "array", "required": true, "description": "修改告警设置的内容", "example": "[{\"BeginTime\": \"00:00\", \"ControlBits\": \"100\", \"DisablePhoneWarning\": 0, \"EndTime\": \"23:59\", \"HostRange\": 0, \"Type\": 6}]", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": false, "description": "事件告警类型；1：离线，2：木马，3：异常登录，4：爆破，5：漏洞（已拆分为9-12四种类型）6：高危命令，7：反弹sell，8：本地提权，9：系统组件漏洞，10：web应用漏洞，11：应急漏洞，12：安全基线，14：恶意请求，15: 网络攻击，16：Windows系统漏洞，17：Linux软件漏洞", "example": "2" }, { "name": "DisablePhoneWarning", "type": "integer", "required": false, "description": "1: 关闭告警 0: 开启告警", "example": "1" }, { "name": "BeginTime", "type": "string", "required": false, "description": "开始时间，格式: HH:mm", "example": "19:17:28" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，格式: HH:mm", "example": "19:17:28" }, { "name": "ControlBits", "type": "string", "required": false, "description": "漏洞等级控制位二进制，每一位对应页面漏洞等级的开启关闭：低中高（0:关闭；1：开启），例如：101 → 同时勾选低+高；01→(登录审计)疑似不告警，高危告警", "example": "101" }, { "name": "HostRange", "type": "integer", "required": false, "description": "告警主机范围类型，0:全部主机，1:按所属项目选，2:按腾讯云标签选，3:按主机安全标签选，4:自选主机", "example": "0" }, { "name": "Unit", "type": "string", "required": false, "description": "单位", "example": "minute" } ] } ], "required": [ "WarningObjects" ] }, { "name": "ModifyWebHookPolicy", "description": "新增或修改告警策略", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "id", "example": "10001" }, { "name": "Name", "type": "string", "required": false, "description": "策略名称", "example": "None" }, { "name": "Events", "type": "array", "required": false, "description": "事件类型", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "事件类型", "example": "6" }, { "name": "ControlBit", "type": "string", "required": true, "description": "事件内容", "example": "100" } ] }, { "name": "HostLabels", "type": "array", "required": false, "description": "主机范围", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "主机范围[1:所属项目|2:腾讯云标签|3:主机安全标签|4:自选]空数组为全部", "example": "1" }, { "name": "Values", "type": "array", "required": true, "description": "主机项目或标签内容", "example": "[\"tag_value\"]", "item_type": "string" } ] }, { "name": "Receivers", "type": "array", "required": false, "description": "接收人", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "integer", "required": false, "description": "id", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "接收人名称", "example": "告警webhook" }, { "name": "Addr", "type": "string", "required": false, "description": "webhook地址", "example": "www.webhook.com" }, { "name": "Type", "type": "integer", "required": false, "description": "类型", "example": "0" }, { "name": "SCFRegion", "type": "string", "required": false, "description": "目标地域", "example": "ap-guangzhou" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "ns" }, { "name": "FunctionName", "type": "string", "required": false, "description": "函数名称", "example": "fn" }, { "name": "FunctionVersion", "type": "string", "required": false, "description": "版本", "example": "latest" }, { "name": "Alias", "type": "string", "required": false, "description": "别名", "example": "alias" } ] }, { "name": "Format", "type": "integer", "required": false, "description": "格式 0text 1json", "example": "0" }, { "name": "CustomFields", "type": "array", "required": false, "description": "自定义透传字段", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "key", "example": "key_name" }, { "name": "Value", "type": "string", "required": true, "description": "value", "example": "vaule_mark" } ] }, { "name": "IsDisabled", "type": "integer", "required": false, "description": "是否启用[1:禁用|0:启用]", "example": "0" }, { "name": "Quuids", "type": "array", "required": false, "description": "主机列表", "example": "[\"quuidA\"]", "item_type": "string" }, { "name": "ExcludedQuuids", "type": "array", "required": false, "description": "需排除的机器列表", "example": "[\"quuidB\"]", "item_type": "string" }, { "name": "MsgLanguage", "type": "string", "required": false, "description": "推送语言类型，中文zh，英文en", "example": "zh" } ], "required": [] }, { "name": "ModifyWebHookPolicyStatus", "description": "修改告警策略开关", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "id", "example": "465" }, { "name": "IsDisabled", "type": "integer", "required": false, "description": "开关, 1禁用 0启用", "example": "1" } ], "required": [ "Id" ] }, { "name": "ModifyWebHookReceiver", "description": "新增或更新告警接收人", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "id", "example": "10001" }, { "name": "Name", "type": "string", "required": false, "description": "接收人名称", "example": "None" }, { "name": "Addr", "type": "string", "required": false, "description": "webhook地址", "example": "http://apitest1730427609****" }, { "name": "IsModify", "type": "boolean", "required": false, "description": "是否修改", "example": "false" }, { "name": "Type", "type": "integer", "required": false, "description": "类型", "example": "0" }, { "name": "SCFRegion", "type": "string", "required": false, "description": "目标地域", "example": "ap-guangzhou" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "default" }, { "name": "FunctionName", "type": "string", "required": false, "description": "函数名称", "example": "flask_demo" }, { "name": "FunctionVersion", "type": "string", "required": false, "description": "函数版本", "example": "latest" }, { "name": "Alias", "type": "string", "required": false, "description": "别名", "example": "alias" } ], "required": [] }, { "name": "ModifyWebHookRule", "description": "新增或修改企微机器人规则", "status": "online", "parameters": [ { "name": "Data", "type": "object", "required": true, "description": "规则内容", "example": "{\"RuleName\":\"测试机器人\",\"HookAddr\":\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=747c393e\",\"RuleRemark\":\"\",\"RuleItems\":[{\"Type\":2,\"ControlBit\":\"01111\"}],\"HostLabels\":[],\"IsDisabled\":1,\"RuleId\":55}", "children": [ { "name": "RuleName", "type": "string", "required": true, "description": "规则名称", "example": "rule_name" }, { "name": "HookAddr", "type": "string", "required": true, "description": "机器人地址", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=cbe03861-a8c6-48df-e34c-******" }, { "name": "RuleItems", "type": "array", "required": true, "description": "事件类型", "example": "[{\"Type\":11,\"ControlBit\":\"01111\"}]", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "事件类型", "example": "6" }, { "name": "ControlBit", "type": "string", "required": true, "description": "事件内容", "example": "100" } ] }, { "name": "RuleId", "type": "integer", "required": false, "description": "规则Id", "example": "10001" }, { "name": "RuleRemark", "type": "string", "required": false, "description": "备注信息", "example": "备注" }, { "name": "HostLabels", "type": "array", "required": false, "description": "主机范围", "example": "[{\"Type\":4,\"Values\":[]}]", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "主机范围[1:所属项目|2:腾讯云标签|3:主机安全标签|4:自选]空数组为全部", "example": "1" }, { "name": "Values", "type": "array", "required": true, "description": "主机项目或标签内容", "example": "[\"tag_value\"]", "item_type": "string" } ] }, { "name": "HostIds", "type": "array", "required": false, "description": "主机Id列表", "example": "[\"747c393e-f771-47ca-af1a-cc36b88f107a\"]", "item_type": "string" }, { "name": "IsDisabled", "type": "integer", "required": false, "description": "是否启用[1:禁用|0:启用]", "example": "1" } ] } ], "required": [ "Data" ] }, { "name": "ModifyWebHookRuleStatus", "description": "修改企微机器人规则状态", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "规则Id", "example": "1" }, { "name": "IsDisabled", "type": "integer", "required": true, "description": "开启状态[0:开启|1:关闭]", "example": "0" } ], "required": [ "Id", "IsDisabled" ] }, { "name": "ModifyWebPageProtectDir", "description": "创建/修改网站防护目录", "status": "online", "parameters": [ { "name": "ProtectDirAddr", "type": "string", "required": true, "description": "网站防护目录地址", "example": "/var/www" }, { "name": "ProtectDirName", "type": "string", "required": true, "description": "网站防护目录名称", "example": "www防护" }, { "name": "ProtectFileType", "type": "string", "required": true, "description": "防护文件类型,分号分割 ;", "example": ".html;.php" }, { "name": "HostConfig", "type": "array", "required": true, "description": "防护机器列表信息", "example": "[{\"AutoRecovery\": 0, \"ProtectSwitch\": 0, \"Quuid\": \"15c76928-e4e1-4f0d-8a2a-46c7de78****\"}]", "item_type": "object", "children": [ { "name": "Quuid", "type": "string", "required": true, "description": "机器唯一ID", "example": "15c76928-e4e1-4f0d-8a2a-46c7de78****" }, { "name": "ProtectSwitch", "type": "integer", "required": true, "description": "防护开关 0 关闭 1开启", "example": "0" }, { "name": "AutoRecovery", "type": "integer", "required": true, "description": "自动恢复开关 0 关闭 1开启", "example": "0" } ] } ], "required": [ "ProtectDirAddr", "ProtectDirName", "ProtectFileType", "HostConfig" ] }, { "name": "ModifyWebPageProtectSetting", "description": "修改网站防护设置", "status": "online", "parameters": [ { "name": "ModifyType", "type": "integer", "required": true, "description": "需要操作的类型1 目录名称 2 防护文件类型", "example": "1" }, { "name": "Value", "type": "string", "required": true, "description": "提交值", "example": "网站名称1" }, { "name": "Id", "type": "string", "required": true, "description": "配置对应的protect_path", "example": "var" } ], "required": [ "ModifyType", "Value", "Id" ] }, { "name": "ModifyWebPageProtectSwitch", "description": "网站防篡改防护设置开关", "status": "online", "parameters": [ { "name": "SwitchType", "type": "integer", "required": true, "description": "开关类型 1 防护开关 2 自动恢复开关 3 移除防护目录", "example": "1" }, { "name": "Ids", "type": "array", "required": true, "description": "需要操作开关的网站 最大100条", "example": "[\"website\"]", "item_type": "string" }, { "name": "Status", "type": "integer", "required": false, "description": "1 开启 0 关闭 SwitchType 为 1 | 2 必填;", "example": "1" } ], "required": [ "SwitchType", "Ids" ] }, { "name": "RansomDefenseRollback", "description": "防勒索快照回滚", "status": "online", "parameters": [ { "name": "BackupTime", "type": "string", "required": true, "description": "快照时间", "example": "2022-11-11 11:00:00" }, { "name": "Quuid", "type": "string", "required": false, "description": "主机Quuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "DiskInfo", "type": "string", "required": false, "description": "需要回滚的硬盘信息，硬盘直接用;分隔，留空为全部已快照磁盘： disk-id1|disk-name1;disk-id2|disk-name2", "example": "diskId1|diskNam1;diskId2" } ], "required": [ "BackupTime" ] }, { "name": "RecoverMalwares", "description": "本接口（RecoverMalwares）用于批量恢复已经被隔离的木马文件。", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "木马Id数组（最大100条）", "example": "[1002,1003]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "RemoveLocalStorageItem", "description": "删除本地存储数据", "status": "online", "parameters": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "keyname" } ], "required": [ "Key" ] }, { "name": "RemoveMachine", "description": "删除主机所有记录，目前只支持非腾讯云主机，且需要主机在离线状态", "status": "online", "parameters": [ { "name": "Uuid", "type": "string", "required": true, "description": "主机Uuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" }, { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "1ce68339-8828-457f-b358-d5b1b34e4fe9" } ], "required": [ "Uuid", "Quuid" ] }, { "name": "RetryCreateSnapshot", "description": "快照创建失败时可以重试创建快照并且自动进行漏洞修复", "status": "online", "parameters": [ { "name": "FixId", "type": "integer", "required": true, "description": "修复任务id", "example": "12" }, { "name": "Quuid", "type": "string", "required": true, "description": "主机quuid", "example": "1c26308c-5493-4eaf-a817-112ec25f499e " }, { "name": "Id", "type": "integer", "required": true, "description": "任务进度返回的快照唯一Id", "example": "10003" } ], "required": [ "FixId", "Quuid", "Id" ] }, { "name": "RetryVulFix", "description": "修复失败时单独对某一个主机修复漏洞", "status": "online", "parameters": [ { "name": "FixId", "type": "integer", "required": true, "description": "漏洞id", "example": "1" }, { "name": "Quuid", "type": "string", "required": true, "description": "主机Quuid", "example": "1c26308c-5493-4eaf-a817-112ec25f499e" }, { "name": "VulId", "type": "integer", "required": false, "description": "漏洞id", "example": "2" }, { "name": "KbId", "type": "integer", "required": false, "description": "Kb Id", "example": "1" } ], "required": [ "FixId", "Quuid" ] }, { "name": "ScanAsset", "description": "资产指纹启动扫描", "status": "online", "parameters": [ { "name": "AssetTypeIds", "type": "array", "required": false, "description": "资产指纹类型id列表", "example": "1", "item_type": "integer" }, { "name": "Quuids", "type": "array", "required": false, "description": "Quuid列表", "example": "1", "item_type": "string" } ], "required": [] }, { "name": "ScanBaseline", "description": "基线检测与基线重新检测接口", "status": "online", "parameters": [ { "name": "StrategyIdList", "type": "array", "required": false, "description": "策略id数组(StrategyIdList与CategoryIdList和RuleIdList三选一)", "example": "[1105903]", "item_type": "integer" }, { "name": "CategoryIdList", "type": "array", "required": false, "description": "基线id数组(StrategyIdList与CategoryIdList和RuleIdList三选一)", "example": "[188]", "item_type": "integer" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "检测项id数组(StrategyIdList与CategoryIdList和RuleIdList三选一)", "example": "[40000000000054]", "item_type": "integer" }, { "name": "QuuidList", "type": "array", "required": false, "description": "选择StrategyIdList时，不需要填写，其他情况必填", "example": "[\"Quuid1\"]", "item_type": "string" }, { "name": "UuidList", "type": "array", "required": false, "description": "主机Uuid数组", "example": "[\"uuidA\",\"uuidB\"]", "item_type": "string" } ], "required": [] }, { "name": "ScanTaskAgain", "description": "ScanTaskAgain 重新开始扫描任务，可以指定机器", "status": "online", "parameters": [ { "name": "ModuleType", "type": "string", "required": true, "description": "模块类型 当前提供 Malware 木马 , Vul 漏洞 , Baseline 基线", "example": "Vul" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID", "example": "1" }, { "name": "QuuidList", "type": "array", "required": false, "description": "自选服务器时生效，主机quuid的string数组", "example": "[\"ea71992a-b484-4d9c-882a-419fb6d0****\"]", "item_type": "string" }, { "name": "TimeoutPeriod", "type": "integer", "required": false, "description": "扫描超时时长", "example": "60" } ], "required": [ "ModuleType", "TaskId" ] }, { "name": "ScanVul", "description": "漏洞一键检测", "status": "online", "parameters": [ { "name": "VulLevels", "type": "string", "required": true, "description": "危害等级：1-低危；2-中危；3-高危；4-严重 (多选英文;分隔)", "example": "1" }, { "name": "HostType", "type": "integer", "required": true, "description": "服务器分类：1:专业版服务器；2:自选服务器", "example": "1" }, { "name": "VulCategories", "type": "string", "required": false, "description": "漏洞类型：1: web-cms漏洞 2:应用漏洞 4: Linux软件漏洞 5: Windows系统漏洞 (多选英文;分隔)", "example": "1" }, { "name": "QuuidList", "type": "array", "required": false, "description": "自选服务器时生效，主机quuid的string数组", "example": "[\"69796250-2a3a-40ef-b418-676e677019a4\"]", "item_type": "string" }, { "name": "VulEmergency", "type": "integer", "required": false, "description": "是否是应急漏洞 0 否 1 是", "example": "1" }, { "name": "TimeoutPeriod", "type": "integer", "required": false, "description": "超时时长 单位秒 默认 3600 秒", "example": "1" }, { "name": "VulIds", "type": "array", "required": false, "description": "需要扫描的漏洞id", "example": "[1]", "item_type": "integer" }, { "name": "ScanMethod", "type": "integer", "required": false, "description": "0版本比对，2版本比对+poc", "example": "0" }, { "name": "KBNumber", "type": "array", "required": false, "description": "kb编号", "example": "[\"KB4545\"]", "item_type": "string" } ], "required": [ "VulLevels", "HostType" ] }, { "name": "ScanVulAgain", "description": "漏洞管理-重新检测接口", "status": "online", "parameters": [ { "name": "EventIds", "type": "string", "required": true, "description": "漏洞事件id串，多个用英文逗号分隔", "example": "1" }, { "name": "Uuids", "type": "string", "required": false, "description": "重新检查的机器uuid,多个逗号分隔", "example": "05f0bcab-726c-4ea4-8109-bcd03d5598f7" }, { "name": "EventType", "type": "integer", "required": false, "description": "0漏洞,1windows 补丁", "example": "0" } ], "required": [ "EventIds" ] }, { "name": "ScanVulSetting", "description": "定期扫描漏洞设置", "status": "online", "parameters": [ { "name": "TimerInterval", "type": "integer", "required": true, "description": "定期检测间隔时间（天）", "example": "1" }, { "name": "VulCategories", "type": "array", "required": false, "description": "漏洞类型：1: web-cms漏洞 2:应用漏洞 4: Linux软件漏洞 5: Windows系统漏洞, 以数组方式传参[1,2]", "example": "1", "item_type": "integer" }, { "name": "VulLevels", "type": "array", "required": false, "description": "危害等级：1-低危；2-中危；3-高危；4-严重,以数组方式传参[1,2,3]", "example": "1", "item_type": "integer" }, { "name": "TimerTime", "type": "string", "required": false, "description": "定期检测时间，如：02:10:50", "example": "02:10:50" }, { "name": "VulEmergency", "type": "integer", "required": false, "description": "是否是应急漏洞 0 否 1 是", "example": "1" }, { "name": "StartTime", "type": "string", "required": false, "description": "扫描开始时间，如：00:00", "example": "00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "扫描结束时间，如：08:00", "example": "01:59" }, { "name": "EnableScan", "type": "integer", "required": false, "description": "是否开启扫描 1开启 0不开启", "example": "1" }, { "name": "Uuids", "type": "array", "required": false, "description": "为空默认扫描全部专业版、旗舰版、轻量版主机，不为空只扫描选中主机", "example": "['']", "item_type": "string" }, { "name": "ScanMethod", "type": "integer", "required": false, "description": "0版本比对，2版本比对+poc", "example": "0" } ], "required": [ "TimerInterval" ] }, { "name": "SearchLog", "description": "查询日志", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "要检索分析的日志的起始时间，Unix时间戳（毫秒）", "example": "1656641065449" }, { "name": "EndTime", "type": "integer", "required": true, "description": "要检索分析的日志的结束时间，Unix时间戳（毫秒）", "example": "1656641965449" }, { "name": "QueryString", "type": "string", "required": true, "description": "检索分析语句，最大长度为12KB，查询语法可参考文档 https://cloud.tencent.com/document/product/296/50508", "example": "status: \"待处理\" AND public_ip_addresses: (1* OR 2*)" }, { "name": "Count", "type": "integer", "required": false, "description": "表示单次查询返回的原始日志条数，最大值为1000，获取后续日志需使用Context参数", "example": "20" }, { "name": "Sort", "type": "string", "required": false, "description": "原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc", "example": "desc" }, { "name": "Context", "type": "string", "required": false, "description": "透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时", "example": "search" } ], "required": [ "StartTime", "EndTime", "QueryString" ] }, { "name": "SeparateMalwares", "description": "本接口（SeparateMalwares）用于隔离木马。", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "木马事件ID数组。(最大100条)", "example": "[300005850594]", "item_type": "integer" }, { "name": "KillProcess", "type": "boolean", "required": false, "description": "是否杀掉进程", "example": "true" } ], "required": [ "Ids" ] }, { "name": "SetBashEventsStatus", "description": "设置高危命令事件状态", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "ID数组，最大100条。", "example": "[1,2]", "item_type": "integer" }, { "name": "Status", "type": "integer", "required": true, "description": "新状态(0-待处理 1-高危 2-正常)", "example": "1" } ], "required": [ "Ids", "Status" ] }, { "name": "SetLocalStorageExpire", "description": "设置本地存储过期时间", "status": "online", "parameters": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "key1" }, { "name": "Expire", "type": "integer", "required": true, "description": "过期时间（单位：秒）", "example": "5" } ], "required": [ "Key", "Expire" ] }, { "name": "SetLocalStorageItem", "description": "设置本地存储数据", "status": "online", "parameters": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "test_key" }, { "name": "Value", "type": "string", "required": true, "description": "值", "example": "test_val" }, { "name": "Expire", "type": "integer", "required": false, "description": "失效时间（单位；秒）", "example": "5" } ], "required": [ "Key", "Value" ] }, { "name": "StartBaselineDetect", "description": "检测基线", "status": "online", "parameters": [ { "name": "Param", "type": "object", "required": true, "description": "基线检测参数", "example": "{\"HostIds\": [\"df00265c-081a-4e47-8b92-3e59d902****\"], \"RuleIds\": [30]}", "children": [ { "name": "PolicyIds", "type": "array", "required": false, "description": "检测的策略集合", "example": "[101,102,103]", "item_type": "integer" }, { "name": "RuleIds", "type": "array", "required": false, "description": "检测的规则集合", "example": "[30]", "item_type": "integer" }, { "name": "ItemIds", "type": "array", "required": false, "description": "检测项集合", "example": "[1001,1002]", "item_type": "integer" }, { "name": "HostIds", "type": "array", "required": false, "description": "检测的主机ID集合", "example": "['df00265c-081a-4e47-8b92-3e59d902****']", "item_type": "string" } ] } ], "required": [ "Param" ] }, { "name": "StopAssetScan", "description": "停止资产扫描任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务Id", "example": "1" } ], "required": [ "TaskId" ] }, { "name": "StopBaselineDetect", "description": "停止基线检测", "status": "online", "parameters": [ { "name": "TaskIds", "type": "array", "required": true, "description": "取消任务ID集合", "example": "[1106788]", "item_type": "integer" } ], "required": [ "TaskIds" ] }, { "name": "StopNoticeBanTips", "description": "不再提醒爆破阻断提示弹窗", "status": "online", "parameters": [], "required": [] }, { "name": "SwitchBashRules", "description": "切换高危命令规则状态", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "规则ID", "example": "1" }, { "name": "Disabled", "type": "integer", "required": true, "description": "是否禁用", "example": "1" } ], "required": [ "Id", "Disabled" ] }, { "name": "SyncAssetScan", "description": "同步资产扫描信息", "status": "online", "parameters": [ { "name": "Sync", "type": "boolean", "required": true, "description": "是否同步：true-是 false-否；默认false", "example": "true" } ], "required": [ "Sync" ] }, { "name": "SyncBaselineDetectSummary", "description": "同步基线检测进度概要", "status": "online", "parameters": [ { "name": "TaskIds", "type": "array", "required": false, "description": "用于计算检测中和进度的任务ID集合，一般不用传入", "example": "[1024]", "item_type": "integer" } ], "required": [] }, { "name": "SyncMachines", "description": "同步机器信息", "status": "online", "parameters": [ { "name": "Sync", "type": "boolean", "required": false, "description": "是否同步", "example": "true" } ], "required": [] }, { "name": "TestWebHookRule", "description": "测试企微机器人规则", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "规则Id", "example": "20" }, { "name": "Data", "type": "string", "required": true, "description": "测试内容", "example": "接口测试请忽略" } ], "required": [ "Id", "Data" ] }, { "name": "TrustMalwares", "description": "本接口(TrustMalwares)将被识别木马文件设为信任。", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "木马ID数组（单次不超过的最大条数：100）", "example": "[300005556389]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "UntrustMalwares", "description": "本接口（UntrustMalwares）用于取消信任木马文件。", "status": "online", "parameters": [ { "name": "Ids", "type": "array", "required": true, "description": "木马ID数组 (最大100条)", "example": "[300005556389]", "item_type": "integer" } ], "required": [ "Ids" ] }, { "name": "UpdateBaselineStrategy", "description": "根据基线策略id更新策略信息", "status": "online", "parameters": [ { "name": "StrategyId", "type": "integer", "required": true, "description": "策略id", "example": "1" }, { "name": "StrategyName", "type": "string", "required": true, "description": "策略名称", "example": "name1" }, { "name": "ScanCycle", "type": "integer", "required": true, "description": "检测周期", "example": "1" }, { "name": "ScanAt", "type": "string", "required": true, "description": "定期检测时间，该时间下发扫描", "example": "00:00:00" }, { "name": "CategoryIds", "type": "array", "required": true, "description": "该策略下选择的基线id数组", "example": "[\"1002\"]", "item_type": "string" }, { "name": "IsGlobal", "type": "integer", "required": true, "description": "扫描范围是否全部服务器, 1:是 0:否, 为1则为全部专业版主机", "example": "1" }, { "name": "MachineType", "type": "string", "required": true, "description": "云主机类型： cvm：腾讯云服务器 bm：裸金属 ecm：边缘计算主机 lh:轻量应用服务器 other:混合云机器", "example": "CVM" }, { "name": "RegionCode", "type": "string", "required": true, "description": "主机地域 ap-guangzhou", "example": "ap-guangzhou" }, { "name": "Quuids", "type": "array", "required": true, "description": "主机id数组", "example": "[\"5a540076-d38a-4078-aa98-e7c86371d322\"]", "item_type": "string" } ], "required": [ "StrategyId", "StrategyName", "ScanCycle", "ScanAt", "CategoryIds", "IsGlobal", "MachineType", "RegionCode", "Quuids" ] }, { "name": "UpdateMachineTags", "description": "关联机器标签列表", "status": "online", "parameters": [ { "name": "Quuid", "type": "string", "required": true, "description": "机器 Quuid", "example": "24c9be55-c743-4a75-a5c7-2a2912341234" }, { "name": "TagIds", "type": "array", "required": false, "description": "标签ID，该操作会覆盖原有的标签列表", "example": "[115]", "item_type": "integer" }, { "name": "MachineRegion", "type": "string", "required": false, "description": "服务器地区 如: ap-guangzhou", "example": "ap-guangzhou" }, { "name": "MachineArea", "type": "string", "required": false, "description": "服务器类型(CVM|BM|ECM|LH|Other)", "example": "CVM" } ], "required": [ "Quuid" ] } ] }