/** * CreatePrivilegeCode请求参数结构体 */ export interface CreatePrivilegeCodeRequest { /** * 必填;设备唯一标识符; */ Mid: string; /** * 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。 */ DomainInstanceId?: string; /** * 系统类型(0: win,1:linux,2: mac,4:android,5:ios,-1:全系统(SaaS一体化版本) ; 不传默认为0)(只支持32位) */ OsType?: number; } /** * 多网卡MAC地址等列表数据 */ export interface DeviceNetworkCardBrief { /** *
MAC地址
*/ MacAddress?: string; /** *网卡名称
*/ NetworkCardName?: string; /** *网卡类型
枚举值:
网卡状态
枚举值:
IPv4地址
*/ Ipv4Address?: string; /** *IPv6地址
*/ Ipv6Address?: string; } /** * 终端硬件信息列表响应详情 */ export interface DescribeDeviceHardwareInfoListRspData { /** * 分页数据 */ Page?: Paging; /** * 终端硬件信息数据数组 */ Items?: Array企业目录类型
*/ Type: string; /** *企业目录名
*/ Name: string; /** *使用 JSON 字符串表示的配置信息
调用此接口前,需要先调用DescribeCompanyDirectoryConfig获取完整的配置,然后对里面需要更新的配置进行修改,请求的时候必须传完整配置,否则可能导致配置缺失出现错误。如果是脱敏的信息,保持原样的脱敏格式提交,如果和脱敏格式不一致,会认为是新的配置值更新原有配置
*/ Config: string; /** *是否开启定时同步
*/ SyncEnable: boolean; /** *定时同步的策略,枚举值:支持每4小时(4hours)/每日定时(daily)/每周定时(weekly)
*/ SyncPolicy: string; /** *JSON 字符串,针对不同类型的同步策略,提取对应不同的值
*/ SyncPolicyParams: string; /** *是否同步创建认证源
*/ CreateAuthConfig: boolean; /** *是否在登录页展示
*/ DisplayOnLoginPage: boolean; /** *企业目录 ID
*/ Id?: number; /** *描述
*/ Description?: string; /** *名称多语言
*/ NameI18n?: Array分页的data数据
*/ Data?: DescribeDeviceHardwareInfoListRspData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeResourceGrantedAccounts请求参数结构体 */ export interface DescribeResourceGrantedAccountsRequest { /** * 账户组Id(只支持32位) */ ResourceId?: number; } /** * 终端硬件信息列表Item数据 */ export interface DescribeDeviceHardwareInfoItem { /** *设备ID
*/ Id?: number; /** *设备唯一标识符
*/ Mid?: string; /** *OS平台 0 Windows 1 Linux 2 macOS 4 Android 5 iOS
*/ OsType?: number; /** *终端名
*/ Name?: string; /** *终端用户名
*/ UserName?: string; /** *授权状态( 4未授权 5已授权)
*/ Status?: number; /** *设备所属分组ID
*/ GroupId?: number; /** *设备所属分组名
*/ GroupName?: string; /** *设备所属分组路径
*/ GroupNamePath?: string; /** *最近登录账户的姓名
*/ AccountName?: string; /** *出口IP
*/ Ip?: string; /** *MAC地址
*/ MacAddr?: string; /** *CPU品牌型号
*/ Cpu?: string; /** *内存信息
*/ Memory?: string; /** *硬盘信息
*/ HardDiskSize?: string; /** *显示器品牌型号
*/ Monitor?: string; /** *终端备注名
*/ RemarkName?: string; /** *BiosUUID(启动盘标识符)
*/ BiosUuid?: string; /** *多网卡数据
*/ NetworkCards?: Array多显卡数据
*/ VideoCards?: Array主板型号
*/ MainBoard?: string; /** *主板序列号
*/ BaseBoardSn?: string; /** *主板制造商
*/ BaseBoardManufacturer?: string; /** *声卡
*/ AudioCard?: string; } /** * DescribeResourceGrantedAccountGroups请求参数结构体 */ export interface DescribeResourceGrantedAccountGroupsRequest { /** * 资源或资源组Id; */ ResourceId: number; } /** * 条件 */ export interface RulePayloadItem { /** * 字段Key 注意:此字段可能返回 null,表示取不到有效值。 */ FieldKey?: string; /** * 选项(eq:等于,neq:不等于,like,nlike,gt:大于,lt:小于,egt:大于等于,elt:小于等于) 注意:此字段可能返回 null,表示取不到有效值。 */ Option?: string; /** * 值 注意:此字段可能返回 null,表示取不到有效值。 */ Value?: Array账号名
注意:此字段可能返回 null,表示取不到有效值。 */ UserName?: string; /** *计算机名
注意:此字段可能返回 null,表示取不到有效值。 */ ComputerName?: string; /** *名称
注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** *用户组IdPath
注意:此字段可能返回 null,表示取不到有效值。 */ AccountGroupIdPath?: string; /** *用户组id(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ AccountGroupId?: number; /** *终端组名path
注意:此字段可能返回 null,表示取不到有效值。 */ GroupNamePath?: string; /** *Ip地址
注意:此字段可能返回 null,表示取不到有效值。 */ Ip?: string; /** *用户组名
注意:此字段可能返回 null,表示取不到有效值。 */ AccountGroupName?: string; /** *终端组IdPath
注意:此字段可能返回 null,表示取不到有效值。 */ GroupIdPath?: string; /** *唯一标识Mid
注意:此字段可能返回 null,表示取不到有效值。 */ Mid?: string; /** *IOA账号名
注意:此字段可能返回 null,表示取不到有效值。 */ IoaUserName?: string; /** *所在分组Id(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ GroupId?: number; /** *所在分组Name
注意:此字段可能返回 null,表示取不到有效值。 */ GroupName?: string; /** *Mac地址
注意:此字段可能返回 null,表示取不到有效值。 */ Mac?: string; /** *软件版本
注意:此字段可能返回 null,表示取不到有效值。 */ Version?: string; /** *用户组名Path
注意:此字段可能返回 null,表示取不到有效值。 */ AccountGroupNamePath?: string; /** *列表Id(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ Id?: number; } /** * DeleteAccountGroup请求参数结构体 */ export interface DeleteAccountGroupRequest { /** * 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。 */ DomainInstanceId?: string; /** *分组或者目录id(只支持32位)
*/ AccountGroupId?: number; } /** * I18nString 国际化字符串(对齐云API平台已注册数据结构 ID:131745,用途:入参/出参) 使用方式:通常以 repeated I18nString 数组承载多语言,一条元素装一种语言。 出参示例:[{"Lang":"zh-CN","Value":"策略名"},{"Lang":"en-US","Value":"Policy Name"}] 入参约定:客户端至少提供 zh-CN 一条;后端建议在业务层调用 i18n.MustZhCn 校验。 */ export interface I18nString { /** *语言枚举
枚举值:
这是一段业务字符串
*/ Value?: string; } /** * DescribeDevices返回参数结构体 */ export interface DescribeDevicesResponse { /** *分页的data数据
*/ Data?: DescribeDevicesPageRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 聚合软件-已安装终端列表 */ export interface DescribeAggrSoftDeviceListData { /** * 分页公共对象 注意:此字段可能返回 null,表示取不到有效值。 */ Page?: Paging; /** * 总数 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** * 详情 注意:此字段可能返回 null,表示取不到有效值。 */ AggrSoftDeviceList?: Array账号分组名全路径,点分格式
*/ NamePath?: string; /** *账号分组ID全路径,数组格式
*/ IdPathArr?: Array扩展信息
*/ ExtraInfo?: string; /** *最后更新时间
*/ Utime?: string; /** *父分组ID
*/ ParentId?: number; /** *源账号组织ID。使用第三方导入用户源时,记录该分组在源组织架构下的分组ID
*/ OrgId?: string; /** *分组名称
*/ Name?: string; /** *分组ID
*/ Id?: number; /** *分组描述
*/ Description?: string; /** *同步数据源
*/ Source?: number; /** *账号分组ID全路径,点分格式
*/ IdPath?: string; /** *创建时间
*/ Itime?: string; /** *父源账号组织ID。使用第三方导入用户源时,记录该分组在源组织架构下的分组ID
*/ ParentOrgId?: string; /** *导入类型
*/ ImportType?: string; /** *miniIAM id
*/ MiniIamId?: string; /** *该分组下含子组的所有用户总数
*/ UserTotal?: number; /** *是否叶子节点
*/ IsLeaf?: boolean; /** *是否该账户的直接权限
*/ ReadOnly?: boolean; /** *最新一次同步任务的结果
*/ LatestSyncResult?: string; /** *最新一次同步任务的结束时间
*/ LatestSyncTime?: string; /** *分组名称数组
*/ NamePathArr?: Arrayuid,数据库中唯一
*/ Id?: number; /** *账号,登录账号
*/ UserId?: string; /** *用户名
*/ UserName?: string; /** *账号id,同Id字段
*/ AccountId?: number; /** *账号所在的分组id
*/ GroupId?: number; /** *账号所在的分组名称
*/ GroupName?: string; /** *账号所在的分组名称路径,用英文.分割
*/ NamePath?: string; /** *账号来源,0表示本地账号(只支持32位)
*/ Source?: number; /** *账号状态,0禁用,1启用(只支持32位)
*/ Status?: number; /** *账号的创建时间
*/ Itime?: string; /** *账号的最后更新时间
*/ Utime?: string; /** *账号的扩展信息,包含邮箱、手机号、身份证、职位等信息
*/ ExtraInfo?: string; /** *用户风险等级,枚举:none, low, middle, high
*/ RiskLevel?: string; /** *所属组
*/ AccountGroups?: Array绑定手机端设备数
*/ MobileBindNum?: number; /** *绑定Pc端设备数
*/ PcBindNum?: number; /** *账号在线状态 1:在线 2:离线
*/ OnlineStatus?: number; /** *账号活跃状态 1:活跃 2:非活跃
*/ ActiveStatus?: number; /** *账号登录时间
*/ LoginTime?: string; /** *账号登出时间
*/ LogoutTime?: string; } /** * CreateDeviceTask请求参数结构体 */ export interface CreateDeviceTaskRequest { /** * 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。 */ DomainInstanceId?: string; /** * 终端id */ Mid?: string; } /** * 业务响应数据 */ export interface DeviceDetail { /** *设备ID
*/ Id?: number; /** *设备唯一标识码,在ioa中每个设备有唯一标识码
*/ Mid?: string; /** *终端名(设备名)
*/ Name?: string; /** *设备所在分组ID
*/ GroupId?: number; /** *OS平台,0:Windows 、1: Linux、 2:macOS 、4: Android、 5: iOS。默认是0
*/ OsType?: number; /** *设备IP地址(出口IP)
*/ Ip?: string; /** *在线状态,2:在线、0或者1:离线
*/ OnlineStatus?: number; /** *客户端版本号-大整数
*/ Version?: string; /** *客户端版本号-点分字符串
*/ StrVersion?: string; /** *首次在线时间
*/ Itime?: string; /** *最后一次在线时间
*/ ConnActiveTime?: string; /** *设备是否加锁 ,1:锁定 0或者2:未锁定。
*/ Locked?: number; /** *设备本地IP列表, 包括IP
*/ LocalIpList?: string; /** *宿主机id(需要宿主机也安装iOA才能显示)
*/ HostId?: number; /** *设备所属分组名
*/ GroupName?: string; /** *设备所属分组路径
*/ GroupNamePath?: string; /** *未修复高危漏洞数(只支持32位)
*/ CriticalVulListCount?: number; /** *操作系统名称
*/ Os?: string; /** *操作系统位数
*/ OsBits?: number; /** *操作系统版本
*/ OsVersion?: string; /** *操作系统语言
*/ OsLanguage?: string; /** *操作系统安装时间
*/ OsInstallDate?: string; /** *设备名,和Name相同
*/ ComputerName?: string; /** *登录域名
*/ DomainName?: string; /** *MAC地址
*/ MacAddr?: string; /** *漏洞数
*/ VulCount?: number; /** *病毒风险数
*/ RiskCount?: number; /** *病毒库版本
*/ VirusVer?: string; /** *漏洞库版本
*/ VulVersion?: string; /** *系统修复引擎版本
*/ SysRepVersion?: string; /** *高危补丁列表
*/ VulCriticalList?: Array标签
*/ Tags?: string; /** *终端用户名
*/ UserName?: string; /** *防火墙状态,不等于0表示开启
*/ FirewallStatus?: number; /** *SN序列号
*/ SerialNum?: string; /** *设备管控策略版本
*/ DeviceStrategyVer?: string; /** *NGN策略版本
*/ NGNStrategyVer?: string; /** *最近登录账户的账号(账号系统用户账号)
*/ IOAUserName?: string; /** *设备管控新策略
*/ DeviceNewStrategyVer?: string; /** *NGN策略新版本
*/ NGNNewStrategyVer?: string; /** *宿主机名称(需要宿主机也安装iOA才能显示)
*/ HostName?: string; /** *主板序列号
*/ BaseBoardSn?: string; /** *绑定账户名称
*/ AccountUsers?: string; /** *身份策略版本
*/ IdentityStrategyVer?: string; /** *身份策略新版本
*/ IdentityNewStrategyVer?: string; /** *最近登录账号部门
*/ AccountGroupName?: string; /** *最近登录账户的姓名(账号系统用户姓名)
*/ AccountName?: string; /** *账号组id
*/ AccountGroupId?: number; /** *是否开启录屏权限,仅macOS, 0: 未开启 、1: 开启
*/ ScreenRecordingPermission?: number; /** *是否开启磁盘访问权限,仅macOS, 0: 未开启、 1: 开启
*/ DiskAccessPermission?: number; /** *终端备注名
*/ RemarkName?: string; /** *BiosUUID(启动盘标识符)
*/ BiosUuid?: string; } /** * DescribeResourceGrantedVirtualGroups返回参数结构体 */ export interface DescribeResourceGrantedVirtualGroupsResponse { /** * 查询的数据集合 */ Data?: DescribeResourceGrantedVirtualGroupsData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSoftCensusListByDevice请求参数结构体 */ export interface DescribeSoftCensusListByDeviceRequest { /** * 必填,终端分组ID */ GroupId: number; /** * 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。 */ DomainInstanceId?: string; /** * 系统类型(0: win,1:linux,2: mac,4:android,5:ios );默认值0 */ OsType?: number; /** * 过滤条件、分页参数授权信息
*/ Items?: Array企业目录 ID
*/ Id?: number; /** *企业目录名称
*/ Name?: string; /** *身份源配置 ID
*/ IdentifySourceId?: string; /** *是否同步创建了认证配置
*/ CreateAuthConfig?: boolean; /** *认证源配置 ID
*/ AuthSourceId?: string; /** *认证配置 ID
*/ AuthConfigId?: number; /** *认证策略 ID
*/ AuthPolicyId?: number; /** *认证支持的平台, PC 或 Mobile
*/ AuthSupportPlatforms?: Array认证方式,授权认证/扫码认证 等
*/ AuthMethods?: Array名称多语言支持
*/ NameI18n?: Array企业目录类型
*/ Type: string; /** *企业目录名
*/ Name: string; /** *配置是通过 SM2 加密再 Hex 之后的数据
*/ Config: string; /** *是否开启定时同步
*/ SyncEnable: boolean; /** *定时同步的策略,枚举值:支持每4小时(4hours)/每日定时(daily)/每周定时(weekly)
*/ SyncPolicy: string; /** *JSON 字符串,针对不同类型的同步策略,提取对应不同的值
*/ SyncPolicyParams: string; /** *是否同步创建认证源
*/ CreateAuthConfig: boolean; /** *是否在登录页展示
*/ DisplayOnLoginPage: boolean; /** *描述
*/ Description?: string; /** *使用场景:API 创建,快速上手,普通配置等
*/ Scene?: string; /** *名称多语言
*/ NameI18n?: Array终端用户名
注意:此字段可能返回 null,表示取不到有效值。 */ UserName?: string; /** *mac地址
注意:此字段可能返回 null,表示取不到有效值。 */ MacAddr?: string; /** *终端计算机名称
注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** *终端组路径名
注意:此字段可能返回 null,表示取不到有效值。 */ GroupNamePath?: string; /** *IP地址
注意:此字段可能返回 null,表示取不到有效值。 */ Ip?: string; /** *唯一标识Mid
注意:此字段可能返回 null,表示取不到有效值。 */ Mid?: string; /** *企业账户名
注意:此字段可能返回 null,表示取不到有效值。 */ IoaUserName?: string; /** *终端分组Id(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ GroupId?: number; /** *终端组名
注意:此字段可能返回 null,表示取不到有效值。 */ GroupName?: string; /** *终端列表Id(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ Id?: number; /** *软件数量(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ SoftNum?: number; /** *盗版风险(1=风险;2=未知)
注意:此字段可能返回 null,表示取不到有效值。 */ PiracyRisk?: number; /** *终端备注名
*/ RemarkName?: string; } /** * ModifyBusinessResource返回参数结构体 */ export interface ModifyBusinessResourceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBusinessResource请求参数结构体 */ export interface CreateBusinessResourceRequest { /** * 业务资源所在的模块id,没有资源模块先创建资源模块(只支持32位) */ AreaId: number; /** * 业务资源协议类型, 1:UDP, 2:TCP, 3:所有协议(只支持32位) */ Protocol: number; /** * 业务资源名称,同一个资源模块下面不可重复 */ ServiceName: string; /** * 业务资源类型:ip,domain,ip_section,对应ip、域名、ip段 */ ServiceType: string; /** * 业务资源端口 all,1-65535 */ ServicePort: string; /** * 业务资源优先级 1-65535(只支持32位) */ Levels: number; /** * 业务资源地址(ip、域名、ip段) */ ServiceAddress: string; /** * 是否走代理,该参数不传,默认为0, 2:内外网直连,1:内网直连, 0:不启用代理配置(只支持32位) */ DirectConn?: number; } /** * DescribeDeviceInfo请求参数结构体 */ export interface DescribeDeviceInfoRequest { /** * 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。 */ DomainInstanceId?: string; /** * 终端id */ Mid?: string; /** * 查询类型 process_list network_list service_list */ Type?: string; } /** * 创建业务资源响应的数据 */ export interface CreateBusinessResourceData { /** * 创建成功的业务资源数据id 注意:此字段可能返回 null,表示取不到有效值。 */ ServiceId?: number; } /** * GrantResourcesByAccounts请求参数结构体 */ export interface GrantResourcesByAccountsRequest { /** * */ Operations: Array业务资源id(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ ServiceId?: number; /** *业务资源名称
注意:此字段可能返回 null,表示取不到有效值。 */ ServiceName?: string; /** *资源类型:ip,domain,ip_section,对应ip,域名,ip段
注意:此字段可能返回 null,表示取不到有效值。 */ ServiceType?: string; /** *业务资源地址
注意:此字段可能返回 null,表示取不到有效值。 */ ServiceAddress?: string; /** *业务资源端口 all,1-65535
注意:此字段可能返回 null,表示取不到有效值。 */ ServicePort?: string; /** *业务资源创建时间
注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** *业务资源最后修改时间
注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: string; /** *说明字段
注意:此字段可能返回 null,表示取不到有效值。 */ Remark?: string; /** *资源模块ID(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ AreaId?: number; /** *零信任网关id(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ SmartGateIds?: Array业务资源协议类型,3:所有,2:UDP,1:TCP(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ Protocol?: number; /** *业务资源等级(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ Levels?: number; /** *零信任网关名称
注意:此字段可能返回 null,表示取不到有效值。 */ SmartGateNames?: string; /** *网关连通性(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ DirectConn?: number; /** *网关连通性状态(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ DetectState?: number; /** *网关连通性信息
注意:此字段可能返回 null,表示取不到有效值。 */ DetectInfo?: string; /** *网关连通性创建时间
注意:此字段可能返回 null,表示取不到有效值。 */ DetectTime?: string; /** *绑定的连接器组Id
注意:此字段可能返回 null,表示取不到有效值。 */ ConnectorGroupId?: string; /** *绑定的连接器组的名称
注意:此字段可能返回 null,表示取不到有效值。 */ ConnectorGroupName?: string; /** *资源连通性可达最后的检测时间
注意:此字段可能返回 null,表示取不到有效值。 */ ReachableTime?: string; /** *资源连通性可达状态,0:未检测,1:未连通,2:已连通
注意:此字段可能返回 null,表示取不到有效值。 */ ReachableState?: number; /** *访问类型:0-NGN 1-web(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ AccessType?: number; /** *web资源-后端协议
注意:此字段可能返回 null,表示取不到有效值。 */ BackendScheme?: string; /** *web资源-后端路径
注意:此字段可能返回 null,表示取不到有效值。 */ BackendPath?: string; /** *web资源-前端协议
注意:此字段可能返回 null,表示取不到有效值。 */ FrontScheme?: string; /** *web资源-前端host
注意:此字段可能返回 null,表示取不到有效值。 */ FrontHost?: string; /** *web资源-前端host(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ FrontPort?: number; /** *web资源-前端路径 默认"/"
注意:此字段可能返回 null,表示取不到有效值。 */ FrontPath?: string; /** *web资源-是否禁用外网访问:0-可通过外网访问 1-不能通过外网访问(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ DisableFront?: number; /** *web资源-租户自定义域名
注意:此字段可能返回 null,表示取不到有效值。 */ CustomDomain?: string; /** *web资源-自定义host
注意:此字段可能返回 null,表示取不到有效值。 */ CustomHost?: string; /** *web资源-Cname状态(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ CnameStatus?: number; /** *web资源-关联证书ID(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ CertificateId?: number; /** *web资源类型:0-应用 1-API(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ WebGwResourceType?: number; /** *web资源-如果选择API类型资源,则需要配置密钥(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ APISecretId?: number; /** *所属资源组名称
注意:此字段可能返回 null,表示取不到有效值。 */ AreaName?: string; /** *web资源-前端协议是HTTPS类型,需要配置证书
注意:此字段可能返回 null,表示取不到有效值。 */ SSLCertId?: string; /** *web资源-是否启用依赖地址:0-不启用 1-启用(只支持32位)
注意:此字段可能返回 null,表示取不到有效值。 */ EnableDependentAddr?: number; /** *web资源-依赖地址的后端服务器地址
注意:此字段可能返回 null,表示取不到有效值。 */ DependentAddr?: string; /** *web免鉴权:1-鉴权 2-免鉴权
*/ WebGwNoAuth?: number; /** *通道类型
枚举值:
默认值:native
*/ ConnectorGroupType?: string; /** *域名后缀
*/ DomainSuffix?: string; } /** * 账户分组详情响应数据 */ export interface DescribeAccountGroupsPageResp { /** * 账户分响应对象集合 */ Items?: Array显卡名称
*/ VideoCardName?: string; } /** * DescribeDLPEdgeNodes返回参数结构体 */ export interface DescribeDLPEdgeNodesResponse { /** * 业务响应数据 */ Data?: DescribeDLPEdgeNodesPageData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ExportSoftwareInformationList返回参数结构体 */ export interface ExportSoftwareInformationListResponse { /** * 业务响应数据 */ Data?: ExportSoftwareDownloadUrlRspData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeResourceGrantedVirtualGroups请求参数结构体 */ export interface DescribeResourceGrantedVirtualGroupsRequest { /** * 资源ID */ ResourceId?: number; /** * 资源类型 */ ResourceType?: number; } /** * FilterGroups 条件过滤组 */ export interface FilterGroup { /** * Filters 条件过滤 */ Filters?: Array终端唯一标识Mid
*/ Mid?: string; /** *过滤条件、分页参数
0:win 2:mac
*/ OsType?: number; } /** * 业务响应数据 */ export interface DescribeAggrSoftCategorySoftListData { /** * 分页公共对象 注意:此字段可能返回 null,表示取不到有效值。 */ Page?: Paging; /** * 总数(只支持32位) 注意:此字段可能返回 null,表示取不到有效值。 */ Total?: number; /** * 行数据 注意:此字段可能返回 null,表示取不到有效值。 */ AggrSoftCategorySoftList?: Array总数
*/ TotalCount?: number; /** *授权信息
*/ Items?: Array查询ID,即提交送检任务接口(CreateDLPFileDetectionTask)返回的任务ID(DLPFileDetectionTaskID)
*/ QueryID?: string; } /** * ExportDeviceDownloadTask请求参数结构体 */ export interface ExportDeviceDownloadTaskRequest { /** * 系统类型(0: win,1:linux,2: mac,4:android,5:ios,-1:全系统(SaaS一体化版本) ; 不传默认为0)(只支持32位) */ OsType?: number; /** * 管理域实例ID,用于CAM管理域权限分配。若企业未进行管理域的划分,可直接传入根域"1",此时表示针对当前企业的全部设备和账号进行接口CRUD,具体CRUD的影响范围限制于相应接口的入参。 */ DomainInstanceId?: string; /** * 分组id */ GroupId?: number; /** * 在线状态 2 在线 0,1 离线 */ OnlineStatus?: number; /** * 导出顺序,接口返回的数据字段 */ ExportOrder?: string; /** * 导出类型, 0:终端树;7:硬件信息列表导出; */ ExportType?: number; /** * 过滤条件。同DescribeDevices接口 */ Condition?: Condition; } /** * CreateDeviceVirtualGroup返回参数结构体 */ export interface CreateDeviceVirtualGroupResponse { /** * 响应返回的data */ Data?: CreateDeviceVirtualGroupRspData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 提交送检任务相应数据 */ export interface CreateDLPFileDetectionTaskData { /** * 提交任务生成的id,也即requestID。用于后续查询 */ DLPFileDetectionTaskID?: string; } /** * 查询返回终端自定义分组的Data数据 */ export interface DescribeDeviceVirtualGroupsPageRsp { /** * 分页公共对象 */ Page?: Paging; /** * 终端自定义分组列表数据 */ Items?: Array创建企业目录配置的结果
*/ Data?: DirectoryConfigResultData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 聚合软件的已安装终端列表中的一行数据 */ export interface AggrSoftDeviceRow { /** *终端名
注意:此字段可能返回 null,表示取不到有效值。 */ DeviceName?: string; /** *最近登录账号
注意:此字段可能返回 null,表示取不到有效值。 */ LastLoginAccount?: string; /** *终端用户名
注意:此字段可能返回 null,表示取不到有效值。 */ DeviceUserName?: string; /** *软件版本
注意:此字段可能返回 null,表示取不到有效值。 */ Version?: string; /** *是否盗版
注意:此字段可能返回 null,表示取不到有效值。 */ PiracyRisk?: number; /** *盗版原因
注意:此字段可能返回 null,表示取不到有效值。 */ PiracyReason?: string; /** *安装时间
注意:此字段可能返回 null,表示取不到有效值。 */ InstallTime?: string; /** *用户目录
注意:此字段可能返回 null,表示取不到有效值。 */ UserPath?: string; /** *所在分组
注意:此字段可能返回 null,表示取不到有效值。 */ UserGroup?: string; /** *IP
注意:此字段可能返回 null,表示取不到有效值。 */ IP?: string; /** *MAC
注意:此字段可能返回 null,表示取不到有效值。 */ MAC?: string; /** *使用时长
注意:此字段可能返回 null,表示取不到有效值。 */ UseTime?: number; /** *设备ID
注意:此字段可能返回 null,表示取不到有效值。 */ DeviceId?: number; /** *软件全名
注意:此字段可能返回 null,表示取不到有效值。 */ FullSoftName?: string; /** *数据ID(唯一)
注意:此字段可能返回 null,表示取不到有效值。 */ Id?: number; /** *该终端此款软件可升级到的目标版本号
*/ NewVersion?: string; /** *该软件对应运营配置的可升级id
*/ UpgradeSoftId?: number; /** *终端备注名
*/ RemarkName?: string; /** *软件id
*/ SoftwareId?: number; /** *0:win 2:mac
*/ OsType?: number; /** *所有权
*/ AssetType?: string; } /** * DeleteDeviceVirtualGroup返回参数结构体 */ export interface DeleteDeviceVirtualGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 软件版本与安装数量 */ export interface SoftVersionAndNum { /** * 软件版本 注意:此字段可能返回 null,表示取不到有效值。 */ Version?: string; /** * 安装数 注意:此字段可能返回 null,表示取不到有效值。 */ Num?: number; } /** * ExportDeviceDownloadTask返回参数结构体 */ export interface ExportDeviceDownloadTaskResponse { /** * 业务响应数据 */ Data?: DeviceDownloadTask; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 业务响应数据 */ export interface DescribeDeviceDetailListPageData { /** * 终端详情响应对象集合 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array业务响应数据
*/ Data?: DescribeSoftwareInformationPageData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GrantResourcesByAccountGroups返回参数结构体 */ export interface GrantResourcesByAccountGroupsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyVirtualDeviceGroups返回参数结构体 */ export interface ModifyVirtualDeviceGroupsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLocalAccounts返回参数结构体 */ export interface DescribeLocalAccountsResponse { /** * 获取账号列表响应的分页对象 */ Data?: DescribeLocalAccountsPage; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 返回的具体Data数据 */ export interface DescribeVirtualDevicesPageRsp { /** * 数据分页信息 */ Paging?: Paging; /** * 设备列表 */ Items?: Array终端自定义分组id
*/ Id?: number; /** *自定义分组名称
*/ DeviceVirtualGroupName?: string; /** *设备数
*/ DeviceCount?: number; /** *系统类型(0: win,1:linux,2: mac,4:android,5:ios )
*/ OsType?: number; /** *创建时间
*/ Itime?: string; /** *更新时间
*/ Utime?: string; } /** * 分页的data数据 */ export interface DescribeDevicesPageRsp { /** * 数据分页信息 */ Paging?: Paging; /** * 业务响应数据 */ Items?: Array自增id,数据库中唯一
*/ Id?: number; /** *节点分组名称
*/ GroupName?: string; /** *节点分组id
*/ GroupId?: string; /** *包含边缘节点数量
*/ EdgeCount?: number; /** *分组中英文
*/ GroupNameI18n?: Array设备状态,1表示拉黑,0表示加白
*/ Status: number; /** *设备MID列表
*/ DeviceIDList?: Array设备拉黑有效期,UnixTime, 单位是 ms,0表示永久有效,默认值是0
*/ BlackStatusDeadline?: number; /** *DescribeAccuserList返回的Id 列表
*/ IdList?: Array默认值:0,根据id更新,1根据DeviceIDList
*/ UpdateFlags?: number; } /** * DescribeAggrSoftDeviceList返回参数结构体 */ export interface DescribeAggrSoftDeviceListResponse { /** * 已安装终端列表 */ Data?: DescribeAggrSoftDeviceListData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRootAccountGroup返回参数结构体 */ export interface DescribeRootAccountGroupResponse { /** * 账号根分组响应详情 */ Data?: GetAccountGroupData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDirectAccountGroupResources返回参数结构体 */ export interface DescribeDirectAccountGroupResourcesResponse { /** * 查询的数据集合 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: DescribeAccountResourcesData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 简单规则表达式 */ export interface SimpleRule { /** * 规则表达式 */ Expressions?: Array组Id(只支持32位)
*/ AccountGroupId?: number; } /** * ExportSoftwareInformationList请求参数结构体 */ export interface ExportSoftwareInformationListRequest { /** * 终端唯一标识Mid */ Mid?: string; /** * 过滤条件、分页参数企业目录 ID
*/ Id?: number; /** *目录对应身份源类型
枚举值:
企业目录名称
*/ Name?: string; /** *使用 JSON 字符串表示的配置信息
*/ Config?: string; /** *是否开启了定时同步
*/ SyncEnable?: boolean; /** *定时同步的策略
枚举值:
JSON 字符串,针对不同类型的同步策略,提取对应不同的值
*/ SyncPolicyParams?: string; /** *是否配置了同步创建认证配置
*/ CreateAuthConfig?: boolean; /** *描述
*/ Description?: string; /** *对应 Config 的配置 ID
*/ SourceId?: string; /** *是否在登录页展示
*/ DisplayOnLoginPage?: boolean; /** *名称多语言
*/ NameI18n?: Array分组名称全路径,点分格式
*/ NamePath?: string; /** *分组ID全路径,数组格式
*/ IdPathArr?: Array分组扩展信息
*/ ExtraInfo?: string; /** *最后更新时间
*/ Utime?: string; /** *当前分组的父分组ID
*/ ParentId?: number; /** *源账号组ID,该字段仅适用于第三方同步的组织架构,通过OrgId-Id构成源组织架构分组ID-现组织架构分组ID映射关系
*/ OrgId?: string; /** *分组名称
*/ Name?: string; /** *分组ID
*/ Id?: number; /** *分组描述
*/ Description?: string; /** *分组导入源(只支持32位)
*/ Source?: number; /** *分组ID全路径,点分格式
*/ IdPath?: string; /** *创建时间
*/ Itime?: string; /** *父源账号组ID,该字段仅适用于第三方同步的组织架构
*/ ParentOrgId?: string; /** *导入信息,json格式
*/ Import?: string; /** *是否开启导入架构
*/ ImportEnable?: boolean; /** *导入类型
*/ ImportType?: string; /** *miniIAMId,MiniIAM源才有
*/ MiniIamId?: string; } /** * Sort 排序字段 */ export interface Sort { /** * 排序字段 */ Field?: string; /** * 排序方式 */ Order?: string; } /** * BindBusinessResourceConnectorGroup返回参数结构体 */ export interface BindBusinessResourceConnectorGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyCompanyDirectoryConfig返回参数结构体 */ export interface ModifyCompanyDirectoryConfigResponse { /** *编辑企业目录配置的结果
*/ Data?: DirectoryConfigResultData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 业务响应数据 */ export interface DescribeDLPEdgeNodeGroupsRspData { /** * 分组信息 */ Items?: Array企业目录配置详情
*/ Data?: DirectoryConfigData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeResourceGrantedAccountsData */ export interface DescribeResourceGrantedVirtualGroupsData { /** *授权信息
*/ Items?: Array设备组id
*/ Id?: number; /** *设备组名称
*/ Name?: string; /** *设备组描述
*/ Description?: string; /** *父节点id
*/ ParentId?: number; /** *基于id的节点路径
*/ IdPath?: string; /** *基于名称的节点路径
*/ NamePath?: string; /** *分组锁定状态
*/ Locked?: number; /** *系统类型(0: win,1:linux,2: mac,4:android,5:ios )
*/ OsType?: number; /** *排序
*/ Sort?: number; /** *是否自动调整
*/ FromAuto?: number; /** *子节点数量
*/ Count?: number; /** *图标
*/ Icon?: string; /** *是否有ip
*/ WithIp?: number; /** *是否有组ip
*/ HasIp?: boolean; /** *是否是叶子节点
*/ IsLeaf?: boolean; /** *是否只读
*/ ReadOnly?: boolean; /** *对应绑定的账号id
*/ BindAccount?: number; /** *绑定账号的用户名
*/ BindAccountName?: string; } /** * 业务响应数据 */ export interface DescribeSoftCensusListByDevicePageData { /** * 软件统计响应对象集合 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array过滤条件参数(字段含义请参考接口返回值)
分页参数
【和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需要调用分组接口DescribeDeviceChildGroups获取对应分组id
*/ GroupId?: number; /** *系统类型(0: win,1:linux,2: mac,4:android,5:ios,-1:全系统(SaaS一体化版本) ; 不传默认为0)(只支持32位),需要和GroupId或者GroupIds匹配
*/ OsType?: number; /** *在线状态 (2表示在线,0或者1表示离线)
*/ OnlineStatus?: number; /** *过滤条件--兼容旧接口,参数同Condition
*/ Filters?: Array排序字段--兼容旧接口,参数同Condition
*/ Sort?: Sort; /** *获取第几页--兼容旧接口,参数同Condition
*/ PageNum?: number; /** *每页获取数--兼容旧接口,参数同Condition
*/ PageSize?: number; /** *授权状态: 4基础授权 5高级授权
*/ Status?: number; /** *【和GroupId必须有一个填写】设备分组id列表(需要和OsType匹配)
*/ GroupIds?: Array文件鉴定任务结果数据。详情查看具体数据结构
*/ Data?: DescribeDLPFileDetectResultData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCompanyDirectoryConfig请求参数结构体 */ export interface DescribeCompanyDirectoryConfigRequest { /** *企业目录 ID
*/ Id?: number; } /** * CreatePrivilegeCode返回参数结构体 */ export interface CreatePrivilegeCodeResponse { /** * 业务响应数据 */ Data?: CreatePrivilegeCodeRspData; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDeviceHardwareInfoList请求参数结构体 */ export interface DescribeDeviceHardwareInfoListRequest { /** *【必填】设备分组id(需要和OsType匹配),下面是私有化场景下默认id:id-名称-操作系统1 全网终端 Win2 未分组终端 Win30000000 服务器 Win40000101 全网终端 Linux40000102 未分组终端 Linux40000103 服务器 Linux40000201 全网终端 macOS40000202 未分组终端 macOS40000203 服务器 macOS40000401 全网终端 Android40000402 未分组终端 Android40000501 全网终端 iOS40000502 未分组终端 iOSSaaS需要调用分组接口DescribeDeviceChildGroups获取对应分组id
*/ GroupId: number; /** *【必填】系统类型(0: win,1:linux,2: mac,4:android,5:ios,-1:全系统(SaaS一体化版本))(只支持32位),需要和GroupId或者GroupIds匹配
枚举值:
过滤条件参数(字段含义请参考接口返回值) - 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,支持操作:【eq,like,ilike】,支持排序 ,支持排序分页参数 - PageNum 从1开始,小于等于0时使用默认参数 - PageSize 最大值5000,最好不超过100
*/ Condition?: Condition; } /** * 聚合软件详情数据 */ export interface DescribeAggrSoftDetailData { /** * 软件名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 平台 注意:此字段可能返回 null,表示取不到有效值。 */ OsType?: number; /** * 盗版风险 注意:此字段可能返回 null,表示取不到有效值。 */ PiracyRisk?: number; /** * 厂商 注意:此字段可能返回 null,表示取不到有效值。 */ Corp?: string; /** * 已安装版本分布 注意:此字段可能返回 null,表示取不到有效值。 */ SoftVersionDist?: Array账户组Id
*/ AccountGroupId?: number; /** *分组名称
*/ Name?: string; /** *所属分组Id
*/ IdPathArray?: Array所属分组NamePathArray
*/ NamePathArray?: Array目录id
*/ AccountCount?: number; /** *过期时间
*/ ExpireTime?: number; /** *关联id
*/ RelationId?: number; }