KeyCount
分组和组员个数
被如下接口引用:ShowGraph、ShowTop
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | 用户名或日期 示例值: |
| Count | 是 | 否 | Int64 | 数量 示例值: |
Resource
堡垒机服务信息
被如下接口引用:DescribeAcls、DescribeDeviceGroupMembers、DescribeDevices、DescribeOperationTaskDetail、DescribeResources
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceId | 是 | 否 | String | 服务实例ID,如bh-saas-s3ed4r5e 示例值: |
| ApCode | 是 | 否 | String | 地域编码 示例值: |
| SvArgs | 是 | 否 | String | 服务实例规格信息 示例值: |
| VpcId | 是 | 否 | String | VPC ID 示例值: |
| Nodes | 是 | 否 | Uint64 | 服务规格对应的资产数 示例值: |
| RenewFlag | 是 | 否 | Uint64 | 自动续费标记,0 - 表示默认状态,1 - 表示自动续费,2 - 表示明确不自动续费 示例值: |
| ExpireTime | 是 | 否 | Datetime_iso | 过期时间 示例值: |
| Status | 是 | 否 | Uint64 | 资源状态,0 - 未初始化,1 - 正常,2 - 隔离,3 - 销毁,4 - 初始化失败,5 - 初始化中 示例值: |
| ResourceName | 是 | 否 | String | 服务实例名,如T-Sec-堡垒机(SaaS型) 示例值: |
| Pid | 是 | 否 | Uint64 | 定价模型ID 示例值: |
| CreateTime | 是 | 否 | Datetime_iso | 资源创建时间 示例值: |
| ProductCode | 是 | 否 | String | 商品码, p_cds_dasb 示例值: |
| SubProductCode | 是 | 否 | String | 子商品码, sp_cds_dasb_bh_saas 示例值: |
| Zone | 是 | 否 | String | 可用区 示例值: |
| Expired | 是 | 否 | Bool | 是否过期,true-过期,false-未过期 示例值: |
| Deployed | 是 | 否 | Bool | 是否开通,true-开通,false-未开通 示例值: |
| VpcName | 是 | 否 | String | 开通服务的 VPC 名称 示例值: |
| VpcCidrBlock | 是 | 否 | String | 开通服务的 VPC 对应的网段 示例值: |
| SubnetId | 是 | 否 | String | 开通服务的子网ID 示例值: |
| SubnetName | 是 | 否 | String | 开通服务的子网名称 示例值: |
| CidrBlock | 是 | 否 | String | 开通服务的子网网段 示例值: |
| PublicIpSet | 是 | 否 | Array of String | 外部IP 示例值: |
| PrivateIpSet | 是 | 否 | Array of String | 内部IP 示例值: |
| ModuleSet | 是 | 否 | Array of String | 服务开通的高级功能列表,如:[DB] 示例值: |
| UsedNodes | 是 | 否 | Uint64 | 已使用的授权点数 示例值: |
| ExtendPoints | 是 | 否 | Uint64 | 扩展点数 示例值: |
| PackageBandwidth | 是 | 否 | Uint64 | 带宽扩展包个数(4M) 示例值: |
| PackageNode | 是 | 否 | Uint64 | 授权点数扩展包个数(50点) 示例值: |
SearchCommandResult
命令执行检索结果
被如下接口引用:SearchCommand
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Time | 否 | 否 | String | 命令输入的时间 示例值: |
| UserName | 否 | 否 | String | 用户名 示例值: |
| RealName | 否 | 否 | String | 姓名 示例值: |
| InstanceId | 否 | 否 | String | 资产ID 示例值: |
| DeviceName | 否 | 否 | String | 资产名称 示例值: |
| PublicIp | 否 | 否 | String | 资产公网IP 示例值: |
| PrivateIp | 否 | 否 | String | 资产内网IP 示例值: |
| Cmd | 否 | 否 | String | 命令 示例值: |
| Action | 否 | 否 | Uint64 | 命令执行情况,1--允许,2--拒绝 示例值: |
| Sid | 否 | 否 | String | 命令所属的会话ID 示例值: |
| TimeOffset | 否 | 否 | Uint64 | 命令执行时间相对于所属会话开始时间的偏移量,单位ms 示例值: |
CmdTemplate
高危命令模板
被如下接口引用:DescribeAcls、DescribeCmdTemplates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 高危命令模板ID 示例值: |
| Name | 是 | 否 | String | 高危命令模板名称 示例值: |
| CmdList | 是 | 否 | String | 命令列表,命令之间用换行符("\n")分隔 示例值: |
LicenseUsage
license用量对象
被如下接口引用:DescribeLicenseUsage
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ProductId | 否 | 否 | String | 磐石中计费项id 示例值: |
| UsageValue | 否 | 否 | Uint64 | 用量 示例值: |
SubtaskResult
运维子任务执行结果
被如下接口引用:SearchSubtaskResultById
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | 执行日志ID 示例值: |
| InstanceId | 是 | 否 | String | 执行主机实例ID 示例值: |
| Name | 是 | 否 | String | 执行主机名称 示例值: |
| ApCode | 是 | 否 | String | 执行主机地域 示例值: |
| PublicIp | 是 | 否 | String | 执行主机外网IP 示例值: |
| PrivateIp | 是 | 否 | String | 执行主机内网IP 示例值: |
| Status | 是 | 否 | Uint64 | 运维任务状态 1 - 执行中,2 - 成功, 3 - 失败,4 - 超时 示例值: |
| Reason | 是 | 否 | String | 运维任务失败原因 示例值: |
| ExitCode | 是 | 否 | Int64 | 运维任务命令退出码 示例值: |
| StartTime | 是 | 否 | String | 运维任务开始时间 示例值: |
| EndTime | 是 | 否 | String | 运维任务结束时间 示例值: |
| StdOut | 是 | 否 | String | 运维任务执行结果输出 示例值: |
| StdErr | 是 | 否 | String | 运维任务执行结果错误 示例值: |
AuditLogResult
审计日志
被如下接口引用:SearchAuditLog
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Sid | 是 | 否 | String | 被审计会话的Sid 示例值: |
| Uin | 是 | 否 | String | 审计者的编号 示例值: |
| Time | 是 | 否 | String | 审计动作发生的时间 示例值: |
| ClientIp | 是 | 否 | String | 审计者的Ip 示例值: |
| Operation | 是 | 否 | Int64 | 审计动作类型,1--回放、2--中断、3--监控 示例值: |
| InstanceId | 是 | 否 | String | 被审计主机的Id 示例值: |
| DeviceName | 是 | 否 | String | 被审计主机的主机名 示例值: |
| Protocol | 是 | 否 | String | 被审计会话所属的类型,如字符会话 示例值: |
| PrivateIp | 是 | 否 | String | 被审计主机的内部Ip 示例值: |
| PublicIp | 是 | 否 | String | 被审计主机的外部Ip 示例值: |
| SubAccountUin | 是 | 否 | String | 审计者的子账号 示例值: |
SearchFileTypeFilter
用于搜索文件传输记录等日志时按照protocol和method进行过滤
被如下接口引用:SearchFileBySid
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Protocol | 是 | 否 | String | 需要查询的文件传输类型,如SFTP/CLIP/RDP/RZSZ 示例值: |
| Method | 否 | 否 | Array of Int64 | 在当前指定的protocol下进一步过滤具体操作类型,如剪贴板文件上传,剪贴板文件下载等 示例值: |
EventResult
风险事件的出参
被如下接口引用:SearchEvent
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Sid | 是 | 否 | String | 会话Id 示例值: |
| UserName | 是 | 否 | String | 用户名 示例值: |
| ApCode | 是 | 否 | String | 地域信息 示例值: |
| InstanceId | 是 | 否 | String | 主机id 示例值: |
| DeviceName | 是 | 否 | String | 主机名 示例值: |
| Cmd | 是 | 否 | String | 高危命令或文件传输风险操作的文件名 示例值: |
| Time | 是 | 否 | String | 高危命令执行时间 示例值: |
| Type | 是 | 否 | Int64 | 事件类型,如shell命令、文件传输等 示例值: |
| Method | 是 | 否 | Int64 | 各Type所属子类型,如:Type为文件传输时,此字段代表文件操作类型 示例值: |
Device
资产信息
被如下接口引用:DescribeAcls、DescribeDeviceGroupMembers、DescribeDevices、DescribeOperationTaskDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 资产ID 示例值: |
| InstanceId | 是 | 否 | String | 实例ID,对应CVM、CDB等实例ID 示例值: |
| Name | 是 | 否 | String | 资产名 示例值: |
| PublicIp | 是 | 否 | String | 公网IP 示例值: |
| PrivateIp | 是 | 否 | String | 内网IP 示例值: |
| ApCode | 是 | 否 | String | 地域编码 示例值: |
| OsName | 是 | 否 | String | 操作系统名称 示例值: |
| Kind | 是 | 否 | Uint64 | 资产类型 1 - Linux, 2 - Windows, 3 - MySQL, 4 - SQLServer 示例值: |
| Port | 是 | 否 | Uint64 | 管理端口 示例值: |
| GroupSet | 是 | 否 | Array of Group | 所属资产组列表 示例值:查看 |
| AccountCount | 是 | 否 | Uint64 | 资产绑定的账号数 示例值: |
| VpcId | 是 | 否 | String | VPC ID 示例值: |
| SubnetId | 是 | 否 | String | 子网ID 示例值: |
| Resource | 是 | 是 | Resource | 堡垒机服务信息,注意没有绑定服务时为null 示例值:查看 |
| Department | 是 | 是 | Department | 资产所属部门 示例值:查看 |
TaskResultDetail
运维父任务执行结果详情
被如下接口引用:SearchTaskResultDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | 运维任务结果日志ID 示例值: |
| OperationId | 是 | 否 | String | 运维任务ID 示例值: |
| Name | 是 | 否 | String | 运维任务名称 示例值: |
| Type | 是 | 否 | Uint64 | 任务类型 1 - 手工任务, 2 - 周期性任务 示例值: |
| FromIp | 是 | 否 | String | 运维任务来源IP 示例值: |
| StartTime | 是 | 否 | String | 运维任务开始时间 示例值: |
| EndTime | 是 | 否 | String | 运维任务结束时间 示例值: |
| UserName | 是 | 否 | String | 运维任务创建人员用户名 示例值: |
| RealName | 是 | 否 | String | 运维任务创建人员姓名 示例值: |
| Account | 是 | 否 | String | 运维任务执行账户 示例值: |
| Timeout | 是 | 否 | Uint64 | 运维任务超时时间, 单位秒 示例值: |
| Script | 是 | 否 | String | 运维任务命令 示例值: |
SearchFileResult
文件传输检索结果
被如下接口引用:SearchFile
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Time | 否 | 否 | String | 文件传输的时间 示例值: |
| UserName | 否 | 否 | String | 用户名 示例值: |
| RealName | 否 | 否 | String | 姓名 示例值: |
| InstanceId | 否 | 否 | String | 资产ID 示例值: |
| DeviceName | 否 | 否 | String | 资产名称 示例值: |
| PublicIp | 否 | 否 | String | 资产公网IP 示例值: |
| PrivateIp | 否 | 否 | String | 资产内网IP 示例值: |
| Action | 否 | 否 | Uint64 | 操作结果:1 - 已执行,2 - 已阻断 示例值: |
| Method | 否 | 否 | Uint64 | 操作类型:1 - 文件上传,2 - 文件下载,3 - 文件删除,4 - 文件(夹)移动,5 - 文件(夹)重命名,6 - 新建文件夹,9 - 删除文件夹 示例值: |
| FileCurr | 否 | 否 | String | 下载的文件(夹)路径及名称 示例值: |
| FileNew | 否 | 否 | String | 上传或新建文件(夹)路径及名称 示例值: |
Group
组信息,用于用户组、主机组
被如下接口引用:CreateUserBatch、DescribeAcls、DescribeDeviceGroupMembers、DescribeDeviceGroups、DescribeDevices、DescribeOperationTaskDetail、DescribeUserGroupMembers、DescribeUserGroups、DescribeUsers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 组ID 示例值: |
| Name | 是 | 否 | String | 组名称 示例值: |
| Department | 是 | 是 | Department | 所属部门信息 示例值:查看 |
LDAPSetting
LDAP配置信息
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Enable | 是 | 否 | Bool | 是否开启LDAP认证,false-不开启,true-开启 示例值: |
| Ip | 是 | 否 | String | 服务器地址 示例值: |
| IpBackup | 是 | 否 | String | 备用服务器地址 示例值: |
| Port | 是 | 否 | Uint64 | 服务端口 示例值: |
| EnableSSL | 是 | 否 | Bool | 是否开启SSL,false-不开启,true-开启 示例值: |
| BaseDN | 是 | 否 | String | Base DN 示例值: |
| AdminAccount | 是 | 否 | String | 管理员账号 示例值: |
| AttributeUser | 是 | 否 | String | 用户属性 示例值: |
| AttributeUserName | 是 | 否 | String | 用户名属性 示例值: |
| AutoSync | 是 | 否 | Bool | 自动同步,false-不开启,true-开启 示例值: |
| Overwrite | 是 | 否 | Bool | 覆盖用户信息,false-不开启,true-开启 示例值: |
| SyncPeriod | 是 | 否 | Uint64 | 同步周期,30~60000之间的整数 示例值: |
| SyncAll | 是 | 否 | Bool | 是否同步全部,false-不开启,true-开启 示例值: |
| SyncUnitSet | 是 | 否 | Array of String | 同步OU列表 示例值: |
| AttributeUnit | 是 | 否 | String | 组织单元属性 示例值: |
| AttributeRealName | 是 | 否 | String | 用户姓名属性 示例值: |
| AttributePhone | 是 | 否 | String | 手机号属性 示例值: |
| AttributeEmail | 是 | 否 | String | 邮箱属性 示例值: |
AccessWhiteListRule
访问白名单规则
被如下接口引用:DescribeAccessWhiteListRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 规则ID 示例值: |
| Source | 是 | 否 | String | IP或者网段 示例值: |
| Remark | 是 | 否 | String | 备注信息 示例值: |
| ModifyTime | 是 | 否 | Datetime_iso | 修改时间 示例值: |
ExternalDevice
主机参数,导入外部主机时使用
被如下接口引用:ImportExternalDevice
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 否 | 否 | String | 主机名,可为空 示例值: |
| OsName | 是 | 否 | String | 操作系统名称,只能是Linux、Windows或MySQL 示例值: |
| Ip | 是 | 否 | String | IP地址 示例值: |
| Port | 是 | 否 | Uint64 | 管理端口 示例值: |
| DepartmentId | 否 | 否 | String | 资产所属的部门ID 示例值: |
AuthModeSetting
认证方式设置
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AuthMode | 是 | 否 | Uint64 | 双因子认证,0-不开启,1-OTP,2-短信 示例值: |
TagFilter
资产标签
被如下接口引用:DescribeDeviceGroupMembers、DescribeDevices
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 否 | String | 标签key 示例值: |
| TagValue | 否 | 否 | Array of String | 标签value 示例值: |
LogOutputSettings
日志外发配置
被如下接口引用:DescribeLogOutputSettings
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Enabled | 是 | 否 | Bool | 是否已开启日志外发 示例值: |
| ProductLogin | 是 | 否 | Bool | 是否已开启产品登录日志发送 示例值: |
| DeviceLogin | 是 | 否 | Bool | 是否已开启资产登录日志发送 示例值: |
PasswordSetting
密码要求设置。
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MinLength | 是 | 否 | Uint64 | 密码最小长度,8-20,默认8。 示例值: |
| Complexity | 是 | 否 | Uint64 | 密码复杂度,0不限制,1包含字母和数字,2至少包括大写字母、小写字母、数字、特殊符号,默认2。 示例值: |
| ValidTerm | 是 | 否 | Uint64 | 密码有效期,0不限制,30天,90天,180天。 示例值: |
| CheckHistory | 是 | 否 | Uint64 | 检查最近n次密码设置是否存在相同密码,2-10,默认5。 示例值: |
FileInformation
搜索文件传输会话时返回的文件信息
被如下接口引用:SearchFileSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| File | 是 | 否 | String | 文件名 示例值: |
| Mode | 是 | 否 | Uint64 | 对文件的动作,1为上传,2为下载,3为删除,4为重命名 示例值: |
| Time | 是 | 否 | String | 操作文件的时间 示例值: |
| Size | 是 | 否 | Uint64 | 文件的大小 示例值: |
| Protocol | 是 | 否 | String | 操作文件时所用的协议 示例值: |
SessionFile
搜索文件及所属会话的结果集
被如下接口引用:SearchFileSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | 会话Id 示例值: |
| UserName | 是 | 否 | String | 用户名 示例值: |
| RealName | 是 | 否 | String | 姓名 示例值: |
| Account | 是 | 否 | String | 主机账号 示例值: |
| InstanceId | 是 | 否 | String | 设备ID 示例值: |
| DeviceName | 是 | 否 | String | 主机名 示例值: |
| PrivateIp | 是 | 否 | String | 主机内网Ip 示例值: |
| PublicIp | 是 | 否 | String | 主机外网Ip 示例值: |
| FromIp | 是 | 否 | String | 来源Ip 示例值: |
| Files | 是 | 否 | Array of FileInformation | 属于该会话的文件集合 示例值:查看 |
SessionCommand
命令和所属会话
被如下接口引用:SearchCommandSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| StartTime | 是 | 否 | String | 开始时间 示例值: |
| EndTime | 是 | 否 | String | 结束时间 示例值: |
| UserName | 是 | 否 | String | 用户名 示例值: |
| RealName | 是 | 否 | String | 账号 示例值: |
| DeviceName | 是 | 否 | String | 设备名 示例值: |
| PrivateIp | 是 | 否 | String | 内部Ip 示例值: |
| PublicIp | 是 | 否 | String | 外部Ip 示例值: |
| Commands | 是 | 否 | Array of Command | 命令列表 示例值:查看 |
| Count | 是 | 否 | Uint64 | 记录数 示例值: |
| Id | 是 | 否 | String | 会话Id 示例值: |
| InstanceId | 是 | 否 | String | 设备id 示例值: |
| ApCode | 是 | 否 | String | 设备所属的地域 示例值: |
DeviceAccount
主机账号
被如下接口引用:DescribeDeviceAccounts
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 账号ID 示例值: |
| DeviceId | 是 | 否 | Uint64 | 主机ID 示例值: |
| Account | 是 | 否 | String | 账号名 示例值: |
| BoundPassword | 是 | 否 | Bool | true-已托管密码,false-未托管密码 示例值: |
| BoundPrivateKey | 是 | 否 | Bool | true-已托管私钥,false-未托管私钥 示例值: |
OperationEvent
操作日志
被如下接口引用:DescribeOperationEvent
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UserName | 是 | 否 | String | 用户名 示例值: |
| RealName | 是 | 否 | String | 姓名 示例值: |
| Time | 是 | 否 | Datetime_iso | 操作时间 示例值: |
| SourceIp | 是 | 否 | String | 来源IP 示例值: |
| Kind | 是 | 否 | Uint64 | 操作类型 示例值: |
| Operation | 是 | 否 | String | 具体操作内容 示例值: |
| Result | 是 | 否 | Uint64 | 操作结果,1-成功,2-失败 示例值: |
Map
map类型改造,用于返回key、value型数据
被如下接口引用:DescribeOperationType
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 对应map的key 示例值: |
| Value | 是 | 否 | String | 对应map的value 示例值: |
TaskResult
运维父任务执行结果
被如下接口引用:SearchTaskResult
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | 运维任务结果日志ID 示例值: |
| OperationId | 是 | 否 | String | 运维任务ID 示例值: |
| Name | 是 | 否 | String | 运维任务名称 示例值: |
| FromIp | 是 | 否 | String | 执行任务来源IP 示例值: |
| UserName | 是 | 否 | String | 运维任务所属用户 示例值: |
| RealName | 是 | 否 | String | 运维任务所属用户的姓名 示例值: |
| Status | 是 | 否 | Uint64 | 运维任务执行状态 1 - 执行中,2 - 成功,3 - 失败,4 - 部分失败 示例值: |
| StartTime | 是 | 否 | String | 运维任务开始时间 示例值: |
| EndTime | 是 | 否 | String | 运维任务结束时间 示例值: |
Cvm
cvm实例参数,导入主机时使用
被如下接口引用:ImportDevices
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | cvm实例id 示例值: |
| InstanceName | 是 | 否 | String | 主机名 示例值: |
| OsName | 是 | 否 | String | 操作系统名称 示例值: |
| PublicIpAddresses | 是 | 否 | String | 外网IP 示例值: |
| PrivateIpAddresses | 是 | 否 | String | 内网IP 示例值: |
| VpcId | 是 | 否 | String | vpc ID 示例值: |
| SubnetId | 是 | 否 | String | 子网ID 示例值: |
SearchFileBySidResult
文件操作搜索结果
被如下接口引用:SearchFileBySid
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Time | 是 | 否 | String | 文件操作时间 示例值: |
| Method | 是 | 否 | Int64 | 1-上传文件 2-下载文件 3-删除文件 4-移动文件 5-重命名文件 6-新建文件夹 7-移动文件夹 8-重命名文件夹 9-删除文件夹 示例值: |
| Protocol | 是 | 否 | String | 文件传输协议 示例值: |
| FileCurr | 是 | 否 | String | method为上传、下载、删除时文件在服务器上的位置, 或重命名、移动文件前文件的位置 示例值: |
| FileNew | 是 | 是 | String | method为重命名、移动文件时代表移动后的新位置.其他情况为null 示例值: |
| Size | 是 | 是 | Int64 | method为上传文件、下载文件、删除文件时显示文件大小。其他情况为null 示例值: |
| Action | 是 | 否 | Int64 | 堡垒机拦截情况, 1-已执行, 2-被阻断 示例值: |
SecuritySetting
系统安全设置
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AuthMode | 是 | 否 | AuthModeSetting | 认证方式设置 示例值:查看 |
| Password | 是 | 否 | PasswordSetting | 密码安全设置 示例值:查看 |
| Login | 是 | 否 | LoginSetting | 登录安全设置 示例值:查看 |
| LDAP | 是 | 否 | LDAPSetting | LDAP配置信息 示例值:查看 |
User
用户信息
被如下接口引用:CreateUserBatch、DescribeAcls、DescribeUserGroupMembers、DescribeUsers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | Uint64 | 用户ID 示例值: |
| UserName | 是 | 否 | String | 用户名, 3-20个字符 必须以英文字母开头,且不能包含字母、数字、.、_、-以外的字符 示例值: |
| RealName | 是 | 否 | String | 用户姓名, 最大20个字符,不能包含空白字符 示例值: |
| Phone | 是 | 否 | String | 手机号码, 大陆手机号直接填写,如果是其他国家、地区号码,按照"国家地区代码 |
| 否 | 否 | String | 电子邮件 示例值: |
|
| ValidateFrom | 否 | 否 | Datetime_iso | 用户生效时间,如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则用户长期有效 示例值: |
| ValidateTo | 否 | 否 | Datetime_iso | 用户失效时间,如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则用户长期有效 示例值: |
| GroupSet | 否 | 否 | Array of Group | 所属用户组列表 示例值:查看 |
| AuthType | 否 | 否 | Uint64 | 认证方式,0 - 本地,1 - LDAP,2 - OAuth 示例值: |
| ValidateTime | 否 | 否 | String | 访问时间段限制, 由0、1组成的字符串,长度168(7 × 24),代表该用户在一周中允许访问的时间段。字符串中第N个字符代表在一周中的第N个小时, 0 - 代表不允许访问,1 - 代表允许访问 示例值: |
| Department | 否 | 是 | Department | 用户所属部门(用于出参) 示例值:查看 |
| DepartmentId | 否 | 是 | String | 用户所属部门(用于入参) 示例值: |
Departments
部门列表
被如下接口引用:DescribeDepartments
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DepartmentSet | 是 | 否 | Array of Department | 部门列表 示例值:查看 |
| Enabled | 是 | 否 | Bool | 是否开启了部门管理 true - 已开启, false - 未开启 示例值: |
| RootManager | 是 | 否 | Bool | 当前操作UIN是否是根部门管理员 示例值: |
GraphResult
折线图接口出参
被如下接口引用:ShowGraph
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Sessions | 是 | 否 | Array of KeyCount | 日期和当日新开会话数量 示例值:查看 |
| Commands | 是 | 否 | Array of KeyCount | 日期和当日命令总数 示例值:查看 |
| Dangers | 是 | 否 | Array of KeyCount | 日期和高危命令总数 示例值:查看 |
SessionResult
搜索字符或图形会话时返回的SessionResul结构体
被如下接口引用:SearchSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UserName | 是 | 否 | String | 用户名 示例值: |
| RealName | 是 | 否 | String | 姓名 示例值: |
| Account | 是 | 否 | String | 主机账号 示例值: |
| StartTime | 是 | 否 | String | 开始时间 示例值: |
| EndTime | 是 | 否 | String | 结束时间 示例值: |
| Size | 是 | 否 | Uint64 | 会话大小 示例值: |
| InstanceId | 是 | 否 | String | 设备ID 示例值: |
| DeviceName | 是 | 否 | String | 设备名 示例值: |
| PrivateIp | 是 | 否 | String | 内部Ip 示例值: |
| PublicIp | 是 | 否 | String | 外部Ip 示例值: |
| FromIp | 是 | 否 | String | 来源Ip 示例值: |
| Duration | 是 | 否 | Float | 会话持续时长 示例值: |
| Count | 是 | 否 | Uint64 | 该会话内命令数量 ,搜索图形会话时该字段无意义 示例值: |
| DangerCount | 是 | 否 | Uint64 | 该会话内高危命令数,搜索图形时该字段无意义 示例值: |
| Status | 是 | 否 | Uint64 | 会话状态,如1会话活跃 2会话结束 3强制离线 4其他错误 示例值: |
| Id | 是 | 否 | String | 会话Id 示例值: |
| ApCode | 是 | 否 | String | 设备所属的地域 示例值: |
| Protocol | 是 | 否 | String | 会话协议 示例值: |
OperationTaskStatistics
运维任务统计
被如下接口引用:DescribeOperationTaskStatistics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Total | 是 | 否 | Int64 | 当前允许配置的运维任务最大数量 示例值: |
| Used | 是 | 否 | Int64 | 当前已配置的运维任务数量 示例值: |
| Periodic | 是 | 否 | Int64 | 当前已配置的周期性触发运维任务数量 示例值: |
| Manual | 是 | 否 | Int64 | 当前已配置的手工触发运维任务数量 示例值: |
| Running | 是 | 否 | Int64 | 当前正在执行中的运维任务数量 示例值: |
ActiveDevice
活跃主机的主机信息
被如下接口引用:ShowTop
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | 主机ID 示例值: |
| DeviceName | 是 | 否 | String | 主机名 示例值: |
| ApCode | 是 | 否 | String | 地域信息 示例值: |
| Count | 是 | 否 | Int64 | 活跃主机的活跃次数 示例值: |
DatabaseStatement
数据库操作
被如下接口引用:SearchStatementBySid
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Statement | 是 | 否 | String | 数据库操作 示例值: |
| Time | 是 | 否 | String | 操作时间 示例值: |
| Action | 是 | 否 | Int64 | 执行情况,1--允许,2--拒绝,3--确认 示例值: |
AccountWithDeviceCount
账号名及拥有该同名账号的主机数量
被如下接口引用:DescribeAccountsWithDeviceCount
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Account | 是 | 否 | String | 账号名 示例值: |
| DeviceCount | 是 | 否 | Uint64 | 拥有该同名账号的主机数量 示例值: |
AssetSyncStatus
资产同步状态
被如下接口引用:DescribeAssetSyncStatus
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LastTime | 是 | 否 | String | 上一次同步完成的时间 示例值: |
| LastStatus | 是 | 否 | Uint64 | 上一次同步的结果。 0 - 从未进行, 1 - 成功, 2 - 失败 示例值: |
| InProcess | 是 | 否 | Bool | 同步任务是否正在进行中 示例值: |
LoginSetting
登录安全设置
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TimeOut | 是 | 否 | Uint64 | 登录会话超时,10分钟,20分钟,30分钟,默认20分钟 示例值: |
| LockThreshold | 是 | 否 | Uint64 | 连续密码错误次数,超过锁定账号,3-5 示例值: |
| LockTime | 是 | 否 | Uint64 | 账号锁定时长,10分钟,20分钟,30分钟 示例值: |
OperationTask
运维任务信息
被如下接口引用:DescribeOperationTasks
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 运维任务主键ID 示例值: |
| OperationId | 是 | 否 | String | 运维任务ID 示例值: |
| Name | 是 | 否 | String | 运维任务名称 示例值: |
| UserName | 是 | 否 | String | 创建用户 示例值: |
| RealName | 是 | 否 | String | 运维人员姓名 示例值: |
| Type | 是 | 否 | Uint64 | 任务类型,1 - 手工执行任务, 2 - 周期性任务 示例值: |
| Period | 是 | 否 | Uint64 | 周期性任务执行间隔,单位天 示例值: |
| NextTime | 是 | 是 | String | 执行账户 示例值: |
| FirstTime | 是 | 否 | String | 下一次执行时间 示例值: |
ParamDeviceAccount
资产账号, 用于根据IP导入账号密码或密钥
被如下接口引用:ImportDeviceAccount
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip | 否 | 否 | String | 资产ip 示例值: |
| Account | 是 | 否 | String | 账号名称,1-64,不能包含空白字符 示例值: |
| Password | 否 | 否 | String | 账号密码,1-64字符 示例值: |
| InstanceId | 否 | 否 | String | 实例ID 示例值: |
| PrivateKey | 否 | 否 | String | 账号密钥 示例值: |
| PrivateKeyPassword | 否 | 否 | String | 账号密钥的密码 示例值: |
OperationTaskDetail
运维任务详情
被如下接口引用:DescribeOperationTaskDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 运维任务主键ID 示例值: |
| Name | 是 | 否 | String | 运维任务名称 示例值: |
| OperationId | 是 | 否 | String | 运维任务ID 示例值: |
| Type | 是 | 否 | Uint64 | 任务类型,1 - 手工执行任务, 2 - 周期性任务 示例值: |
| Period | 是 | 否 | Uint64 | 周期性任务执行间隔,单位天 示例值: |
| FirstTime | 是 | 否 | String | 首次执行时间 示例值: |
| Account | 是 | 否 | String | 执行账户 示例值: |
| Timeout | 是 | 否 | Uint64 | 任务超时时间,单位秒 示例值: |
| Script | 是 | 否 | String | 任务命令 示例值: |
| Devices | 是 | 否 | Array of Device | 执行任务的资产信息 示例值:查看 |
| NextTime | 是 | 是 | String | 下次任务执行时间 示例值: |
| UserName | 是 | 否 | String | 用户名 示例值: |
| RealName | 是 | 否 | String | 姓名 示例值: |
Command
命令集合
被如下接口引用:SearchCommandBySid、SearchCommandSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cmd | 是 | 否 | String | 命令 示例值: |
| Time | 是 | 否 | String | 命令输入的时间 示例值: |
| TimeOffset | 是 | 否 | Uint64 | 命令执行时间相对于所属会话开始时间的偏移量,单位ms 示例值: |
| Action | 是 | 否 | Int64 | 命令执行情况,1--允许,2--拒绝,3--确认 示例值: |
ProductCost
产品价格对象
被如下接口引用:InquireCreateDasbResource
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TotalCost | 是 | 否 | Float | 总费用 示例值: |
| RealCost | 是 | 否 | Float | RealCost 示例值: |
ReplayInformation
回放所需字段信息
被如下接口引用:KillSession、MonitorSession、ReplaySession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Token | 是 | 否 | String | 令牌 示例值: |
| StartTime | 是 | 否 | String | 会话开始时间 示例值: |
| Address | 是 | 否 | String | 回放链接 示例值: |
LoginEvent
登录日志
被如下接口引用:DescribeLoginEvent
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UserName | 是 | 否 | String | 用户名 示例值: |
| RealName | 是 | 否 | String | 姓名 示例值: |
| Time | 是 | 否 | Datetime_iso | 操作时间 示例值: |
| SourceIp | 是 | 否 | String | 来源IP 示例值: |
| Entry | 是 | 否 | Uint64 | 登录入口:1-字符界面,2-图形界面,3-web页面, 4-API 示例值: |
| Result | 是 | 否 | Uint64 | 操作结果,1-成功,2-失败 示例值: |
Acl
访问权限
被如下接口引用:DescribeAcls
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 访问权限ID 示例值: |
| Name | 是 | 否 | String | 访问权限名称 示例值: |
| AllowDiskRedirect | 是 | 否 | Bool | 是否开启磁盘映射 示例值: |
| AllowClipFileUp | 是 | 否 | Bool | 是否开启剪贴板文件上行 示例值: |
| AllowClipFileDown | 是 | 否 | Bool | 是否开启剪贴板文件下行 示例值: |
| AllowClipTextUp | 是 | 否 | Bool | 是否开启剪贴板文本(目前含图片)上行 示例值: |
| AllowClipTextDown | 是 | 否 | Bool | 是否开启剪贴板文本(目前含图片)下行 示例值: |
| AllowFileUp | 是 | 否 | Bool | 是否开启文件传输上传 示例值: |
| MaxFileUpSize | 是 | 否 | Uint64 | 文件传输上传大小限制(预留参数,暂未启用) 示例值: |
| AllowFileDown | 是 | 否 | Bool | 是否开启文件传输下载 示例值: |
| MaxFileDownSize | 是 | 否 | Uint64 | 文件传输下载大小限制(预留参数,暂未启用) 示例值: |
| AllowAnyAccount | 是 | 否 | Bool | 是否允许任意账号登录 示例值: |
| UserSet | 是 | 否 | Array of User | 关联的用户列表 示例值:查看 |
| UserGroupSet | 是 | 否 | Array of Group | 关联的用户组列表 示例值:查看 |
| DeviceSet | 是 | 否 | Array of Device | 关联的资产列表 示例值:查看 |
| DeviceGroupSet | 是 | 否 | Array of Group | 关联的资产组列表 示例值:查看 |
| AccountSet | 是 | 否 | Array of String | 关联的账号列表 示例值: |
| CmdTemplateSet | 是 | 否 | Array of CmdTemplate | 关联的高危命令模板列表 示例值:查看 |
| AllowDiskFileUp | 是 | 否 | Bool | 是否开启 RDP 磁盘映射文件上传 示例值: |
| AllowDiskFileDown | 是 | 否 | Bool | 是否开启 RDP 磁盘映射文件下载 示例值: |
| AllowShellFileUp | 是 | 否 | Bool | 是否开启 rz sz 文件上传 示例值: |
| AllowShellFileDown | 是 | 否 | Bool | 是否开启 rz sz 文件下载 示例值: |
| AllowFileDel | 是 | 否 | Bool | 是否开启 SFTP 文件删除 示例值: |
| ValidateFrom | 是 | 否 | Datetime_iso | 访问权限生效时间,如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则访问权限长期有效 示例值: |
| ValidateTo | 是 | 否 | Datetime_iso | 访问权限失效时间,如:"2021-09-23T00:00:00+00:00" 生效、失效时间不填则访问权限长期有效 示例值: |
| Status | 是 | 否 | Uint64 | 访问权限状态,1 - 已生效,2 - 未生效,3 - 已过期 示例值: |
| Department | 是 | 是 | Department | 所属部门的信息 示例值:查看 |
Department
部门信息
被如下接口引用:CreateUserBatch、DescribeAcls、DescribeDepartments、DescribeDeviceGroupMembers、DescribeDeviceGroups、DescribeDevices、DescribeOperationTaskDetail、DescribeUserGroupMembers、DescribeUserGroups、DescribeUsers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | 部门ID 示例值: |
| Name | 是 | 否 | String | 部门名称,1 - 256个字符 示例值: |
| Managers | 是 | 是 | Array of String | 部门管理员账号ID 示例值: |
AssetSyncFlags
资产同步标志
被如下接口引用:DescribeAssetSyncFlag
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RoleGranted | 是 | 否 | Bool | 是否已完成角色授权 示例值: |
| AutoSync | 是 | 否 | Bool | 是否已开启自动资产同步 示例值: |
TopResult
用户、主机、高危Top排名和在线用户数的出参
被如下接口引用:ShowTop