{ "name": "ioa", "display_name": "iOA 零信任安全管理系统", "description": "iOA 云API接口", "domain": "other", "api_version": "2022-06-01", "endpoint": "ioa.tencentcloudapi.com", "actions": [ { "name": "CreateDLPFileDetectTask", "description": "创建文件鉴定任务，私有化调用path为：capi/DlpOpenApi/CreateDLPFileDetectTask", "status": "online", "parameters": [ { "name": "DownloadUrl", "type": "string", "required": true, "description": "文件下载Url", "example": "https://www.cos.com/downloadurl" }, { "name": "FileName", "type": "string", "required": true, "description": "文件名", "example": "test.txt" }, { "name": "FileMd5", "type": "string", "required": true, "description": "文件Md5", "example": "xavdaeraveageacaegeav" }, { "name": "BalanceType", "type": "integer", "required": true, "description": "负载类型 1 从GroupId中选一节点 鉴定 2使用所有SelectNodeIds节点鉴定", "example": "1" }, { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "SelectNodeIds", "type": "array", "required": false, "description": "选中节点唯一Id列表,BalanceType=2时必填", "example": "[\"lolocdsacsss\",\"dlocelodeead\"]", "item_type": "string" }, { "name": "GroupId", "type": "string", "required": false, "description": "节点组唯一Id,BalanceType=1时必填", "example": "caitealddaaveasf" } ], "required": [ "DownloadUrl", "FileName", "FileMd5", "BalanceType" ] }, { "name": "CreateDLPFileDetectionTask", "description": "提交送检任务", "status": "online", "parameters": [ { "name": "Url", "type": "string", "required": true, "description": "文件下载链接，要求公网可访问，GET方式访问后为文件", "example": "https://www.example.net/test.txt" }, { "name": "FileName", "type": "string", "required": true, "description": "文件名，带后缀", "example": "test.txt" }, { "name": "FileMd5", "type": "string", "required": true, "description": "文件md5，传入相同md5会直接使用之前缓存的结果。 \u003e 请注意：不同文件使用相同md5送检，会命中缓存得到旧的检测结果", "example": "aabba408088b6aea1601fe6823cef111" }, { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配", "example": "1" }, { "name": "CallBackUrl", "type": "string", "required": false, "description": "回调地址，暂时未使用", "example": "https://www.aaa.com/ID=123" } ], "required": [ "Url", "FileName", "FileMd5" ] }, { "name": "CreateDeviceTask", "description": "创建获取终端进程网络服务信息任务，私有化调用path为：capi/Assets/Device/DescribeDeviceInfo", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Mid", "type": "string", "required": false, "description": "终端id", "example": "无" } ], "required": [] }, { "name": "CreateDeviceVirtualGroup", "description": "创建终端自定义分组，私有化调用path为：/capi/Assets/Device/CreateDeviceVirtualGroup", "status": "online", "parameters": [ { "name": "DeviceVirtualGroupName", "type": "string", "required": true, "description": "必填，终端自定义分组名", "example": "分组名称1" }, { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "详情", "example": "此定义分组用于测试" }, { "name": "OsType", "type": "integer", "required": false, "description": "系统类型（0: win，1：linux，2: mac，4：android，5：ios ； 默认值0）(只支持32位)", "example": "0" }, { "name": "TimeType", "type": "integer", "required": false, "description": "分组类型（0:手动分组；非0为自动划分分组；具体枚举值为：1:自动每小时划分分组、2:自动每天划分分组、3:自定义时间划分分组； 默认值0）(只支持32位)", "example": "0" }, { "name": "AutoMinute", "type": "integer", "required": false, "description": "选填，TimeType=3时的自动划分时间，其他情况为0（单位min）(只支持32位)", "example": "10" }, { "name": "AutoRules", "type": "object", "required": false, "description": "选填，手动分组不填，自动划分分组的划分规则数据", "example": "无", "children": [ { "name": "SimpleRules", "type": "array", "required": false, "description": "简单规则表达式", "example": "{ \"Expressions\": [ { \"Relation\": \"\", \"Items\": [ { \"Operate\": \"等于\", \"Values\": [ \"Company assets\" ], \"Key\": \"profile_166\", \"error\": \"\" } ] } ] }", "item_type": "object", "children": [ { "name": "Expressions", "type": "array", "required": false, "description": "规则表达式", "example": "{ \"Expressions\": [ { \"Relation\": \"\", \"Items\": [ { \"Operate\": \"等于\", \"Values\": [ \"Company assets\" ], \"Key\": \"profile_166\", \"error\": \"\" } ] } ] }", "item_type": "object", "children": [ { "name": "Items", "type": "array", "required": false, "description": "规则元数据", "example": "{ \"Items\": [ { \"Operate\": \"等于\", \"Key\": \"profile_166\", \"Values\": [ \"Company assets\" ], \"error\": \"\" } ] }", "item_type": "string" }, { "name": "Relation", "type": "string", "required": false, "description": "关系", "example": "\"并且\"" } ] }, { "name": "Relation", "type": "string", "required": false, "description": "表达式间逻辑关系", "example": "等于" } ] }, { "name": "Relation", "type": "string", "required": false, "description": "表达式间逻辑关系", "example": "并且" } ] } ], "required": [ "DeviceVirtualGroupName" ] }, { "name": "CreatePrivilegeCode", "description": "生成特权码，私有化调用path为：capi/Assets/Device/CreatePrivilegeCode，生成的特权码、卸载码，仅对该设备当天有效", "status": "online", "parameters": [ { "name": "Mid", "type": "string", "required": true, "description": "必填；设备唯一标识符;", "example": "489C698CAECC13B1B7C44E59443F5CBB676B7F33" }, { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "OsType", "type": "integer", "required": false, "description": "系统类型（0: win，1：linux，2: mac，4：android，5：ios ）；默认值0", "example": "0" } ], "required": [ "Mid" ] }, { "name": "DescribeAccountGroups", "description": "以分页的方式查询账号分组列表，私有化调用path为：/capi/Assets/DescribeAccountGroups", "status": "online", "parameters": [ { "name": "Deepin", "type": "integer", "required": false, "description": "搜索范围：0-仅当前分组的直接子组，1-当前分组的所有子组。默认为0。", "example": "0" }, { "name": "Condition", "type": "object", "required": false, "description": "查询条件 过滤参数 1、Name，string类型，按分组名过滤 是否必填：否 操作符: like 排序条件 1、Itime，string类型，按分组创建时间排序 是否必填：否 2、Utime，string类型，按分组更新时间排序 是否必填：否", "example": "{ \"Filters\": [ { \"Field\": \"Name\", \"Operator\": \"like\", \"Values\": [ \"研发\" ] } ] }", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "ParentId", "type": "integer", "required": false, "description": "父分组ID，获取该分组下的子组信息。默认查询全网根分组下子组信息。", "example": "82119" } ], "required": [] }, { "name": "DescribeAggrSoftCategorySoftList", "description": "聚合的分类软件列表", "status": "online", "parameters": [ { "name": "Condition", "type": "object", "required": false, "description": "过滤条件、分页参数Name - String - 过滤支持：是 - 操作符:eq,neq,like,ilike,nlike - 排序支持：是 - 按类别名称过滤或排序。CorpName - String - 过滤支持：是 - 操作符:eq,neq,like,ilike,nlike - 排序支持：是 - 按CorpName过滤或排序。Version - String - 过滤支持：否 - 操作符:eq,like - 排序支持：是 - 按版本排序。InstalledDeviceCount - int - 过滤支持：否 - 操作符:eq,like - 排序支持：是 - 按安装设备数量排序\ufffd\ufffd...", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "OsType", "type": "integer", "required": false, "description": "操作系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0）", "example": "0" } ], "required": [] }, { "name": "DescribeAggrSoftDetail", "description": "聚合的软件详情", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "软件名称", "example": "无" }, { "name": "OsType", "type": "integer", "required": false, "description": "操作系统", "example": "无" } ], "required": [] }, { "name": "DescribeAggrSoftDeviceList", "description": "聚合软件的已安装终端列表", "status": "online", "parameters": [ { "name": "Condition", "type": "object", "required": false, "description": "过滤条件", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "Name", "type": "string", "required": false, "description": "软件名", "example": "微信" }, { "name": "OsType", "type": "integer", "required": false, "description": "0:win 2:mac", "example": "0" }, { "name": "GroupId", "type": "integer", "required": false, "description": "分组ID", "example": "0" }, { "name": "GroupType", "type": "integer", "required": false, "description": "分组类型 1-终端分组 2-组织架构(账号分组) 3/4-虚拟分组", "example": "0" } ], "required": [] }, { "name": "DescribeDLPEdgeNodeGroups", "description": "查询边缘节点分组，私有化调用path为：capi/Connectors/DescribeDLPEdgeNodeGroups", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ], "required": [] }, { "name": "DescribeDLPEdgeNodes", "description": "查询边缘节点列表，私有化调用path为：capi/DlpOpenApi/DescribeDLPEdgeNodes", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件、分页参数EdgeNodeName - string - 是否必填：否 - 操作符: ilike - 排序支持：否- 按节点名称过滤。", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ], "required": [] }, { "name": "DescribeDLPFileDetectResult", "description": "webservice查询文件检测结果", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "QueryID", "type": "string", "required": false, "description": "查询ID，即提交送检任务接口（CreateDLPFileDetectionTask）返回的任务ID（DLPFileDetectionTaskID）", "example": "053a8fe1-150f-434c-b8e9-f1d7804ded1f" } ], "required": [] }, { "name": "DescribeDLPFileDetectTaskResult", "description": "查询文件鉴定任务结果", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "TaskRequestId", "type": "string", "required": false, "description": "任务请求Id", "example": "dfsvadfs121312asdaf" } ], "required": [] }, { "name": "DescribeDeviceChildGroups", "description": "查询设备组子分组详情，私有化调用path为：capi/Assets/Device/DescribeDeviceChildGroups", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件参数（字段含义请参考接口返回值） - Name, 类型String，支持操作：【like，ilike】，支持排序 分页参数 - PageNum 从1开始，小于等于0时使用默认参数 - PageSize 最大值5000，最好不超过100", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "ParentId", "type": "integer", "required": false, "description": "父分组id，默认0：表示获取全网终端分组", "example": "0" }, { "name": "OsType", "type": "integer", "required": false, "description": "操作系统类型（0：win，1：linux，2：mac，4：android，5：ios；默认0：系统win）", "example": "0" } ], "required": [] }, { "name": "DescribeDeviceDetailList", "description": "基于软件查看终端详情列表,私有化调用path为：capi/Software/DescribeDeviceDetailList", "status": "online", "parameters": [ { "name": "OsType", "type": "integer", "required": false, "description": "系统类型(只支持32位)", "example": "无" }, { "name": "GroupId", "type": "integer", "required": false, "description": "终端分组id(只支持32位)", "example": "无" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件、分页参数 Name - String - 过滤支持：是 - 操作符:eq,like - 排序支持：是 。", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ], "required": [] }, { "name": "DescribeDeviceHardwareInfoList", "description": "查询满足条件的查询终端硬件信息列表，私有化调用path为：/capi/Assets/Device/DescribeDeviceHardwareInfoList", "status": "online", "parameters": [ { "name": "GroupId", "type": "integer", "required": true, "description": "【必填】设备分组id（需要和OsType匹配），下面是私有化场景下默认id：id-名称-操作系统1 全网终端 Win2 未分组终端 Win30000000 服务器 Win40000101 全网终端 Linux40000102 未分组终端 Linux40000103 服务器 Linux40000201 全网终端 macOS40000202 未分组终端 macOS40000203 服务器 macOS40000401 全网终端 Android40000402 未分组终端 Android40000501 全网终端 iOS40000502 未分组终端 iOSSaaS需要调用分组接口DescribeDeviceChild...", "example": "93" }, { "name": "OsType", "type": "integer", "required": true, "description": "【必填】操作系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0），需要和GroupId或者GroupIds匹配", "example": "0" }, { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件参数（字段含义请参考接口返回值） - Name, 类型String，支持操作：【eq，like，ilike】，支持排序 - UserName, 类型String，支持操作：【eq，like，ilike】，支持排序 - IoaUserName，类型String，支持操作：【eq，like，ilike】，支持排序 - MacAddr, 类型String，支持操作：【eq，like，ilike】，支持排序 - Ip, 类型String，支持操作：【eq，like，ilike】，支持排序 - Mid, 类型String，支持操作：【e...", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ], "required": [ "GroupId", "OsType" ] }, { "name": "DescribeDeviceInfo", "description": "获取终端进程网络服务信息，私有化调用path为：capi/Assets/Device/DescribeDeviceInfo", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Mid", "type": "string", "required": false, "description": "终端id", "example": "无" }, { "name": "Type", "type": "string", "required": false, "description": "查询类型 process_list network_list service_list", "example": "无" } ], "required": [] }, { "name": "DescribeDeviceVirtualGroups", "description": "查询终端自定义分组列表，私有化调用path为：/capi/Assets/Device/DescribeDeviceVirtualGroups", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Condition", "type": "object", "required": false, "description": "滤条件、分页参数 Name - String - 是否必填：否 - 操作符: like - 排序支持：否- 按终端自定义分组过滤。 DeviceVirtualGroupName - String - 是否必填：否 - 操作符: like - 排序支持：否- 按终端自定义分组过滤。", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "OsType", "type": "integer", "required": false, "description": "系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0）", "example": "0" }, { "name": "VirtualGroupIds", "type": "array", "required": false, "description": "非必填，自定义分组ids", "example": "[10307]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeDevices", "description": "查询满足条件的终端数据详情，私有化调用path为：/capi/Assets/Device/DescribeDevices", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件参数（字段含义请参考接口返回值） - Mid, 类型String，支持操作：【eq，like，ilike】，支持排序 - Name, 类型String，支持操作：【eq，like，ilike】，支持排序 - Itime, 类型String，支持操作：【eq，like，ilike】，支持排序 - UserName, 类型String，支持操作：【eq，like，ilike】，支持排序 - MacAddr, 类型String，支持操作：【eq，like，ilike】，支持排序 - UserId, 类型String，支持操作：【eq\ufffd\ufffd...", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "GroupId", "type": "integer", "required": false, "description": "【和GroupIds必须有一个填写】设备分组id（需要和OsType匹配），下面是私有化场景下默认id： id-名称-操作系统 1 全网终端 Win 2 未分组终端 Win 30000000 服务器 Win 40000101 全网终端 Linux 40000102 未分组终端 Linux 40000103 服务器 Linux 40000201 全网终端 macOS 40000202 未分组终端 macOS 40000203 服务器 macOS 40000401 全网终端 Android 40000402 未分组终端 Android 40000501 全网终端 iOS 40000502 未分组终端 iOS SaaS\ufffd\ufffd...", "example": "93" }, { "name": "OsType", "type": "integer", "required": false, "description": "操作系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0），需要和GroupId或者GroupIds匹配", "example": "0" }, { "name": "OnlineStatus", "type": "integer", "required": false, "description": "在线状态 （2表示在线，0或者1表示离线）", "example": "2" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件--兼容旧接口,参数同Condition", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "Sort", "type": "object", "required": false, "description": "排序字段--兼容旧接口,参数同Condition", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageNum", "type": "integer", "required": false, "description": "获取第几页--兼容旧接口,参数同Condition", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页获取数--兼容旧接口,参数同Condition", "example": "20" }, { "name": "Status", "type": "integer", "required": false, "description": "授权状态： 4基础授权 5高级授权", "example": "4" }, { "name": "GroupIds", "type": "array", "required": false, "description": "【和GroupId必须有一个填写】设备分组id列表（需要和OsType匹配）", "example": "[93]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeLocalAccounts", "description": "获取账号列表，支持分页，模糊搜索，私有化调用path为：/capi/Assets/Account/DescribeLocalAccounts", "status": "online", "parameters": [ { "name": "Condition", "type": "object", "required": false, "description": "查询条件：过滤或排序 1、UserName，string类型，姓名 是否必填：否 过滤支持：是，支持eq、like、ilike 排序支持：否 2、UserId，string类型，账户 是否必填：否 过滤支持：是，支持eq、like、ilike 排序支持：否 3、Phone，string类型，手机号 是否必填：否 过滤支持：是，支持eq、like、ilike 排序支持：否", "example": "{ \"FilterGroups\": [ { \"Filters\": [ { \"Field\": \"UserId\", \"Operator\": \"ilike\", \"Values\": [ \"weiwang\" ] } ] } ], \"PageNum\": 1, \"PageSize\": 10 }", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "AccountGroupId", "type": "integer", "required": false, "description": "获取账号的分组ID，不传默认获取全网根账号组", "example": "249973" }, { "name": "ShowFlag", "type": "integer", "required": false, "description": "是否仅展示当前目录下用户 1： 递归显示 2：仅显示当前目录下用户", "example": "2" } ], "required": [] }, { "name": "DescribeRootAccountGroup", "description": "查询账号根分组详情。对应“用户与授权管理”里内置不可见的全网根账号组，所有新建的目录，都挂在该全网根账号组下。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSoftCensusListByDevice", "description": "查看终端树下的软件列表,私有化调用path为：capi/Software/DescribeSoftCensusListByDevice", "status": "online", "parameters": [ { "name": "GroupId", "type": "integer", "required": true, "description": "必填，终端分组ID", "example": "11668614" }, { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "OsType", "type": "integer", "required": false, "description": "系统类型（0: win，1：linux，2: mac，4：android，5：ios ）；默认值0", "example": "0" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件、分页参数 Name - String - 是否必填：否 - 操作符: eq,like,ilike - 排序支持：否 - 备注：字段含义，终端名。 UserName - String - 是否必填：否 - 操作符: eq,like,ilike - 排序支持：否 - 备注：字段含义，终端用户名。 IoaUserName - String - 是否必填：否 - 操作符: eq,like,ilike - 排序支持：否 - 备注：字段含义，最近登录账号。 Ip - String - 是否必填：否 - 操作符: eq,like,ilike - 排序支持：否...", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ], "required": [ "GroupId" ] }, { "name": "DescribeSoftwareInformation", "description": "查看指定终端的软件详情列表,私有化调用path为：capi/Software/DescribeSoftwareInformation", "status": "online", "parameters": [ { "name": "Mid", "type": "string", "required": false, "description": "终端唯一标识Mid", "example": "B454307F6CA03B56E0CFEC44EABF93BB67E56D6F" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件、分页参数 Name - String - 过滤支持：是 - 操作符:eq,like - 排序支持：是 。", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "OsType", "type": "integer", "required": false, "description": "0:win 2:mac", "example": "0" } ], "required": [] }, { "name": "DescribeVirtualDevices", "description": "展示自定义分组终端列表，私有化调用path为：/capi/Assets/DescribeVirtualDevices", "status": "online", "parameters": [ { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件参数（字段含义请参考接口返回值）- Mid, 类型String，支持操作：【eq，like，ilike】，支持排序- Name, 类型String，支持操作：【eq，like，ilike】，支持排序- Itime, 类型String，支持操作：【eq，like，ilike】，支持排序- UserName, 类型String，支持操作：【eq，like，ilike】，支持排序- MacAddr, 类型String，支持操作：【eq，like，ilike】，支持排序- UserId, 类型String，支持操作：【eq，like\ufffd...", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "DeviceVirtualGroupId", "type": "integer", "required": false, "description": "终端自定义分组ID（0：获取租户全部自定义分组下的终端数据；其他值：获取具体ID分组下的终端数据）", "example": "14990" }, { "name": "OsType", "type": "integer", "required": false, "description": "系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0）", "example": "0" }, { "name": "OnlineStatus", "type": "integer", "required": false, "description": "选填，在线状态 （2表示在线，0或者1表示离线）", "example": "2" } ], "required": [] }, { "name": "ExportDeviceDownloadTask", "description": "创建终端导出任务，私有化调用path为：capi/Assets/Device/ExportDeviceDownloadTask", "status": "online", "parameters": [ { "name": "OsType", "type": "integer", "required": false, "description": "系统类型（0: win，1：linux，2: mac，4：android，5：ios；默认值0）", "example": "0" }, { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "GroupId", "type": "integer", "required": false, "description": "分组id", "example": "1120" }, { "name": "OnlineStatus", "type": "integer", "required": false, "description": "在线状态 2 在线 0，1 离线", "example": "0" }, { "name": "ExportOrder", "type": "string", "required": false, "description": "导出顺序，接口返回的数据字段", "example": "Name,RemarkName,IOAUserName,AccountName,UserName,LocalIpList,Ip,Mid,VulVersion,SysRepVersion,VirusVer,Os,Tags,SerialNum,AccountList,BaseBoardSn,MacAddr,GroupName,StrVersion,DomainName" }, { "name": "ExportType", "type": "integer", "required": false, "description": "导出类型， 0：终端树；7:硬件信息列表导出；", "example": "0" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件。同DescribeDevices接口", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ], "required": [] }, { "name": "ExportSoftwareInformationList", "description": "导出基于指定终端查看软件信息详情列表查询,私有化调用path为：capi/Software/ExportSoftwareInformationList", "status": "online", "parameters": [ { "name": "Mid", "type": "string", "required": false, "description": "终端唯一标识Mid", "example": "1" }, { "name": "Condition", "type": "object", "required": false, "description": "过滤条件、分页参数 Name - String - 过滤支持：是 - 操作符:eq,like - 排序支持：是 。", "example": "无", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] }, { "name": "FilterGroups", "type": "array", "required": false, "description": "FilterGroups 条件过滤组", "example": "无", "item_type": "object", "children": [ { "name": "Filters", "type": "array", "required": false, "description": "Filters 条件过滤", "example": "[ { \"Field\": \"Client.Account\", \"Values\": [ \"zhangsan\" ], \"Operator\": \"like\", \"Describe\": \"登录账号：zhangsan\" }, { \"Field\": \"Client.OSType\", \"Values\": [ \"0\" ], \"Operator\": \"eq\", \"Describe\": \"终端类型：Windows\" } ]", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": false, "description": "过滤字段", "example": "Name" }, { "name": "Operator", "type": "string", "required": false, "description": "过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定", "example": "eq" }, { "name": "Values", "type": "array", "required": false, "description": "过滤条件", "example": "[\"张三\", \"zhansan\"]", "item_type": "string" } ] } ] }, { "name": "Sort", "type": "object", "required": false, "description": "Sort 排序字段", "example": "无", "children": [ { "name": "Field", "type": "string", "required": false, "description": "排序字段", "example": "UserName" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式", "example": "desc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "PageSize 每页获取数(只支持32位)", "example": "20" }, { "name": "PageNum", "type": "integer", "required": false, "description": "PageNum 获取第几页(只支持32位)", "example": "3" }, { "name": "RulePayload", "type": "object", "required": false, "description": "复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Groups", "type": "array", "required": false, "description": "条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "FieldKey", "type": "string", "required": false, "description": "字段Key 注意：此字段可能返回 null，表示取不到有效值。", "example": "LocalIpList" }, { "name": "Option", "type": "string", "required": false, "description": "选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。", "example": "ilike" }, { "name": "Value", "type": "array", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"VMware-Win11x\"]", "item_type": "string" }, { "name": "Groups", "type": "array", "required": false, "description": "嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "RelateOption", "type": "string", "required": false, "description": "RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。", "example": "and" } ] }, { "name": "RelateOption", "type": "string", "required": false, "description": "条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。", "example": "or" } ] }, { "name": "RulePayloadMode", "type": "integer", "required": false, "description": "规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "OsType", "type": "integer", "required": false, "description": "系统类型0:win 2:mac", "example": "0" } ], "required": [] }, { "name": "ModifyVirtualDeviceGroups", "description": "终端自定义分组增减终端，私有化调用path为：/capi/Assets/Device/ModifyVirtualDeviceGroups", "status": "online", "parameters": [ { "name": "DeviceList", "type": "array", "required": true, "description": "必填，操作的设备列表数据", "example": "无", "item_type": "object", "children": [ { "name": "DeviceMid", "type": "string", "required": false, "description": "设备mid", "example": "10527BB0BE025F40B5E8A7D00B5E13E268243DBB" }, { "name": "Operation", "type": "integer", "required": false, "description": "操作标识 0:删除设备 1:添加设备", "example": "0" } ] }, { "name": "DomainInstanceId", "type": "string", "required": false, "description": "管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域\"1\"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。", "example": "1" }, { "name": "DeviceVirtualGroupId", "type": "integer", "required": false, "description": "添加到的终端自定义分组id。和DeviceVirtualGroupIds互斥，必填其一，优先使用本参数", "example": "0" }, { "name": "DeviceVirtualGroupIds", "type": "array", "required": false, "description": "要添加的终端自定义分组id列表", "example": "[14989]", "item_type": "integer" }, { "name": "OsType", "type": "integer", "required": false, "description": "系统类型（0: win，1：linux，2: mac，4：android，5：ios 默认值0）", "example": "0" } ], "required": [ "DeviceList" ] } ] }