AccountUserIdItem
账户标识项(目录MenuId+登录账号UserId)，用于以(菜单目录、登录账号)代替账号Id标识账户
被如下接口引用：BindVirtualAccounts, UnbindVirtualAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MenuId | Integer | 否 | Comment: 账号所在目录ID(MenuId)，与accounts表menu_id一致，用于同一登录账号在不同目录下去重;Required:true 示例值：2671 |
| UserId | String | 否 | Comment: 登录账号(UserId)，对应DescribeLocalAccount -> UserId;Required:true 示例值：canaan |
AggrCategorySoftDetailRow
按版本聚合后的软件列表
被如下接口引用：DescribeAggrSoftCategorySoftList。
| 名称 | 类型 | 描述 |
|---|---|---|
| ID | Integer | ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Name | String | 软件名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：qwe |
| PiracyRisk | Integer | 盗版风险 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| OsType | Integer | 系统平台 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| CorpName | String | 企业名 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| InstalledDeviceNum | Integer | 安装设备数量(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| PiracyInstalledDeviceNum | Integer | 盗版安装设备数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| InstalledUserNum | Integer | 已安装用户数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| PiracyInstalledUserNum | Integer | 盗版软件用户数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| AuthNum | Integer | 授权总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| GenuineRate | Float | 正版率 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| UpgradableDeviceNum | Integer | 有新版本可升级的设备数量 示例值：0 |
| UpgradeDeviceNum | Integer | 有新版本可升级的设备数量 示例值：0 |
AggrSoftDeviceRow
聚合软件的已安装终端列表中的一行数据
被如下接口引用：DescribeAggrSoftDeviceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DeviceName | String | 否 | 终端名 注意：此字段可能返回 null，表示取不到有效值。 示例值：cugnansu-NB1 |
| LastLoginAccount | String | 否 | 最近登录账号 注意：此字段可能返回 null，表示取不到有效值。 示例值：win11 |
| DeviceUserName | String | 否 | 终端用户名 注意：此字段可能返回 null，表示取不到有效值。 示例值：cugnansu |
| Version | String | 否 | 软件版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.280.1.4 |
| PiracyRisk | Integer | 否 | 是否盗版 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| PiracyReason | String | 否 | 盗版原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：未支持 |
| InstallTime | String | 否 | 安装时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2025/07/17 |
| UserPath | String | 否 | 用户目录 注意：此字段可能返回 null，表示取不到有效值。 示例值：全网账户.OS |
| UserGroup | String | 否 | 所在分组 注意：此字段可能返回 null，表示取不到有效值。 示例值：全网终端.服务器 |
| IP | String | 否 | IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：13.108.77.57 |
| MAC | String | 否 | MAC 注意：此字段可能返回 null，表示取不到有效值。 示例值：00:E0:4C:36:01:1A |
| UseTime | Integer | 否 | 使用时长 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| DeviceId | Integer | 否 | 设备ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：20543 |
| FullSoftName | String | 否 | 软件全名 注意：此字段可能返回 null，表示取不到有效值。 示例值：Overwolf |
| Id | Integer | 否 | 数据ID（唯一） 注意：此字段可能返回 null，表示取不到有效值。 示例值：1842703 |
| NewVersion | String | 否 | 该终端此款软件可升级到的目标版本号 示例值：134.0.3124.66 |
| UpgradeSoftId | Integer | 否 | 该软件对应运营配置的可升级id 示例值：1310 |
| RemarkName | String | 否 | 终端备注名 示例值：windows |
| SoftwareId | Integer | 否 | 软件id 示例值：123 |
| OsType | Integer | 否 | 0:win 2:mac 示例值：0 |
| AssetType | String | 否 | 所有权 示例值：未分类资产 |
BindVirtualAccountData
绑定账户虚拟组响应数据
被如下接口引用：BindVirtualAccounts。
| 名称 | 类型 | 描述 |
|---|---|---|
| FailItems | Array of BindVirtualAccountResultData | 绑定失败明细（含失败原因） |
| SuccessItems | Array of BindVirtualAccountResultData | 绑定成功明细（含幂等场景：已存在绑定的账号也归入成功） |
BindVirtualAccountResultData
绑定虚拟组结果明细项
被如下接口引用：BindVirtualAccounts, UnbindVirtualAccounts。
| 名称 | 类型 | 描述 |
|---|---|---|
| AccountId | Integer | 账号Id（通过AccountIdList传入时回显） 示例值：5365 |
| MenuId | Integer | 目录ID（通过AccountUserList传入时回显，否则为0） 示例值：2671 |
| Reason | String | 失败原因，仅失败项有值：ACCOUNT_NOT_FOUND / ACCOUNT_NOT_IN_GROUP / DB_ERROR 示例值：ACCOUNT_NOT_FOUND |
| UserId | String | 登录账号（通过AccountUserList传入时回显，否则为空） 示例值：canaan1 |
ComplexRule
自动划分规则数据
被如下接口引用：CreateDeviceVirtualGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SimpleRules | Array of SimpleRule | 否 | 简单规则表达式 |
| Relation | String | 否 | 表达式间逻辑关系 示例值：并且 |
Condition
这是一个多接口的公共数据结构，用于接口根据条件进行过滤和分页。具体支持哪些过滤条件，参考具体使用该结构的接口字段描述
被如下接口引用：DescribeAccountGroups, DescribeAggrSoftCategorySoftList, DescribeAggrSoftDeviceList, DescribeBusinessResources, DescribeDLPEdgeNodeGroups, DescribeDLPEdgeNodes, DescribeDeviceChildGroups, DescribeDeviceDetailList, DescribeDeviceHardwareInfoList, DescribeDeviceVirtualGroups, DescribeDevices, DescribeLocalAccounts, DescribeSoftCensusListByDevice, DescribeSoftwareInformation, DescribeVirtualAccounts, DescribeVirtualDevices, ExportDeviceDownloadTask, ExportSoftwareInformationList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Filters | Array of Filter | 否 | Filters 条件过滤 |
| FilterGroups | Array of FilterGroup | 否 | FilterGroups 条件过滤组 |
| Sort | Sort | 否 | Sort 排序字段 |
| PageSize | Integer | 否 | PageSize 每页获取数(只支持32位) 示例值：20 |
| PageNum | Integer | 否 | PageNum 获取第几页(只支持32位) 示例值：3 |
| RulePayload | RulePayload | 否 | 复杂查询规则条件查询项（支持任意层级AND/OR组合） 注意：此字段可能返回 null，表示取不到有效值。 |
| RulePayloadMode | Integer | 否 | 规则模式：0-使用旧的FilterGroups，1-使用新的RulePayload 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
CreateBusinessResourceData
创建业务资源响应的数据
被如下接口引用：CreateBusinessResource。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ServiceId | Integer | 否 | 创建成功的业务资源数据id 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
CreateDLPFileDetectTaskData
文件鉴定任务分页数据
被如下接口引用：CreateDLPFileDetectTask。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskRequestId | Array of String | 任务请求唯一Id 示例值：["35dfsdfaserwvead"] |
CreateDLPFileDetectionTaskData
提交送检任务相应数据
被如下接口引用：CreateDLPFileDetectionTask。
| 名称 | 类型 | 描述 |
|---|---|---|
| DLPFileDetectionTaskID | String | 提交任务生成的id，也即requestID。用于后续查询 示例值：1 |
CreateDeviceVirtualGroupRspData
响应返回的data
被如下接口引用：CreateDeviceVirtualGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | 返回的自定义分组id 示例值：1345 |
CreatePrivilegeCodeRspData
业务响应数据
被如下接口引用：CreatePrivilegeCode。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Code | String | 否 | 特权码数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：586267 |
DeleteResourceData
资源集
被如下接口引用：DeleteAccountGroupResources。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ResourceType | Integer | 是 | 资源类型 ,1:资源 2:资源组(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ResourceId | Integer | 是 | 资源或资源组Id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DescribeAccountAccountGroupsData
多OU组信息
被如下接口引用：DescribeVirtualAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AccountGroupId | Integer | 否 | 组Id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：293 |
| AccountGroupName | String | 否 | 组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：产品中心 |
| MasterFlag | Integer | 否 | 主组标识(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| AccountGroupNamePaths | Array of String | 否 | 组路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：["全网账户" ,"企业微信代理-勿删","产品中心"] |
| AccountGroupPathIds | Array of Integer | 否 | 组路径Id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：[2,284,293] |
DescribeAccountGroupsData
账号分组信息
被如下接口引用：DescribeAccountGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NamePath | String | 否 | 账号分组名全路径，点分格式 示例值：全网账户.pf自建.集团.研发部.研发二组 |
| IdPathArr | Array of Integer | 否 | 账号分组ID全路径，数组格式 示例值：[14632,82119,510943,510945,510948] |
| ExtraInfo | String | 否 | 扩展信息 示例值：{"salt": "5b52ea107e85a7b46d2c1b15a5faf722"} |
| Utime | String | 否 | 最后更新时间 示例值：2024-10-21 14:34:52 |
| ParentId | Integer | 否 | 父分组ID 示例值：510945 |
| OrgId | String | 否 | 源账号组织ID。使用第三方导入用户源时，记录该分组在源组织架构下的分组ID 示例值：510948 |
| Name | String | 否 | 分组名称 示例值：研发二组 |
| Id | Integer | 否 | 分组ID 示例值：510948 |
| Description | String | 否 | 分组描述 示例值：这是一个研发组 |
| Source | Integer | 否 | 同步数据源 示例值：10006 |
| IdPath | String | 否 | 账号分组ID全路径，点分格式 示例值：14632.82119.510943.510945.510948 |
| Itime | String | 否 | 创建时间 示例值：2024-10-21 14:34:52 |
| ParentOrgId | String | 否 | 父源账号组织ID。使用第三方导入用户源时，记录该分组在源组织架构下的分组ID 示例值：510945 |
| ImportType | String | 否 | 导入类型 示例值：ldap |
| MiniIamId | String | 否 | miniIAM id 示例值：13181605199t6Upte77k5AtsQ5VBagff |
| UserTotal | Integer | 否 | 该分组下含子组的所有用户总数 示例值：2 |
| IsLeaf | Boolean | 否 | 是否叶子节点 示例值：true |
| ReadOnly | Boolean | 否 | 是否该账户的直接权限 示例值：false |
| LatestSyncResult | String | 否 | 最新一次同步任务的结果 示例值：Success |
| LatestSyncTime | String | 否 | 最新一次同步任务的结束时间 示例值：2024-11-07T11:13:11+08:00 |
| NamePathArr | Array of String | 否 | 分组名称数组 示例值：["全网账户"] |
DescribeAccountGroupsPageResp
账户分组详情响应数据
被如下接口引用：DescribeAccountGroups。
| 名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of DescribeAccountGroupsData | 账户分响应对象集合 |
| Page | Paging | 分页公共对象 |
DescribeAccountResourcesData
数据集
被如下接口引用：DescribeDirectAccountGroupResources。
| 名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of DescribeAccountResourcesItems | 资源对象 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DescribeAccountResourcesItems
资源对象
被如下接口引用：DescribeDirectAccountGroupResources。
| 名称 | 类型 | 描述 |
|---|---|---|
| AreaId | Integer | 资源组id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Description | String | 描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ResourceType | Integer | 资源类型(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ResourceId | Integer | 资源id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| FromSourceId | Integer | 一般同id字段相同(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| IsInherited | Boolean | 是否继承过来的资源 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ExpireTime | Integer | 资源过期时间(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| NamePath | String | 账户组的namepath 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| AccessType | Integer | 访问类型:0-NGN 1-web(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ResourceName | String | 资源名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| IsInheritedSwitch | Integer | 继承开关状态(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Id | Integer | 关系id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| AreaName | String | 资源名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DescribeAggrSoftCategorySoftListData
业务响应数据
被如下接口引用：DescribeAggrSoftCategorySoftList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Page | Paging | 分页公共对象 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 总数(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 |
| AggrSoftCategorySoftList | Array of AggrCategorySoftDetailRow | 行数据 注意：此字段可能返回 null，表示取不到有效值。 |
DescribeAggrSoftDetailData
聚合软件详情数据
被如下接口引用：DescribeAggrSoftDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 软件名称 注意：此字段可能返回 null，表示取不到有效值。 |
| OsType | Integer | 平台 注意：此字段可能返回 null，表示取不到有效值。 |
| PiracyRisk | Integer | 盗版风险 注意：此字段可能返回 null，表示取不到有效值。 示例值： 0=无风险;1=有风险;2=未开启检查 |
| Corp | String | 厂商 注意：此字段可能返回 null，表示取不到有效值。 |
| SoftVersionDist | Array of SoftVersionAndNum | 已安装版本分布 注意：此字段可能返回 null，表示取不到有效值。 |
| PiracyVersionDist | Array of SoftVersionAndNum | 盗版版本安装 注意：此字段可能返回 null，表示取不到有效值。 |
| InstalledDeviceNum | Integer | 安装设备数 注意：此字段可能返回 null，表示取不到有效值。 |
| PiracyInstalledDeviceNum | Integer | 盗版安装设备数 注意：此字段可能返回 null，表示取不到有效值。 |
| InstalledUserNum | Integer | 安装用户数 注意：此字段可能返回 null，表示取不到有效值。 |
| PiracyInstalledUserNum | Integer | 盗版安装用户数 注意：此字段可能返回 null，表示取不到有效值。 |
| AuthNum | Integer | 授权数 注意：此字段可能返回 null，表示取不到有效值。 |
| GenuineRate | Float | 正版率 注意：此字段可能返回 null，表示取不到有效值。 |
| UpgradableDeviceNum | Integer | 有新版本可升级的设备数量 示例值：0 |
| UpgradableVersions | Array of String | 当前可升级的最新版本信息, 每一项均为json字符串 示例值：["{"version": "8.0.4410.7"}"] |
DescribeAggrSoftDeviceListData
聚合软件-已安装终端列表
被如下接口引用：DescribeAggrSoftDeviceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Page | Paging | 分页公共对象 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 总数 注意：此字段可能返回 null，表示取不到有效值。 |
| AggrSoftDeviceList | Array of AggrSoftDeviceRow | 详情 注意：此字段可能返回 null，表示取不到有效值。 |
DescribeBusinessResourceData
业务资源列表数据对象集合
被如下接口引用：DescribeBusinessResources。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ServiceId | Integer | 否 | 业务资源id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ServiceName | String | 否 | 业务资源名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：dd |
| ServiceType | String | 否 | 资源类型:ip,domain,ip_section，对应ip，域名，ip段 注意：此字段可能返回 null，表示取不到有效值。 示例值：ip |
| ServiceAddress | String | 否 | 业务资源地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：ip |
| ServicePort | String | 否 | 业务资源端口 all,1-65535 注意：此字段可能返回 null，表示取不到有效值。 示例值：80 |
| CreateTime | String | 否 | 业务资源创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2026-02-03 17:48:06 |
| UpdateTime | String | 否 | 业务资源最后修改时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2026-02-03 17:48:06 |
| Remark | String | 否 | 说明字段 注意：此字段可能返回 null，表示取不到有效值。 示例值：no |
| AreaId | Integer | 否 | 资源模块ID(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| SmartGateIds | Array of Integer | 否 | 零信任网关id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：[10,10] |
| Protocol | Integer | 否 | 业务资源协议类型,3：所有,2：UDP，1：TCP(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| Levels | Integer | 否 | 业务资源等级(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| SmartGateNames | String | 否 | 零信任网关名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：name |
| DirectConn | Integer | 否 | 网关连通性(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| DetectState | Integer | 否 | 网关连通性状态(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| DetectInfo | String | 否 | 网关连通性信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：info |
| DetectTime | String | 否 | 网关连通性创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：0001-01-01 00:00:00 |
| ConnectorGroupId | String | 否 | 绑定的连接器组Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ConnectorGroupName | String | 否 | 绑定的连接器组的名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group |
| ReachableTime | String | 否 | 资源连通性可达最后的检测时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：time |
| ReachableState | Integer | 否 | 资源连通性可达状态,0：未检测，1：未连通，2：已连通 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| AccessType | Integer | 否 | 访问类型:0-NGN 1-web(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| BackendScheme | String | 否 | web资源-后端协议 注意：此字段可能返回 null，表示取不到有效值。 示例值：http |
| BackendPath | String | 否 | web资源-后端路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：/ |
| FrontScheme | String | 否 | web资源-前端协议 注意：此字段可能返回 null，表示取不到有效值。 示例值：https |
| FrontHost | String | 否 | web资源-前端host 注意：此字段可能返回 null，表示取不到有效值。 示例值：hr |
| FrontPort | Integer | 否 | web资源-前端host(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：443 |
| FrontPath | String | 否 | web资源-前端路径 默认"/" 注意：此字段可能返回 null，表示取不到有效值。 示例值：/ |
| DisableFront | Integer | 否 | web资源-是否禁用外网访问：0-可通过外网访问 1-不能通过外网访问(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| CustomDomain | String | 否 | web资源-租户自定义域名 注意：此字段可能返回 null，表示取不到有效值。 示例值：hr.qq.com |
| CustomHost | String | 否 | web资源-自定义host 注意：此字段可能返回 null，表示取不到有效值。 示例值：hr.qq.com |
| CnameStatus | Integer | 否 | web资源-Cname状态(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| CertificateId | Integer | 否 | web资源-关联证书ID(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| WebGwResourceType | Integer | 否 | web资源类型：0-应用 1-API(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| APISecretId | Integer | 否 | web资源-如果选择API类型资源，则需要配置密钥(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| AreaName | String | 否 | 所属资源组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：area |
| SSLCertId | String | 否 | web资源-前端协议是HTTPS类型，需要配置证书 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| EnableDependentAddr | Integer | 否 | web资源-是否启用依赖地址：0-不启用 1-启用(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| DependentAddr | String | 否 | web资源-依赖地址的后端服务器地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://10.0.2.3 |
| WebGwNoAuth | Integer | 否 | web免鉴权：1-鉴权 2-免鉴权 示例值：1 |
| ConnectorGroupType | String | 否 | 通道类型 枚举值：
默认值：native 示例值：vpc |
| DomainSuffix | String | 否 | 域名后缀 示例值：ztnwork.com |
| ConnectivityCheckSwitch | Integer | 否 | 连通性检查开关，0-关闭 1-开启，默认1(只支持32位) 示例值：1 |
| ConnectivityCheckInterval | Integer | 否 | 连通性检查测试间隔数值，最小为1，默认1(只支持32位) 示例值：3 |
| ConnectivityCheckIntervalUnit | String | 否 | 连通性检查测试间隔单位 minutes/hours/days，默认hours 示例值：min |
| URLAuditState | Integer | 否 | URL审计开关：0-关闭 1-开启，默认0 示例值：1 |
| URLAuditId | String | 否 | URL审计证书ID列表，多个用分号分隔 示例值：/hr.com |
| URLPath | String | 否 | URL审计路径，多个用分号分隔 示例值：/hr/system |
| ReachableType | Integer | 否 | 检测方式：0-未检测 1-主动 2-流量 示例值：0 |
| APISecretName | String | 否 | API密钥名称 示例值：**feqe*rwerwe |
| APISecretKey | String | 否 | API密钥Key 示例值：*few**w |
| EnableSensitiveRes | Integer | 否 | 是否为敏感资源：0-否 1-是 示例值：0 |
| EnableIPPolicy | Integer | 否 | 用户接入IP限制开关：0-不启用 1-启用 示例值：1 |
| IPPolicyAttr | Integer | 否 | IP分组属性：0-白名单 1-黑名单 示例值：1 |
| IPPolicyIds | Array of Integer | 否 | IP分组ID列表 示例值：[12131,21212] |
| IPPolicyNames | String | 否 | IP分组名称（分号分隔） 示例值：禁用规则 |
| EnableUserAgent | Integer | 否 | 访问浏览器规则开关：0-不启用 1-启用 示例值：1 |
| UserAgentAttr | Integer | 否 | 浏览器规则属性：0-白名单 1-黑名单 示例值：1 |
| UserAgentIds | Array of String | 否 | 浏览器规则ID列表 示例值：["crhome"] |
| UserAgentNames | String | 否 | 浏览器规则名称（分号分隔） 示例值：1 |
DescribeBusinessResourcePageRsp
业务资源分页返回对象
被如下接口引用：DescribeBusinessResources。
| 名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of DescribeBusinessResourceData | 业务资源列表数据对象集合 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Page | Paging | 分页公共对象 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DescribeDLPEdgeNodeGroupsRspData
业务响应数据
被如下接口引用：DescribeDLPEdgeNodeGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Items | Array of DescribeDLPEdgeNodeGroupsRspItem | 否 | 分组信息 |
| Page | Paging | 否 | 分页信息 |
DescribeDLPEdgeNodeGroupsRspItem
节点分组信息
被如下接口引用：DescribeDLPEdgeNodeGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | 自增id，数据库中唯一 示例值：1 |
| GroupName | String | 否 | 节点分组名称 示例值：saaskb |
| GroupId | String | 否 | 节点分组id 示例值：ct9at4pgiv8f3vdmk9s0 |
| EdgeCount | Integer | 否 | 包含边缘节点数量 示例值：8 |
| GroupNameI18n | Array of I18nString | 否 | 分组中英文 |
DescribeDLPEdgeNodesPageData
业务响应数据
被如下接口引用：DescribeDLPEdgeNodes。
| 名称 | 类型 | 描述 |
|---|---|---|
| Page | Paging | 分页信息 |
| Items | Array of DescribeDLPEdgeNodesRspItem | 节点列表 |
DescribeDLPEdgeNodesRspItem
边缘节点信息
被如下接口引用：DescribeDLPEdgeNodes。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 自增id，数据库中唯一 示例值：22 |
| GroupId | String | 节点分组唯一id 示例值：cl6uga713okpvh4bp5mg |
| EdgeNodeId | String | 节点id 示例值：2XybyThLH1JXG1s2KQYLoI8wokH |
| EdgeNodeName | String | 节点名称 示例值：默认节点名称 |
| IsActive | Boolean | 是否活跃/连通 示例值：true |
| GroupName | String | 节点分组名称 示例值：默认专线分组 |
| Ip | String | 节点IP 示例值：10.100.8.89 |
| Version | String | 节点版本 示例值：2109.8.20016.62000 |
| IsUpgradeEnable | Boolean | 是否支持升级连接器 示例值：false |
| UpgradeStatus | Integer | 升级状态: 0(升级中) , 1(升级失败) 或 2(升级成功) 示例值：0 |
| UpgradeDescription | String | 升级状态描述 示例值：升级中... |
| RuleVersion | String | 规则版本 示例值：354821568 |
DescribeDLPFileDetectResultData
查询文件检测结果响应数据
被如下接口引用：DescribeDLPFileDetectResult。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileMd5 | String | 提交任务时的文件md5 示例值：md5 |
| FileName | String | 提交任务时的文件名 示例值：test.txt |
| Status | String | 状态：等待检测->正在检测->检测失败/检测成功。或任务不存在 示例值：检测成功 |
| DetectResult | String | 文件检测结果，json字符串。包含文件基本信息如type，path，md5以及命中的信息。其中State为检测状态，0为待解析文件，1为检测中，2为检测完成；FileAbstract为命中的上下文摘要信息，HitRuleid是命中的规则唯一ID，HitRuleCategoryId是规则分类唯一id，HitLevel是文件的等级，HitRuleDesc是规则的名称，HitContent是具体命中的规则以及词库信息，以及命中的内容。EngineConfigVersion是当前词库版本号 示例值："{"Type": ".pdf","Size": 802831,"State": 2,"Result": {"FileName": "YOGA%20BOOK%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97.pdf","FileContent": {"FileAbstract": "YOGA BOOK with Windows®\n在使用本用户指南及其支持的产品之\"}}}" |
DescribeDLPFileDetectTaskResult
查询文件检测结果响应数据
被如下接口引用：DescribeDLPFileDetectTaskResult。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileMd5 | String | 提交任务时的文件md5 示例值：dtsveastedfsdvaefadfsdad |
| FileName | String | 提交任务时的文件名 示例值：产品交易订单.docx |
| Status | Integer | 检测执行状态：0未执行 1等待执行 2执行中 3执行失败 4执行完成 示例值：4 |
| DetectResult | String | FileAbstract:文件摘要 FileAttr:文件属性 FileCategory:命中分级分类 array FileContent:命中信息json(array) RuleId:规则Id RuleName:规则名称 RuleLevel:规则等级 Hits：命中词库内容 LibraryId：词库Id LibraryType:词库类型 LibraryName:词库名称 Attribute: 命中属性 doc.Content文件内容|doc.FileSize文件大小|doc.Name文件名|doc.Type文件类型 String 待匹配内容 Content 命中内容 HitsTotal 规则命中次数 FileMd5 文件ND5 FileName 文件名 FileSize 文件大小 FileType 文件后缀 FileTypeName 文件类型名称 FinalDataLevel 命中最高等级 NodeId 节点唯一Id NodeIp 节点IP NodeName 节点名称 OperateTime 文件操作时间 Url 文件下载Url 示例值：（内容过长:见示例） |
| Message | String | 检测执行状态描述 示例值：task:d3jhnmbjsehhr3dhnji0检测成功 |
DescribeDeviceChildGroupsRspData
查询设备组子分组详情响应结构
被如下接口引用：DescribeDeviceChildGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Items | Array of DeviceGroupDetail | 否 | 返回的数组列表 |
DescribeDeviceDetailListData
终端详情响应对象集合
被如下接口引用：DescribeDeviceDetailList。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserName | String | 账号名 注意：此字段可能返回 null，表示取不到有效值。 示例值：lucal_win2 |
| ComputerName | String | 计算机名 注意：此字段可能返回 null，表示取不到有效值。 示例值：lucal_win-PC2 |
| Name | String | 名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：lucal_win-PC2 |
| AccountGroupIdPath | String | 用户组IdPath 注意：此字段可能返回 null，表示取不到有效值。 示例值：8.3762 |
| AccountGroupId | Integer | 用户组id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| GroupNamePath | String | 终端组名path 注意：此字段可能返回 null，表示取不到有效值。 示例值：全网终端.set2.set2-1 |
| Ip | String | Ip地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：113.108.77.69 |
| AccountGroupName | String | 用户组名 注意：此字段可能返回 null，表示取不到有效值。 示例值：ktest |
| GroupIdPath | String | 终端组IdPath 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.5.7 |
| Mid | String | 唯一标识Mid 注意：此字段可能返回 null，表示取不到有效值。 示例值：928EBWA5184BEC838B96B29CE8105EC685A6DA6 |
| IoaUserName | String | IOA账号名 注意：此字段可能返回 null，表示取不到有效值。 示例值：lucal |
| GroupId | Integer | 所在分组Id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：7 |
| GroupName | String | 所在分组Name 注意：此字段可能返回 null，表示取不到有效值。 示例值：set2-1 |
| Mac | String | Mac地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：00:E0:4C:36:01:1B |
| Version | String | 软件版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.280.1.4 |
| AccountGroupNamePath | String | 用户组名Path 注意：此字段可能返回 null，表示取不到有效值。 示例值：全网账户.accountgroup |
| Id | Integer | 列表Id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
DescribeDeviceDetailListPageData
业务响应数据
被如下接口引用：DescribeDeviceDetailList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of DescribeDeviceDetailListData | 终端详情响应对象集合 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Page | Paging | 分页公共对象 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DescribeDeviceHardwareInfoItem
终端硬件信息列表Item数据
被如下接口引用：DescribeDeviceHardwareInfoList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 设备ID 示例值：1 |
| Mid | String | 设备唯一标识符 示例值：10527BB0BE025F40B5E8A7D00B5E13E268243DBB |
| OsType | Integer | OS平台 0 Windows 1 Linux 2 macOS 4 Android 5 iOS 示例值：0 |
| Name | String | 终端名 示例值：MAGICTONG-PC4 |
| UserName | String | 终端用户名 示例值：magic |
| Status | Integer | 授权状态（ 4未授权 5已授权） 示例值：5 |
| GroupId | Integer | 设备所属分组ID 示例值：1578 |
| GroupName | String | 设备所属分组名 示例值：未分组终端 |
| GroupNamePath | String | 设备所属分组路径 示例值：全网终端.未分组终端 |
| AccountName | String | 最近登录账户的姓名 示例值：张三 |
| Ip | String | 出口IP 示例值：113.108.77.50 |
| MacAddr | String | MAC地址 示例值：00:0C:29:DD:00:06 |
| Cpu | String | CPU品牌型号 示例值：Intel(R) Core(TM) i7-10700 CPU @ 2.90GH |
| Memory | String | 内存信息 示例值：4 GB |
| HardDiskSize | String | 硬盘信息 示例值：VMware, VMware Virtual S SCSI Disk Device 1 GB |
| Monitor | String | 显示器品牌型号 示例值：Parallels Vu |
| RemarkName | String | 终端备注名 示例值：leizi的电脑 |
| BiosUuid | String | BiosUUID（启动盘标识符） 示例值：39034D56-42EE-9A2C-CD56-EFBAD7DD000E |
| NetworkCards | Array of DeviceNetworkCardBrief | 多网卡数据 |
| VideoCards | Array of DeviceVideoCardBrief | 多显卡数据 |
| MainBoard | String | 主板型号 示例值：Intel Corporation 440BX Desktop Reference Platform |
| BaseBoardSn | String | 主板序列号 示例值：6D93F1BFE42A4D56 |
| BaseBoardManufacturer | String | 主板制造商 示例值：Intel Corporation |
| AudioCard | String | 声卡 示例值：High Definition Audio 设备 |
DescribeDeviceHardwareInfoListRspData
终端硬件信息列表响应详情
被如下接口引用：DescribeDeviceHardwareInfoList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Page | Paging | 分页数据 |
| Items | Array of DescribeDeviceHardwareInfoItem | 终端硬件信息数据数组 |
DescribeDeviceInfoRspData
业务响应数据
被如下接口引用：DescribeDeviceInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ProcessList | Array of DeviceProcessInfo | 否 | 分页的具体数据对象 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| NetworkList | Array of DeviceNetworkInfo | 否 | 分页的具体数据对象 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ServiceList | Array of DeviceServiceInfo | 否 | 分页的具体数据对象 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DescribeDeviceSecurityInfoData
终端安全信息
被如下接口引用：DescribeDeviceSecurityInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| FirewallStatus | Integer | 防火墙状态 枚举值：
示例值：1 |
| RealTimeProtectionStatus | Integer | 实时防护状态 枚举值：
示例值：2 |
| SysRepVersion | String | 系统修复引擎版本 示例值：2026.07.31.11.45.06 |
| VirusVer | String | 病毒库版本 示例值：2.0.13789.1131 |
| VulVersion | String | 漏洞库版本 示例值：2019.08.19.09.50.30 |
DescribeDeviceVirtualGroupsPageRsp
查询返回终端自定义分组的Data数据
被如下接口引用：DescribeDeviceVirtualGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Page | Paging | 否 | 分页公共对象 示例值：{ "PageCount": 1, "Total": 1, "PageSize": 10, "PageNum": 1 } |
| Items | Array of DeviceVirtualDeviceGroupsDetail | 否 | 终端自定义分组列表数据 示例值：[{ "DeviceVirtualGroupName": "自定义分组1", "DeviceCount": 0, "TimeType": 0, "OsType": 0, "Id": 10307, "Status": 1, "Utime": "2025-05-23T15:58:40.411484+08:00", "Description": "", "Itime": "2025-05-23T15:58:40.411484+08:00" }] |
DescribeDevicesPageRsp
分页的data数据
被如下接口引用：DescribeDevices。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Paging | Paging | 否 | 数据分页信息 示例值：参考 Paging |
| Items | Array of DeviceDetail | 否 | 业务响应数据 示例值：参考DeviceDetail |
DescribeLocalAccountAccountGroupsData
所属组
被如下接口引用：DescribeLocalAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AccountGroupId | Integer | 否 | 组Id(只支持32位) 示例值：49017 |
DescribeLocalAccountsData
获取账号列表响应的单个对象
被如下接口引用：DescribeLocalAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | uid，数据库中唯一 示例值：1821470 |
| UserId | String | 否 | 账号，登录账号 示例值：ethanhu |
| UserName | String | 否 | 用户名 示例值：胡生 |
| AccountId | Integer | 否 | 账号id，同Id字段 示例值：1821470 |
| GroupId | Integer | 否 | 账号所在的分组id 示例值：83210 |
| GroupName | String | 否 | 账号所在的分组名称 示例值：测试组 |
| NamePath | String | 否 | 账号所在的分组名称路径，用英文.分割 示例值：全网账户.测试组 |
| Source | Integer | 否 | 账号来源,0表示本地账号(只支持32位) 示例值：91606 |
| Status | Integer | 否 | 账号状态,0禁用，1启用(只支持32位) 示例值：1 |
| Itime | String | 否 | 账号的创建时间 示例值：2024-11-07 19:31:26 |
| Utime | String | 否 | 账号的最后更新时间 示例值：2024-11-07 19:31:26 |
| ExtraInfo | String | 否 | 账号的扩展信息，包含邮箱、手机号、身份证、职位等信息 示例值：{"*l"*t***q.com", "phon**** "189000000","taus" ,\iniIAM_guid": "1163*f9-32bf-b5cd-3ce1d2* "ia*abl**unt": 0} |
| RiskLevel | String | 否 | 用户风险等级，枚举：none, low, middle, high 示例值：low |
| AccountGroups | Array of DescribeLocalAccountAccountGroupsData | 否 | 所属组 |
| MobileBindNum | Integer | 否 | 绑定手机端设备数 示例值：1 |
| PcBindNum | Integer | 否 | 绑定Pc端设备数 示例值：2 |
| OnlineStatus | Integer | 否 | 账号在线状态 1：在线 2：离线 示例值：1 |
| ActiveStatus | Integer | 否 | 账号活跃状态 1：活跃 2：非活跃 示例值：1 |
| LoginTime | String | 否 | 账号登录时间 示例值：2024-11-01 23:18:13 |
| LogoutTime | String | 否 | 账号登出时间 示例值：2024-11-01 23:19:08 |
DescribeLocalAccountsPage
获取账号列表响应的分页对象
被如下接口引用：DescribeLocalAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Page | Paging | 否 | 公共分页对象 示例值：{"PageSize": 10, "PageNum": 1, "PageCount": 3, "Total": 24} |
| Items | Array of DescribeLocalAccountsData | 否 | 获取账号列表响应的单个对象 示例值：[{"Id": 1869, "UserId": "zhangsan"}] |
DescribeProfileFieldsRspData
描述字段数据
被如下接口引用：DescribeProfileFieldsMenu。
| 名称 | 类型 | 描述 |
|---|---|---|
| Item | Array of ProfileFieldItem | 详情item |
| ProfileTips | ProfileTips | profile开关配置 |
DescribeResourceGrantedAccountGroupsData
账号分组授权信息
被如下接口引用：DescribeResourceGrantedAccountGroups。
| 名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of GrantedAccountGroupItem | 授权信息 |
DescribeResourceGrantedAccountsData
DescribeResourceGrantedAccountsData
被如下接口引用：DescribeResourceGrantedAccounts。
| 名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数 示例值：1 |
| Items | Array of GrantedAccountItem | 授权信息 |
DescribeResourceGrantedVirtualGroupsData
DescribeResourceGrantedAccountsData
被如下接口引用：DescribeResourceGrantedVirtualGroups。
| 名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of GrantedVirtualGroupItem | 授权信息 |
DescribeSoftCensusListByDeviceData
软件统计响应对象集合
被如下接口引用：DescribeSoftCensusListByDevice。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserName | String | 终端用户名 注意：此字段可能返回 null，表示取不到有效值。 示例值：lucal_win-PC7 |
| MacAddr | String | mac地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：B0:DC:EF:E7:37:EA |
| Name | String | 终端计算机名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：lucal_win |
| GroupNamePath | String | 终端组路径名 注意：此字段可能返回 null，表示取不到有效值。 示例值：全网终端.分组1 |
| Ip | String | IP地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：119.147.10.192 |
| Mid | String | 唯一标识Mid 注意：此字段可能返回 null，表示取不到有效值。 示例值：8314BF3FD3FD738410C4FBB0DDDA48786800AB00 |
| IoaUserName | String | 企业账户名 注意：此字段可能返回 null，表示取不到有效值。 示例值：liming |
| GroupId | Integer | 终端分组Id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：288661 |
| GroupName | String | 终端组名 注意：此字段可能返回 null，表示取不到有效值。 示例值：分组1 |
| Id | Integer | 终端列表Id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：11668634 |
| SoftNum | Integer | 软件数量(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| PiracyRisk | Integer | 盗版风险（1=风险;2=未知） 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RemarkName | String | 终端备注名 示例值：windows |
DescribeSoftCensusListByDevicePageData
业务响应数据
被如下接口引用：DescribeSoftCensusListByDevice。
| 名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of DescribeSoftCensusListByDeviceData | 软件统计响应对象集合 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Page | Paging | 分页公共对象 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DescribeSoftwareInformationPageData
业务响应数据
被如下接口引用：DescribeSoftwareInformation。
| 名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of SoftwareInformationData | 软件详情响应对象集合 示例值：[{"CorpName":"","Id":19396,"InstallDate":"2025/04/03","Mid":"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F","Name":"微信","PiracyRisk":0,"SoftwareId":19396,"Version":"3.9.12.51"}] |
| Page | Paging | 分页公共对象 示例值：{"PageCount":1,"PageNum":1,"PageSize":1000,"Total":1} |
DescribeVirtualAccountsData
列表虚拟组的账户分页数据集合
被如下接口引用：DescribeVirtualAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | Id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1213121 |
| UserId | String | 否 | 用户账号 注意：此字段可能返回 null，表示取不到有效值。 示例值：* |
| UserName | String | 否 | 用户名 注意：此字段可能返回 null，表示取不到有效值。 示例值：* |
| AccountGroupId | Integer | 否 | 账户分组Id(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1213 |
| GroupName | String | 否 | 账户组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：测试分组1 |
| AccountId | Integer | 否 | 关联服务器名称(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1212 |
| Source | Integer | 否 | 账户源(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Status | Integer | 否 | 状态(只支持32位) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| NamePath | String | 否 | 账户namepath 注意：此字段可能返回 null，表示取不到有效值。 示例值：全网账号 |
| ExtraInfo | String | 否 | 账户扩展信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：* |
| Itime | String | 否 | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1788422561 |
| Utime | String | 否 | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1788422561 |
| AccountGroups | Array of DescribeAccountAccountGroupsData | 否 | 多OU组信息 注意：此字段可能返回 null，表示取不到有效值。 |
| PcBindNum | Integer | 否 | 绑定PC端数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| MobileBindNum | Integer | 否 | 绑定移动端数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
DescribeVirtualAccountsPageData
业务响应数据
被如下接口引用：DescribeVirtualAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Page | Paging | 否 | 分页公共对象 注意：此字段可能返回 null，表示取不到有效值。 |
| Items | Array of DescribeVirtualAccountsData | 否 | 列表虚拟组的账户分页数据集合 注意：此字段可能返回 null，表示取不到有效值。 |
DescribeVirtualDevicesPageRsp
返回的具体Data数据
被如下接口引用：DescribeVirtualDevices。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Paging | Paging | 否 | 数据分页信息 示例值：{"Total":1,"PageNum":1,"PageSize":10,"PageCount":1} |
| Items | Array of DeviceDetail | 否 | 设备列表 示例值：[{"Id":35,"Status":5,"Ip":"42.81.192.121","GroupId":14,"Name":"ZHI","OsType":0,"UserName":"xxx","Mid":"25BAF276FA7B97ACED6ACB416CEF298667E3BB0E","MacAddr":"00:1C:42:1F:48:82"}] |
DeviceDetail
业务响应数据
被如下接口引用：DescribeDevices, DescribeVirtualDevices。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | 设备ID 示例值：1749 |
| Mid | String | 否 | 设备唯一标识码，在ioa中每个设备有唯一标识码 示例值：702DFBFC9A9E31FDDBCD082B35AB2842667155F7 |
| Name | String | 否 | 终端名（设备名） 示例值：DESKTOP-U9QR7P1 |
| GroupId | Integer | 否 | 设备所在分组ID 示例值：2 |
| OsType | Integer | 否 | OS平台，0：Windows 、1： Linux、 2：macOS 、4： Android、 5: iOS。默认是0 示例值：0 |
| Ip | String | 否 | 设备IP地址（出口IP） 示例值：10.18.104.56 |
| OnlineStatus | Integer | 否 | 在线状态，2：在线、0或者1:离线 示例值：2 |
| Version | String | 否 | 客户端版本号-大整数 示例值：30399320386433584 |
| StrVersion | String | 否 | 客户端版本号-点分字符串 示例值：108.5.21771.62000 |
| Itime | String | 否 | 首次在线时间 示例值：2024-06-18T17:40:07.171192+08:00 |
| ConnActiveTime | String | 否 | 最后一次在线时间 示例值：2024-06-20T22:24:19.022634+08:00 |
| Locked | Integer | 否 | 设备是否加锁 ，1：锁定 0或者2：未锁定。 示例值：0 |
| LocalIpList | String | 否 | 设备本地IP列表, 包括IP 示例值：192.168.142.138 |
| HostId | Integer | 否 | 宿主机id（需要宿主机也安装iOA才能显示） 示例值：1 |
| GroupName | String | 否 | 设备所属分组名 示例值：未分组终端 |
| GroupNamePath | String | 否 | 设备所属分组路径 示例值：全网终端.未分组终端 |
| CriticalVulListCount | Integer | 否 | 未修复高危漏洞数(只支持32位) 示例值：0 |
| Os | String | 否 | 操作系统名称 示例值：Microsoft Windows 10 专业版 |
| OsBits | Integer | 否 | 操作系统位数 示例值：64 |
| OsVersion | String | 否 | 操作系统版本 示例值：10.0.19045 |
| OsLanguage | String | 否 | 操作系统语言 示例值：简体中文 |
| OsInstallDate | String | 否 | 操作系统安装时间 示例值：2024-05-13 |
| ComputerName | String | 否 | 设备名，和Name相同 示例值：DESKTOP-U9QR7P1 |
| DomainName | String | 否 | 登录域名 示例值：tencent.com |
| MacAddr | String | 否 | MAC地址 示例值：00:0C:29:71:A7:29 |
| VulCount | Integer | 否 | 漏洞数 示例值：0 |
| RiskCount | Integer | 否 | 病毒风险数 示例值：0 |
| VirusVer | String | 否 | 病毒库版本 示例值：2.0.13712.595 |
| VulVersion | String | 否 | 漏洞库版本 示例值：2024.06.12.11.25.18 |
| SysRepVersion | String | 否 | 系统修复引擎版本 示例值：2024.06.17.16.26.22 |
| VulCriticalList | Array of String | 否 | 高危补丁列表 示例值：["5043051","4132216"] |
| Tags | String | 否 | 标签 示例值："commpany assert" |
| UserName | String | 否 | 终端用户名 示例值：Lucky |
| FirewallStatus | Integer | 否 | 防火墙状态，不等于0表示开启 示例值：1 |
| SerialNum | String | 否 | SN序列号 示例值：VMware-56 4d 8c 1a 6c 51 b7 71-1f 2a 3b 71 e6 71 a7 29 |
| DeviceStrategyVer | String | 否 | 设备管控策略版本 示例值：2024-06-21 17:08:00 |
| NGNStrategyVer | String | 否 | NGN策略版本 示例值：2024-06-21 17:08:00 |
| IOAUserName | String | 否 | 最近登录账户的账号(账号系统用户账号) 示例值：LuckyLI |
| DeviceNewStrategyVer | String | 否 | 设备管控新策略 示例值：2024-06-24 20:27:00 |
| NGNNewStrategyVer | String | 否 | NGN策略新版本 示例值：2024-06-24 20:27:00 |
| HostName | String | 否 | 宿主机名称（需要宿主机也安装iOA才能显示） 示例值：DESKTOP-U9QR7P0 |
| Profiles | Array of DeviceProfile | 否 | 信息登记数据 |
| BaseBoardSn | String | 否 | 主板序列号 示例值：C02FVC8CQ05P |
| AccountUsers | String | 否 | 绑定账户名称 示例值：”sariel“ |
| IdentityStrategyVer | String | 否 | 身份策略版本 示例值：2024-06-21 17:08:00 |
| IdentityNewStrategyVer | String | 否 | 身份策略新版本 示例值：2024-06-24 20:27:00 |
| AccountGroupName | String | 否 | 最近登录账号部门 示例值：测试分组 |
| AccountName | String | 否 | 最近登录账户的姓名(账号系统用户姓名) 示例值：LuckyLI |
| AccountGroupId | Integer | 否 | 账号组id 示例值：1 |
| ScreenRecordingPermission | Integer | 否 | 是否开启录屏权限，仅macOS， 0： 未开启 、1： 开启 示例值：0 |
| DiskAccessPermission | Integer | 否 | 是否开启磁盘访问权限，仅macOS， 0： 未开启、 1： 开启 示例值：0 |
| InstallationStatus | Integer | 否 | 安装状态（私有化：0: 已安装 1: 已卸载 ）（SaaS及一体化：0: 未知 1: 已安装 2: 已卸载） 示例值：1 |
| RemarkName | String | 否 | 终端备注名 示例值：张三的终端 |
| BiosUuid | String | 否 | BiosUUID（启动盘标识符） 示例值：39034D56-42EE-9A2C-CD56-EFBAD7DD000E |
DeviceDownloadTask
业务响应数据
被如下接口引用：ExportDeviceDownloadTask。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DownloadURL | String | 否 | 同步数据下载的url 示例值："https://xxxxx" |
| TaskId | Integer | 否 | 异步任务id，需要根据id去任务中心下载 示例值：186947 |
DeviceGroupDetail
返回的数组列表
被如下接口引用：DescribeDeviceChildGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | 设备组id 示例值：7 |
| Name | String | 否 | 设备组名称 示例值：分组1 |
| Description | String | 否 | 设备组描述 示例值：1部门 |
| ParentId | Integer | 否 | 父节点id 示例值：1 |
| IdPath | String | 否 | 基于id的节点路径 示例值：1.7 |
| NamePath | String | 否 | 基于名称的节点路径 示例值：全网终端.分组1 |
| Locked | Integer | 否 | 分组锁定状态 示例值：0 |
| OsType | Integer | 否 | 系统类型（0: win，1：linux，2: mac，4：android，5：ios ） 示例值：0 |
| Sort | Integer | 否 | 排序 示例值：0 |
| FromAuto | Integer | 否 | 是否自动调整 示例值：0 |
| Count | Integer | 否 | 子节点数量 示例值：2 |
| Icon | String | 否 | 图标 示例值：空字符串 |
| WithIp | Integer | 否 | 是否有ip 示例值：0 |
| HasIp | Boolean | 否 | 是否有组ip 示例值：false |
| IsLeaf | Boolean | 否 | 是否是叶子节点 示例值：false |
| ReadOnly | Boolean | 否 | 是否只读 示例值：false |
| BindAccount | Integer | 否 | 对应绑定的账号id 示例值：8 |
| BindAccountName | String | 否 | 绑定账号的用户名 示例值：张三 |
DeviceNetworkCardBrief
多网卡MAC地址等列表数据
被如下接口引用：DescribeDeviceHardwareInfoList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MacAddress | String | 否 | MAC地址 示例值：00:0C:29:89:EE:15 |
| NetworkCardName | String | 否 | 网卡名称 示例值：Intel(R) 82574L Gigabit Network Connection |
| NetworkCardType | Integer | 否 | 网卡类型 枚举值：
示例值：2 |
| NetworkCardStatus | Integer | 否 | 网卡状态 枚举值：
示例值：2 |
| Ipv4Address | String | 否 | IPv4地址 示例值：192.168.18.185 |
| Ipv6Address | String | 否 | IPv6地址 示例值：fe80::86c5:61d6:217:75fd |
DeviceNetworkInfo
分页的具体数据对象
被如下接口引用：DescribeDeviceInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LocalAddr | String | 否 | 本地地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| LocalPort | Integer | 否 | 本地端口 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ProcessId | Integer | 否 | 进程id 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ProcessName | String | 否 | 进程名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Protocol | String | 否 | 协议 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| RemoteAddr | String | 否 | 远程地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| RemotePort | Integer | 否 | 远程端口 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| State | Integer | 否 | 状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DeviceProcessInfo
分页的具体数据对象
被如下接口引用：DescribeDeviceInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CmdLine | String | 否 | 命令行 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Memory | String | 否 | 内存 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Name | String | 否 | 名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Path | String | 否 | 路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ProcessId | Integer | 否 | 进程id 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| User | String | 否 | 启动用户 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DeviceProfile
信息登记数据
被如下接口引用：DescribeDevices, DescribeVirtualDevices。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Value | String | 否 | 值 示例值：qwe |
| FieldId | Integer | 否 | 属性ID(只支持32位) 示例值：16 |
| Mid | String | 否 | 设备唯一标识码 示例值：70849F6A37D2A0363A411F8A8415BFDB697720BA |
| Title | String | 否 | 名称 示例值：定义字段1 |
| Type | Integer | 否 | 类型(只支持32位) 示例值：1 |
| Options | String | 否 | 可选数据 示例值：["qwe"] |
| IsMust | String | 否 | 必填数据 示例值：1 |
| IsCustom | String | 否 | 必填数据 示例值：1 |
DeviceServiceInfo
分页的具体数据对象
被如下接口引用：DescribeDeviceInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CmdLine | String | 否 | 命令行 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Description | String | 否 | 内存 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| Name | String | 否 | 名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| ProcessId | Integer | 否 | 进程id 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| StartType | Integer | 否 | 启动类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| State | Integer | 否 | 状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| User | String | 否 | 启动用户 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
DeviceVideoCardBrief
设备显卡简要信息
被如下接口引用：DescribeDeviceHardwareInfoList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VideoCardName | String | 否 | 显卡名称 示例值：SVGA II Adapter |
DeviceVirtualDeviceGroupsDetail
终端自定义分组列表数据
被如下接口引用：DescribeDeviceVirtualGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | 终端自定义分组id 示例值：10307 |
| DeviceVirtualGroupName | String | 否 | 自定义分组名称 示例值：自定义分组1 |
| DeviceCount | Integer | 否 | 设备数 示例值：10 |
| OsType | Integer | 否 | 系统类型（0: win，1：linux，2: mac，4：android，5：ios ） 示例值：0 |
| Itime | String | 否 | 创建时间 示例值：2025-05-23T15:58:40.411484+08:00 |
| Utime | String | 否 | 更新时间 示例值：2025-05-23T15:58:40.411484+08:00 |
DirectoryConfigData
企业目录的配置数据
被如下接口引用：DescribeCompanyDirectoryConfig。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 企业目录 ID 示例值：278390 |
| Type | String | 目录对应身份源类型 枚举值：
示例值：MicrosoftEntraID |
| Name | String | 企业目录名称 示例值：AAD配置测试 |
| Config | String | 使用 JSON 字符串表示的配置信息 示例值：{"azure_tenant_id":"目录（租户）ID，必填","client_id":"应用程序(客户端) ID，必填","client_secret":"**","cloud_type":"版本类型,必填，可选值为 Global 是国际版, 21Vianet 是中国版","sensitive_fields":["client_secret"]} |
| SyncEnable | Boolean | 是否开启了定时同步 示例值：true |
| SyncPolicy | String | 定时同步的策略 枚举值：
示例值：4hours |
| SyncPolicyParams | String | JSON 字符串，针对不同类型的同步策略，提取对应不同的值 示例值：{"week":"SAT","hour":"02","minute":"30"} |
| CreateAuthConfig | Boolean | 是否配置了同步创建认证配置 示例值：true |
| Description | String | 描述 示例值：目录描述 |
| SourceId | String | 对应 Config 的配置 ID 示例值：ioa-union-260092225bqX2szz6RRUDUxaRN5EdoA |
| DisplayOnLoginPage | Boolean | 是否在登录页展示 示例值：true |
| NameI18n | Array of I18nString | 名称多语言 |
DirectoryConfigResultData
创建/编辑企业目录配置之后返回结果数据
被如下接口引用：CreateCompanyDirectoryConfig, ModifyCompanyDirectoryConfig。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 企业目录 ID 示例值：278390 |
| Name | String | 企业目录名称 示例值：AAD配置测试 |
| IdentifySourceId | String | 身份源配置 ID 示例值：ioa-union-260092225bqX2szz6RRUDUxaRN5EdoA |
| CreateAuthConfig | Boolean | 是否同步创建了认证配置 示例值：true |
| AuthSourceId | String | 认证源配置 ID 示例值：ioa-union-260092225bqX2szz6RRUDUxaRN5EdoA |
| AuthConfigId | Integer | 认证配置 ID 示例值：121773 |
| AuthPolicyId | Integer | 认证策略 ID 示例值：39217 |
| AuthSupportPlatforms | Array of String | 认证支持的平台, PC 或 Mobile 示例值：["PC"] |
| AuthMethods | Array of String | 认证方式，授权认证/扫码认证 等 示例值：["SSO认证"] |
| NameI18n | Array of I18nString | 名称多语言支持 |
ExportSoftwareDownloadUrlRspData
业务响应数据
被如下接口引用：ExportSoftwareInformationList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DownloadURL | String | 否 | 下载的url 注意：此字段可能返回 null，表示取不到有效值。 示例值："https://www.xxx.cn/1/2/3" |
| TaskId | Integer | 否 | 超过一定时间走异步任务 示例值：112233 |
Filter
Filters 条件过滤
被如下接口引用：DescribeAccountGroups, DescribeAggrSoftCategorySoftList, DescribeAggrSoftDeviceList, DescribeBusinessResources, DescribeDLPEdgeNodeGroups, DescribeDLPEdgeNodes, DescribeDeviceChildGroups, DescribeDeviceDetailList, DescribeDeviceHardwareInfoList, DescribeDeviceVirtualGroups, DescribeDevices, DescribeLocalAccounts, DescribeSoftCensusListByDevice, DescribeSoftwareInformation, DescribeVirtualAccounts, DescribeVirtualDevices, ExportDeviceDownloadTask, ExportSoftwareInformationList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Field | String | 否 | 过滤字段 示例值：Name |
| Operator | String | 否 | 过滤方式： eq:等于,net:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于。具体支持哪些过滤方式，结合具体接口字段描述来定 示例值：eq |
| Values | Array of String | 否 | 过滤条件 示例值：["张三", "zhansan"] |
FilterGroup
FilterGroups 条件过滤组
被如下接口引用：DescribeAccountGroups, DescribeAggrSoftCategorySoftList, DescribeAggrSoftDeviceList, DescribeBusinessResources, DescribeDLPEdgeNodeGroups, DescribeDLPEdgeNodes, DescribeDeviceChildGroups, DescribeDeviceDetailList, DescribeDeviceHardwareInfoList, DescribeDeviceVirtualGroups, DescribeDevices, DescribeLocalAccounts, DescribeSoftCensusListByDevice, DescribeSoftwareInformation, DescribeVirtualAccounts, DescribeVirtualDevices, ExportDeviceDownloadTask, ExportSoftwareInformationList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Filters | Array of Filter | 否 | Filters 条件过滤 |
GetAccountGroupData
账号分组详情响应数据
被如下接口引用：DescribeRootAccountGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NamePath | String | 否 | 分组名称全路径，点分格式 示例值：全网账户.pf自建 |
| IdPathArr | Array of Integer | 否 | 分组ID全路径，数组格式 示例值：[14632,82119] |
| ExtraInfo | String | 否 | 分组扩展信息 示例值：{"salt": "fa68afafytz186"} |
| Utime | String | 否 | 最后更新时间 示例值：2024-01-25 20:43:35 |
| ParentId | Integer | 否 | 当前分组的父分组ID 示例值：14632 |
| OrgId | String | 否 | 源账号组ID，该字段仅适用于第三方同步的组织架构，通过OrgId-Id构成源组织架构分组ID-现组织架构分组ID映射关系 示例值：82119 |
| Name | String | 否 | 分组名称 示例值：pf自建 |
| Id | Integer | 否 | 分组ID 示例值：82119 |
| Description | String | 否 | 分组描述 示例值：这是一个自建分组 |
| Source | Integer | 否 | 分组导入源(只支持32位) 示例值：0 |
| IdPath | String | 否 | 分组ID全路径，点分格式 示例值：14632.82119 |
| Itime | String | 否 | 创建时间 示例值：2024-01-25 20:43:35 |
| ParentOrgId | String | 否 | 父源账号组ID，该字段仅适用于第三方同步的组织架构 示例值：0 |
| Import | String | 否 | 导入信息,json格式 示例值：{"obsolete": true} |
| ImportEnable | Boolean | 否 | 是否开启导入架构 示例值：true |
| ImportType | String | 否 | 导入类型 示例值：ldap |
| MiniIamId | String | 否 | miniIAMId，MiniIAM源才有 示例值：13181605199t6Upte77k5AtsQ5VBagff |
GrantResourceOperationByAccountGroups
授权操作
被如下接口引用：GrantResourcesByAccountGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| OperationType | Integer | 是 | 操作类型: 1-增加授权 2-删除授权; 示例值：1 |
| ResourceId | Integer | 是 | 资源或资源组Id 示例值：1 |
| ResourceType | Integer | 是 | 资源类型 ,1:资源 2:资源组 示例值：2 |
| ExpireTime | Integer | 是 | 过期时间,时间戳(秒) 示例值：1 |
| AccountGroupId | Integer | 是 | 分组id 示例值：2571 |
GrantResourceOperationByAccounts
授权操作
被如下接口引用：GrantResourcesByAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| OperationType | Integer | 是 | 操作类型: 1-增加授权 2-删除授权; 示例值：1 |
| ResourceId | Integer | 是 | 资源或资源组Id 示例值：7 |
| ResourceType | Integer | 是 | 资源类型 ,1:资源 2:资源组 示例值：1 |
| ExpireTime | Integer | 是 | 过期时间,时间戳(秒) 示例值：1 |
| AccountUserId | String | 是 | 账号userid 示例值：lshawn |
| MenuId | Integer | 是 | 账号目录ID 示例值：0 |
GrantResourceOperationByVirtualGroups
授权操作
被如下接口引用：GrantResourcesByVirtualGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| OperationType | Integer | 是 | 操作类型: 1-增加授权 2-删除授权; 示例值：1 |
| ResourceId | Integer | 是 | 资源或资源组Id 示例值：7 |
| ResourceType | Integer | 是 | 资源类型 ,1:资源 2:资源组 示例值：1 |
| ExpireTime | Integer | 是 | 过期时间,时间戳(秒) 示例值：0 |
| VirtualAccountGroupId | Integer | 是 | 分组id 示例值：544 |
GrantedAccountGroupItem
账号分组授权信息
被如下接口引用：DescribeResourceGrantedAccountGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AccountGroupId | Integer | 否 | 账户组Id 示例值：96 |
| Name | String | 否 | 分组名称 示例值：旧**删 |
| IdPathArray | Array of Integer | 否 | 所属分组Id 示例值：[2] |
| NamePathArray | Array of String | 否 | 所属分组NamePathArray 示例值：["全网账*"] |
| AccountCount | Integer | 否 | 目录id 示例值：3 |
| ExpireTime | Integer | 否 | 过期时间 示例值：0 |
| RelationId | Integer | 否 | 关联id 示例值：12 |
GrantedAccountItem
GrantedAccountItem
被如下接口引用：DescribeResourceGrantedAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AccountId | Integer | 否 | 账户Id 示例值：5101 |
| UserId | String | 否 | 用户UserId 示例值：l***wn |
| UserName | String | 否 | 用户名称 示例值：l**awn |
| GroupId | Integer | 否 | 所属分组Id 示例值：2571 |
| GroupIdPathArray | Array of Integer | 否 | 分组路劲GroupIdPathArray 示例值：[2] |
| GroupNamePathArray | Array of String | 否 | 所属分组NamePathArray 示例值：["全网账户"] |
| MenuId | Integer | 否 | 目录id 示例值：2571 |
| ExpireTime | Integer | 否 | 过期时间 示例值：1 |
| RelationId | Integer | 否 | 关联id 示例值：23 |
GrantedVirtualGroupItem
GrantedAccountItem
被如下接口引用：DescribeResourceGrantedVirtualGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VirtualGroupId | Integer | 否 | 账户组Id 示例值：544 |
| Name | String | 否 | 分组名称 示例值：vpn**** |
| Description | String | 否 | 描述信息 示例值：1* |
| AccountCount | Integer | 否 | 目录id 示例值：2 |
| ExpireTime | Integer | 否 | 过期时间 示例值：0 |
| RelationId | Integer | 否 | 关联id 示例值：47 |
I18nString
I18nString 国际化字符串（对齐云API平台已注册数据结构 ID:131745，用途：入参/出参） 使用方式：通常以 repeated I18nString 数组承载多语言，一条元素装一种语言。 出参示例：[{"Lang":"zh-CN","Value":"策略名"},{"Lang":"en-US","Value":"Policy Name"}] 入参约定：客户端至少提供 zh-CN 一条；后端建议在业务层调用 i18n.MustZhCn 校验。
被如下接口引用：CreateCompanyDirectoryConfig, DescribeCompanyDirectoryConfig, DescribeDLPEdgeNodeGroups, ModifyCompanyDirectoryConfig。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Lang | String | 否 | 语言枚举 枚举值：
示例值：zh-CN |
| Value | String | 否 | 这是一段业务字符串 示例值：数据安全中心 |
ModifyVirtualDeviceGroupsReqItem
操作的设备列表
被如下接口引用：ModifyVirtualDeviceGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DeviceMid | String | 否 | 设备mid 示例值：10527BB0BE025F40B5E8A7D00B5E13E268243DBB |
| Operation | Integer | 否 | 操作标识 0:删除设备 1:添加设备 示例值：0 |
OptionsItem
多项选择数据
被如下接口引用：DescribeProfileFieldsMenu。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ValueCh | String | 否 | 中文值 示例值：A组 |
| ValueEn | String | 否 | 英文值 示例值：A Group |
| OptionKey | Integer | 否 | 每一项的Key值 示例值：1 |
Paging
页码
被如下接口引用：DescribeAccountGroups, DescribeAggrSoftCategorySoftList, DescribeAggrSoftDeviceList, DescribeBusinessResources, DescribeDLPEdgeNodeGroups, DescribeDLPEdgeNodes, DescribeDeviceDetailList, DescribeDeviceHardwareInfoList, DescribeDeviceVirtualGroups, DescribeDevices, DescribeLocalAccounts, DescribeSoftCensusListByDevice, DescribeSoftwareInformation, DescribeVirtualAccounts, DescribeVirtualDevices。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PageSize | Integer | 否 | 每页条数 示例值：10 |
| PageNum | Integer | 否 | 页码 示例值：1 |
| PageCount | Integer | 否 | 总页数 示例值：3 |
| Total | Integer | 否 | 记录总数 示例值：24 |
ProfileFieldItem
登记信息数据
被如下接口引用：DescribeProfileFieldsMenu。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 键值id 示例值：1223 |
| Key | Integer | 排序key(只支持32位) 示例值：0 |
| Title | String | 名称 示例值："个人电脑" |
| Type | Integer | 输入类型(只支持32位) 示例值：0 |
| IsMust | Integer | 是否必选(只支持32位) 示例值：1 |
| IsShow | Integer | 是否显示(只支持32位) 示例值：0 |
| IsCustom | Integer | 是否自定义(只支持32位) 示例值：1 |
| NextOptionKey | Integer | 下一个选项key(只支持32位) 示例值：1 |
| Options | String | 选项数据 示例值：1 |
| IsReplace | Integer | 是否覆盖(只支持32位) 示例值：1 |
| GroupEditable | Boolean | 是否可以修改分组 示例值：true |
| HasRules | Boolean | 是否有规则 示例值：false |
| RuleId | Integer | 规则id 示例值：1 |
| TitleEn | String | 名称-英文 示例值："personal compute" |
| OptionsEn | String | 选项数据-英文 示例值："yes" |
| OptionsItem | Array of OptionsItem | 选项数据(包含中英文) |
ProfileTips
profile开关配置
被如下接口引用：DescribeProfileFieldsMenu。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | 配置id 示例值：1 |
| Value | String | 否 | 各开关值(json) 示例值：{"enable":1,"way":"startup","editable":0,"groupEditable":0} |
RuleExpression
规则表达式
被如下接口引用：CreateDeviceVirtualGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Items | Array of RuleItem | 否 | 规则元数据 |
| Relation | String | 否 | 关系 示例值："并且" |
RuleItem
规则元数据
被如下接口引用：CreateDeviceVirtualGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | 字段名称 示例值："profile_166" |
| Operate | String | 否 | 操作关系（等于、不等于、包含、不包含） 示例值："等于" |
| Value | String | 否 | 内容 示例值："Company assets" |
| Values | Array of String | 否 | 内容，v2多值版本使用 示例值： {"Values": [ "Company assets" ] } |
RulePayload
条件筛选
被如下接口引用：DescribeAccountGroups, DescribeAggrSoftCategorySoftList, DescribeAggrSoftDeviceList, DescribeBusinessResources, DescribeDLPEdgeNodeGroups, DescribeDLPEdgeNodes, DescribeDeviceChildGroups, DescribeDeviceDetailList, DescribeDeviceHardwareInfoList, DescribeDeviceVirtualGroups, DescribeDevices, DescribeLocalAccounts, DescribeSoftCensusListByDevice, DescribeSoftwareInformation, DescribeVirtualAccounts, DescribeVirtualDevices, ExportDeviceDownloadTask, ExportSoftwareInformationList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Groups | Array of RulePayloadItem | 否 | 条件组 注意：此字段可能返回 null，表示取不到有效值。 |
| RelateOption | String | 否 | 条件关系 or/and 注意：此字段可能返回 null，表示取不到有效值。 示例值：or |
RulePayloadItem
条件
被如下接口引用：DescribeAccountGroups, DescribeAggrSoftCategorySoftList, DescribeAggrSoftDeviceList, DescribeBusinessResources, DescribeDLPEdgeNodeGroups, DescribeDLPEdgeNodes, DescribeDeviceChildGroups, DescribeDeviceDetailList, DescribeDeviceHardwareInfoList, DescribeDeviceVirtualGroups, DescribeDevices, DescribeLocalAccounts, DescribeSoftCensusListByDevice, DescribeSoftwareInformation, DescribeVirtualAccounts, DescribeVirtualDevices, ExportDeviceDownloadTask, ExportSoftwareInformationList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FieldKey | String | 否 | 字段Key 注意：此字段可能返回 null，表示取不到有效值。 示例值：LocalIpList |
| Option | String | 否 | 选项（eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于） 注意：此字段可能返回 null，表示取不到有效值。 示例值：ilike |
| Value | Array of String | 否 | 值 注意：此字段可能返回 null，表示取不到有效值。 示例值：["VMware-Win11x"] |
| Groups | Array of RulePayloadItem | 否 | 嵌套条件组 注意：此字段可能返回 null，表示取不到有效值。 |
| RelateOption | String | 否 | RelateOption 关系操作符（and/or），用于根级别条件关系 注意：此字段可能返回 null，表示取不到有效值。 示例值：and |
| ValueType | String | 否 | 值类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：string |
SimpleRule
简单规则表达式
被如下接口引用：CreateDeviceVirtualGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Expressions | Array of RuleExpression | 否 | 规则表达式 |
| Relation | String | 否 | 表达式间逻辑关系 示例值：等于 |
SoftVersionAndNum
软件版本与安装数量
被如下接口引用：DescribeAggrSoftDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Version | String | 否 | 软件版本 注意：此字段可能返回 null，表示取不到有效值。 |
| Num | Integer | 否 | 安装数 注意：此字段可能返回 null，表示取不到有效值。 |
SoftwareInformationData
软件详情响应对象集合
被如下接口引用：DescribeSoftwareInformation。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 软件名称 示例值：Google Chrome |
| InstallDate | String | 安装时间 示例值：2025/04/16 |
| SoftwareId | Integer | 软件列表id(只支持32位) 示例值：23532 |
| Mid | String | 唯一标识Mid 示例值：B454307F6CA03B56E0CFEC44EABF93BB67E56D6F |
| Version | String | 软件版本 示例值：135.0.7049.95 |
| CorpName | String | 公司名 示例值："" //废弃 |
| Id | Integer | 列表Id(只支持32位) 示例值：23532 |
| PiracyRisk | Integer | 盗版风险（0:未支持，1:风险，2:未发现，3:未开启） 示例值：0 |
| DeviceId | Integer | 设备id 示例值：1 |
| OsType | Integer | 平台类型 示例值：0 |
Sort
Sort 排序字段
被如下接口引用：DescribeAccountGroups, DescribeAggrSoftCategorySoftList, DescribeAggrSoftDeviceList, DescribeBusinessResources, DescribeDLPEdgeNodeGroups, DescribeDLPEdgeNodes, DescribeDeviceChildGroups, DescribeDeviceDetailList, DescribeDeviceHardwareInfoList, DescribeDeviceVirtualGroups, DescribeDevices, DescribeLocalAccounts, DescribeSoftCensusListByDevice, DescribeSoftwareInformation, DescribeVirtualAccounts, DescribeVirtualDevices, ExportDeviceDownloadTask, ExportSoftwareInformationList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Field | String | 否 | 排序字段 示例值：UserName |
| Order | String | 否 | 排序方式 示例值：desc |
UnbindVirtualAccountData
取消绑定账户虚拟组响应数据
被如下接口引用：UnbindVirtualAccounts。
| 名称 | 类型 | 描述 |
|---|---|---|
| FailItems | Array of BindVirtualAccountResultData | 解绑失败明细（含失败原因） |
| SuccessItems | Array of BindVirtualAccountResultData | 解绑成功明细（含幂等场景：本就未绑定的账号也归入成功） |
