ReportTaskHistory
审计报表任务记录
被如下接口引用:DescribeReportTaskHistory
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TemplateName | 否 | 否 | String | 模板名称 示例值: 运维安全报表模板 |
| DataStartTime | 否 | 否 | Datetime_iso | 数据开始时间 示例值: 2020-12-20T19:51:23+08:00 |
| DataEndTime | 否 | 否 | Datetime_iso | 数据结束时间 示例值: 2020-12-25T19:51:23+08:00 |
| CreateTime | 否 | 否 | Datetime_iso | 创建时间 示例值: 2020-12-26T19:51:23+08:00 |
| Id | 否 | 否 | Uint64 | 记录 id 示例值: 1 |
| TaskId | 否 | 否 | Uint64 | 关联任务 id 示例值: 1 |
| PeriodType | 否 | 否 | Uint64 | 报表类型:1 单次 2 周期 示例值: 1 |
| TemplateId | 否 | 否 | String | 模板 id 示例值: tmp-20230111 |
| Department | 否 | 否 | Department | 部门信息 示例值:查看 |
| ReportName | 否 | 否 | String | 报表名称 示例值: 运维安全报表 |
| Description | 否 | 否 | String | 报表描述 示例值: 运维安全报表 |
| User | 否 | 否 | String | 创建者 name 示例值: zhangsan |
FileInformation
搜索文件传输会话时返回的文件信息
被如下接口引用:SearchFileSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| File | 是 | 否 | String | 文件名 示例值: test.txt |
| Mode | 是 | 否 | Uint64 | 对文件的动作,1为上传,2为下载,3为删除,4为重命名 示例值: 1 |
| Time | 是 | 否 | String | 操作文件的时间 示例值: 2024-10-29T11:03:20.204367484+08:00 |
| Size | 是 | 否 | Uint64 | 文件的大小 示例值: 10 |
| Protocol | 是 | 否 | String | 操作文件时所用的协议 示例值: RDP |
SessionCommand
命令和所属会话
被如下接口引用:SearchCommandSession、SearchSessionCommand
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| StartTime | 是 | 否 | String | 开始时间 示例值: 2020-01-01T01:01:01Z |
| EndTime | 是 | 否 | String | 结束时间 示例值: 2020-01-01T01:01:01Z |
| UserName | 是 | 否 | String | 用户名 示例值: zhangsan |
| RealName | 是 | 否 | String | 账号 示例值: 张三 |
| DeviceName | 是 | 否 | String | 设备名 示例值: 运维主机 |
| PrivateIp | 是 | 否 | String | 内部Ip 示例值: 127.0.0.1 |
| PublicIp | 是 | 否 | String | 外部Ip 示例值: 127.0.0.1 |
| Commands | 是 | 否 | Array of Command | 命令列表 示例值:查看 |
| Count | 是 | 否 | Uint64 | 记录数 示例值: 10 |
| Id | 是 | 否 | String | 会话Id 示例值: 1 |
| InstanceId | 是 | 否 | String | 设备id 示例值: ins-bhtest |
| ApCode | 是 | 否 | String | 设备所属的地域 示例值: ap-city |
ModifyLogDeliveryDetail
修改日志投递详情
被如下接口引用:ModifyLogDelivery
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LogType | 是 | 否 | String | 日志类型。目前取值: CommandLog 命令日志 FileLog 文件日志 示例值: CommandLog |
| TopicName | 否 | 否 | String | Ckafka topic。 示例值: topic-5kj2h52b5 |
| Enabled | 否 | 否 | Bool | 是否启用。 示例值: true |
PushAccountTaskDetail
账号推送任务详情
被如下接口引用:DescribePushAccountTaskDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Device | 否 | 是 | Device | 资产信息 示例值:查看 |
| Status | 否 | 是 | String | 任务状态 0 未执行 1 执行中 2 成功 3 失败 4 超时 示例值: 0 |
| StatusCode | 否 | 否 | Int64 | 任务状态码 0 未执行 1 执行中 2 成功 3 失败 4 超时 示例值: 0 |
ExportAuditLogTask
审计日志导出任务记录
被如下接口引用:DescribeExportAuditLogTask
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TotalRecords | 否 | 否 | Uint64 | 任务导出的日志总记录数 示例值: 10 |
| LogKind | 否 | 否 | Uint64 | 导出任务类型 示例值: 1 |
| Status | 否 | 否 | Uint64 | 任务状态 示例值: 0 |
| CosAddr | 否 | 否 | String | cos地址 示例值: https://bhtest.cos.com/202409/file |
| CreateTime | 否 | 否 | Datetime_iso | 任务创建时间 示例值: 2024-10-20T19:51:23+08:00 |
| StartTime | 否 | 否 | Datetime_iso | 导出的日志数据开始时间 示例值: 2024-10-20T20:51:23+08:00 |
| EndTime | 否 | 否 | Datetime_iso | 导出的日志数据结束时间 示例值: 2024-10-20T21:51:23+08:00 |
| Id | 否 | 否 | Uint64 | 任务Id 示例值: 1 |
| TaskName | 否 | 否 | String | 任务名称 示例值: char_session_log_20210802010104_20220107020304.csv |
| Progress | 否 | 否 | Uint64 | 任务进度 示例值: 10 |
| RemainTime | 否 | 否 | Uint64 | 任务剩余时间(秒) 示例值: 50 |
ACRuleResponse
权限控制规则对象
被如下接口引用:DescribeAccessControlTemplateRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RuleId | 否 | 是 | String | 规则id 示例值: acrule-qw122 |
| RuleName | 否 | 是 | String | 规则名称 示例值: 审计规则 |
| Description | 否 | 是 | String | 规则描述 示例值: 规则id |
InstanceType
实例类型
被如下接口引用:DescribeAvailableInstanceTypes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 否 | 否 | String | 地域 示例值: ap-city |
| TypeId | 否 | 否 | String | 实例类型 示例值: sv_cds_dasb_saas_standard_50node |
SessionResult
搜索字符或图形会话时返回的SessionResul结构体
被如下接口引用:SearchSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UserName | 是 | 否 | String | 用户名 示例值: zhangsan |
| RealName | 是 | 否 | String | 姓名 示例值: 张三 |
| Account | 是 | 否 | String | 主机账号 示例值: admin |
| StartTime | 是 | 否 | String | 开始时间 示例值: 2006-01-02T15:04:05Z |
| EndTime | 是 | 否 | String | 结束时间 示例值: 2006-01-02T15:04:05Z |
| Size | 是 | 否 | Uint64 | 会话大小 示例值: 10 |
| InstanceId | 是 | 否 | String | 设备ID 示例值: ins-1a2b3c |
| DeviceName | 是 | 否 | String | 设备名 示例值: 运维主机 |
| PrivateIp | 是 | 否 | String | 内部Ip 示例值: 127.0.0.1 |
| PublicIp | 是 | 否 | String | 外部Ip 示例值: 127.0.0.1 |
| FromIp | 是 | 否 | String | 来源Ip 示例值: 127.0.0.1 |
| Duration | 是 | 否 | Float | 会话持续时长 示例值: 50 |
| Count | 是 | 否 | Uint64 | 该会话内命令数量 ,搜索图形会话时该字段无意义 示例值: 20 |
| DangerCount | 是 | 否 | Uint64 | 该会话内高危命令数,搜索图形时该字段无意义 示例值: 3 |
| Status | 是 | 否 | Uint64 | 会话状态,如1会话活跃 2会话结束 3强制离线 4其他错误 示例值: 2 |
| Id | 是 | 否 | String | 会话Id 示例值: 1 |
| ApCode | 是 | 否 | String | 设备所属的地域 示例值: ap-city |
| Protocol | 是 | 否 | String | 会话协议 示例值: SSH |
| AppAssetUrl | 否 | 否 | String | 应用资产url 示例值: https://www.dev.com |
| DeviceKind | 否 | 否 | String | 会话资产类型 示例值: Linux |
| Namespace | 否 | 否 | String | K8S集群命名空间 示例值: namespace1 |
| Workload | 否 | 否 | String | K8S集群工作负载 示例值: workload1 |
| AppAssetKind | 否 | 否 | Uint64 | 应用资产类型:1-web 示例值: 1 |
| ReplayType | 否 | 否 | Uint64 | 回放类型 默认0, 1-rfb 2-mp4 3-ssh 示例值: 0 |
| PodName | 否 | 否 | String | K8S集群容器名称 示例值: pod0 |
| Mode | 否 | 否 | Uint64 | 访问方式 1-直链 2-客户端 3-web 大部分情况下是2 示例值: 1 |
CmdTemplate
高危命令模板
被如下接口引用:DescribeAcls、DescribeCmdTemplates、DescribeTickets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 高危命令模板ID 示例值: 1 |
| Name | 是 | 否 | String | 高危命令模板名称 示例值: "我的命令模板" |
| CmdList | 是 | 否 | String | 命令列表,命令之间用换行符("\n")分隔 示例值: rm -rf |
| Type | 否 | 否 | Uint64 | 命令模板类型 1-内置 2-自定义 示例值: 1 |
CreateLogDeliveryDetail
创建日志投递详情
被如下接口引用:CreateLogDelivery
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LogType | 是 | 否 | String | 日志类型。目前取值: CommandLog 命令日志 FileLog 文件日志 示例值: CommandLog |
| TopicName | 是 | 否 | String | Ckafka topic。需要为已存在的topic。 示例值: topic-k6b7c8 |
| Enabled | 否 | 否 | Bool | 是否启用。默认是。 示例值: true |
PushAccountTaskInfo
账号推送任务信息
被如下接口引用:DescribePushAccountTask
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 是 | Uint64 | id 示例值: 1 |
| TaskName | 否 | 是 | String | 任务名 示例值: 任务名 |
| OperationId | 否 | 否 | String | 任务id 示例值: ops-taskname |
| RunAccount | 是 | 是 | String | 执行账号 示例值: root |
| CreateAccount | 是 | 是 | String | 需要创建的资产账号 示例值: ubuntu |
| AuthenticationMethod | 否 | 是 | Array of Uint64 | 认证方式 1 密码 2 私钥 示例值: [1] |
| AuthGenerationStrategy | 否 | 是 | Uint64 | 认证生成方式 示例值: 1 |
| HomePath | 否 | 是 | String | 资产账号home路径,默认 为空不指定 示例值: /home/account |
| GroupSet | 否 | 是 | Array of String | 资产账号所属组,默认为空不创建 示例值: ["root","user"] |
| Department | 否 | 是 | Department | 所属部门的信息 示例值:查看 |
| DeviceCount | 否 | 是 | Int64 | 资产数量 示例值: 1 |
| DeviceSet | 否 | 是 | Array of Device | 资产列表 示例值:查看 |
| ShellPath | 否 | 是 | String | shell所在路径 示例值: "" |
DeviceAccount
主机账号
被如下接口引用:DescribeDeviceAccounts
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 账号ID 示例值: 1 |
| DeviceId | 是 | 否 | Uint64 | 主机ID 示例值: 1 |
| Account | 是 | 否 | String | 账号名 示例值: admin |
| BoundPassword | 是 | 否 | Bool | true-已托管密码,false-未托管密码 示例值: true |
| BoundPrivateKey | 是 | 否 | Bool | true-已托管私钥,false-未托管私钥 示例值: true |
| BoundKubeconfig | 否 | 否 | Bool | 是否托管凭证, true-托管,false-未托管 示例值: true |
| IsK8SManageAccount | 否 | 否 | Bool | 是否为k8s资产管理账号 示例值: true |
AssetSyncFlags
资产同步标志
被如下接口引用:DescribeAssetSyncFlag
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RoleGranted | 是 | 否 | Bool | 是否已完成角色授权 示例值: true |
| AutoSync | 是 | 否 | Bool | 是否已开启自动资产同步 示例值: true |
SystemTaskTemplate
系统任务模板
被如下接口引用:DescribeTaskTemplate
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 否 | 否 | String | 模板名称 示例值: 改密计划模板 |
| TemplateType | 否 | 否 | Uint64 | 模板类型:1 账号推送 2 改密 3 审计报表 示例值: 2 |
| Script | 否 | 否 | String | 模板内容 示例值: #!/bin/bash |
| Timeout | 否 | 否 | Uint64 | 超时时间 示例值: 30 |
| Id | 否 | 否 | Uint64 | id 示例值: 1 |
| TemplateId | 否 | 否 | String | 模板 id 示例值: tmp-20230111 |
GraphResult
折线图接口出参
被如下接口引用:ShowGraph
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Sessions | 是 | 否 | Array of KeyCount | 日期和当日新开会话数量 示例值:查看 |
| Commands | 是 | 否 | Array of KeyCount | 日期和当日命令总数 示例值:查看 |
| Dangers | 是 | 否 | Array of KeyCount | 日期和高危命令总数 示例值:查看 |
| Statements | 否 | 是 | Array of KeyCount | 日期和sql总数 示例值:查看 |
| DangerStatements | 否 | 是 | Array of KeyCount | 日期和高危sql总数 示例值:查看 |
OperationTaskStatistics
运维任务统计
被如下接口引用:DescribeOperationTaskStatistics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Total | 是 | 否 | Int64 | 当前允许配置的运维任务最大数量 示例值: 10 |
| Used | 是 | 否 | Int64 | 当前已配置的运维任务数量 示例值: 3 |
| Periodic | 是 | 否 | Int64 | 当前已配置的周期性触发运维任务数量 示例值: 1 |
| Manual | 是 | 否 | Int64 | 当前已配置的手工触发运维任务数量 示例值: 2 |
| Running | 是 | 否 | Int64 | 当前正在执行中的运维任务数量 示例值: 1 |
EventAlarmRule
事件告警规则
被如下接口引用:DescribeAlarmSetting、ModifyAlarmSetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Enable | 否 | 否 | Uint64 | 告警开关。0关闭,1开启 示例值: 1 |
| AllowAllDay | 否 | 否 | Uint64 | 全天告警。0不允许,1允许 示例值: 0 |
| AllowStartHour | 否 | 否 | Uint64 | 允许开始告警小时。取值0-23 示例值: 0 |
| AllowStartMinute | 否 | 否 | Uint64 | 允许开始告警分钟。取值0-59 示例值: 0 |
| AllowEndHour | 否 | 否 | Uint64 | 允许结束告警小时。取值0-23 示例值: 23 |
| AllowEndMinute | 否 | 否 | Uint64 | 允许结束告警分钟。取值0-59 示例值: 59 |
| Id | 是 | 否 | Uint64 | 规则id 示例值: 1 |
| AlarmType | 否 | 否 | Uint64 | 告警事件类型。1-linux命令拦截,2-sql语句拦截,3-文件操作拦截 示例值: 1 |
Ticket
运维工单
被如下接口引用:DescribeTickets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| StartTime | 否 | 否 | Datetime_iso | 运维开始时间 示例值: 2021-02-04T15:23:52+08:00 |
| EndTime | 否 | 否 | Datetime_iso | 运维结束时间 示例值: 2021-02-04T15:23:52+08:00 |
| Status | 否 | 否 | Uint64 | 工单状态,0待提交(草稿),1待审批,2批准,3已执行,4驳回,5删除,6过期 示例值: 0 |
| ApproveUser | 否 | 否 | String | 审批人uin 示例值: 10000597843 |
| AclId | 否 | 否 | Uint64 | acl权限Id 示例值: 100 |
| ApplyUserName | 否 | 否 | String | 申请人用户名 示例值: operator |
| Id | 否 | 否 | Uint64 | 数据库主键 示例值: 1 |
| TicketType | 否 | 否 | Uint64 | 工单类型,0-运维访问工单,1-权限工单, 2-数据库变更工单,3-自动执行命令/脚本工单 示例值: 0 |
| ApplyRealName | 否 | 否 | String | 申请人真实姓名 示例值: operator |
| ApproveTime | 否 | 否 | Datetime_iso | 审批时间 示例值: 2021-02-04T15:23:52+08:00 |
| DepartmentName | 否 | 否 | String | 部门名称 示例值: 云平台 |
| ApplyTime | 否 | 否 | Datetime_iso | 申请时间 示例值: 2021-02-04T15:23:52+08:00 |
| ApproveUserSet | 否 | 否 | Array of String | 待审批状态下,可以审批的人 示例值: 10000597843 |
| ApproveDesc | 否 | 否 | String | 工单审批备注 示例值: 同意 |
| UpdateTime | 否 | 否 | Datetime_iso | 更新时间 示例值: 2021-02-04T15:23:52+08:00无 |
| DepartmentId | 否 | 否 | String | 部门ID 示例值: 1 |
| DepartmentSequence | 否 | 否 | Uint64 | 部门Sequence 示例值: 10 |
| TicketId | 否 | 否 | String | 工单ID,id-s3ed4r5e 示例值: id-s3ed4r5e |
| ApplyUser | 否 | 否 | Uint64 | 申请人用户Id 示例值: 101 |
| Name | 否 | 否 | String | 申请权限 示例值: 运维工单 |
| ApplyTimeVersion | 否 | 否 | Int64 | 申请时间戳,微妙 示例值: 1703769950580478 |
| Acl | 否 | 否 | Acl | acl权限 示例值:查看 |
| ApproveUserInfoSet | 否 | 否 | Array of DepartmentManagerUser | 审批人信息 示例值:查看 |
Cvm
cvm实例参数,导入主机时使用
被如下接口引用:ImportDevices
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | cvm实例id 示例值: ins-19a230a87c-92e0-1 |
| InstanceName | 是 | 否 | String | 主机名 示例值: 运维主机 |
| OsName | 是 | 否 | String | 操作系统名称 示例值: CentOS 7.6 64bit |
| PublicIpAddresses | 是 | 否 | String | 外网IP 示例值: 127.0.0.1 |
| PrivateIpAddresses | 是 | 否 | String | 内网IP 示例值: 127.0.0.1 |
| VpcId | 是 | 否 | String | vpc ID 示例值: vpc-dffmklm |
| SubnetId | 是 | 否 | String | 子网ID 示例值: subnet-dsj8y4b |
IOAUserGroup
同步过来的ioa用户分组信息
被如下接口引用:CreateUserBatch、DescribeAcls、DescribeTickets、DescribeUserGroupMembers、DescribeUsers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| OrgId | 否 | 否 | Uint64 | ioa用户组织id 示例值: 85232 |
| OrgName | 否 | 否 | String | ioa用户组织名称 示例值: 开发部 |
| OrgIdPath | 否 | 否 | String | ioa用户组织id路径 示例值: 2321.23341.2334 |
| OrgNamePath | 否 | 否 | String | ioa用户组织名称路径 示例值: 全网账户.钉钉.开发部 |
| Source | 否 | 否 | Uint64 | ioa关联用户源类型 示例值: 0 |
ParamDeviceAccount
资产账号, 用于根据IP导入账号密码或密钥
被如下接口引用:ImportDeviceAccount
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip | 否 | 否 | String | 资产ip 示例值: 10.10.10.1 |
| Account | 是 | 否 | String | 账号名称,1-64,不能包含空白字符 示例值: root |
| Password | 否 | 否 | String | 账号密码,1-64字符 示例值: testpassword |
| InstanceId | 否 | 否 | String | 实例ID 示例值: ins-xxxxxx |
| PrivateKey | 否 | 否 | String | 账号密钥 示例值: test-privatekey |
| PrivateKeyPassword | 否 | 否 | String | 账号密钥的密码 示例值: test-privatekey-pwd |
| Kubeconfig | 否 | 否 | String | 容器账号凭据 示例值: test-kubeconfig |
ExternalAppAsset
应用资产参数,添加或导入外部主机时使用
被如下接口引用:CreateAppAsset
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Kind | 是 | 否 | Uint64 | 应用资产类型。1-web应用 示例值: 1 |
| ClientAppKind | 是 | 否 | String | 客户端工具类型 示例值: chrome |
| DeviceId | 否 | 否 | Uint64 | 应用服务器ID,添加单台使用 示例值: 1 |
| DeviceInstanceId | 否 | 否 | String | 应用服务器实例ID,批量导入使用 示例值: ins-1a2b3c |
| Name | 否 | 否 | String | 应用资产名称 示例值: bh_asset |
| ClientAppPath | 是 | 否 | String | 客户端工具路径 示例值: C:\Chrome\chrome.exe |
| DeviceAccountId | 否 | 否 | Uint64 | 应用服务器账号ID,添加单台使用 示例值: 1 |
| DeviceAccount | 否 | 否 | String | 应用服务器账号名,批量导入使用 示例值: root |
| Url | 否 | 否 | String | web应用资产url 示例值: https://www.bhasset.com |
| DepartmentId | 否 | 否 | String | 部门id 示例值: 1.2.3 |
OperationTaskDetail
运维任务详情
被如下接口引用:DescribeOperationTaskDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 运维任务主键ID 示例值: 100 |
| Name | 是 | 否 | String | 运维任务名称 示例值: 运维测试任务 |
| OperationId | 是 | 否 | String | 运维任务ID 示例值: ops-bhtest |
| Type | 是 | 否 | Uint64 | 任务类型,1 - 手工执行任务, 2 - 周期性任务 示例值: 1 |
| Period | 是 | 否 | Uint64 | 周期性任务执行间隔,单位天 示例值: 7 |
| FirstTime | 是 | 否 | String | 首次执行时间 示例值: 2023-12-20T19:51:23+08:00 |
| Account | 是 | 否 | String | 执行账户 示例值: root |
| Timeout | 是 | 否 | Uint64 | 任务超时时间,单位秒 示例值: 30 |
| Script | 是 | 否 | String | 任务命令 示例值: #!/bin/bash |
| Devices | 是 | 否 | Array of Device | 执行任务的资产信息 示例值:查看 |
| NextTime | 是 | 是 | String | 下次任务执行时间 示例值: 2024-12-20T19:51:23+08:00 |
| UserName | 是 | 否 | String | 用户名 示例值: zhangsan |
| RealName | 是 | 否 | String | 姓名 示例值: 张三 |
PushAccountTaskInfoResult
账号推送任务结果信息
被如下接口引用:SearchPushAccountTaskInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | String | 运维任务结果日志ID 示例值: 1 |
| OperationId | 否 | 是 | String | 运维任务ID 示例值: ops-taskId |
| RunAccount | 否 | 是 | String | 执行账号 示例值: root |
| CreateAccount | 否 | 是 | String | 待创建账号 示例值: ubuntu |
| PasswordAuth | 否 | 是 | Int64 | 密码认证 示例值: 1 |
| PrivateKeyAuth | 否 | 是 | Int64 | 私钥认证 示例值: 1 |
| AuthGenerationStrategy | 否 | 是 | Int64 | 认证生成策略 示例值: 1 |
| HomePath | 否 | 是 | String | home路径 示例值: /home/account |
| ShellPath | 否 | 是 | String | shell路径 示例值: /home/account/test.sh |
| GroupSet | 否 | 是 | String | 用户组 示例值: user |
| UserDepartmentName | 否 | 否 | String | 用户部门名称 示例值: 开发部 |
| UserDepartmentId | 否 | 否 | String | 用户部门id 示例值: 1.2 |
LogDelivery
日志推送配置
被如下接口引用:DescribeLogDelivery
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AccessType | 是 | 否 | String | 接入方式。 Domain 域名接入 Internal 支撑环境接入 示例值: Domain |
| CkafkaInstanceId | 是 | 是 | String | ckafka实例Id。 示例值: ckafka-zaprzqxe |
| Address | 是 | 否 | String | 接入地址。 域名接入的情况下是域名和端口;支撑环境接入的情况下是虚拟地址和端口。 示例值: 9.143.169.69:6021 |
| CkafkaUniqVpcId | 是 | 是 | String | ckafka实例所属VpcId。 示例值: vpc-dffmklm |
| CkafkaUniqSubnetId | 是 | 是 | String | ckafka实例所属SubnetId。 示例值: subnet-dsj8y4b |
| CkafkaRegion | 是 | 是 | String | ckafka实例所在地域。 示例值: ap-city |
| Details | 是 | 是 | Array of LogDeliveryDetail | 日志投递详情。 示例值:查看 |
AssetSyncStatus
资产同步状态
被如下接口引用:DescribeAssetSyncStatus
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LastTime | 是 | 否 | String | 上一次同步完成的时间 示例值: 2024-10-29T13:00:18.476404626+08:00 |
| LastStatus | 是 | 否 | Uint64 | 上一次同步的结果。 0 - 从未进行, 1 - 成功, 2 - 失败 示例值: 1 |
| InProcess | 是 | 否 | Bool | 同步任务是否正在进行中 示例值: false |
| ErrMsg | 否 | 否 | String | 任务错误消息 示例值: 超出配额限制 |
IntranetAccessEntry
内网访问入口
被如下接口引用:DescribeAccessEntry
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceId | 否 | 否 | String | 堡垒机实例id 示例值: bh-saas-sefqwefsd |
| Url | 否 | 否 | String | 内网访问url 示例值: https://10.0.0.1/login/html |
| VpcId | 否 | 否 | String | 内网访问的vpcid 示例值: vpc-safweij3 |
| VpcCidrBlock | 否 | 否 | String | 内网访问的网段 示例值: 10.0.0.1/0 |
| IntranetAccessStatus | 否 | 否 | Uint64 | 0 内网未开通,1 内网已开通,2 内网访问开通中 示例值: 0 |
DeviceCount
资产数目
被如下接口引用:DescribeDeviceCountSummary
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Count | 否 | 否 | Int64 | 资产数目 示例值: 10 |
| Kind | 否 | 否 | Int64 | 资产类型 示例值: 1 |
PasswordSetting
密码要求设置。
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MinLength | 是 | 否 | Uint64 | 密码最小长度,8-20,默认8。 示例值: 10 |
| Complexity | 是 | 否 | Uint64 | 密码复杂度,0不限制,1包含字母和数字,2至少包括大写字母、小写字母、数字、特殊符号,默认2。 示例值: 0 |
| ValidTerm | 是 | 否 | Uint64 | 密码有效期,0不限制,30天,90天,180天。 示例值: 0 |
| CheckHistory | 是 | 否 | Uint64 | 检查最近n次密码设置是否存在相同密码,2-10,默认5。 示例值: 5 |
Departments
部门列表
被如下接口引用:DescribeDepartments
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DepartmentSet | 是 | 否 | Array of Department | 部门列表 示例值:查看 |
| Enabled | 是 | 否 | Bool | 是否开启了部门管理 true - 已开启, false - 未开启 示例值: true |
| RootManager | 是 | 否 | Bool | 当前操作UIN是否是根部门管理员 示例值: true |
EventResult
风险事件的出参
被如下接口引用:SearchEvent
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Sid | 是 | 否 | String | 会话Id 示例值: 100f238e-226f-4a8a-b3e1-db93610d7162 |
| UserName | 是 | 否 | String | 用户名 示例值: jack |
| ApCode | 是 | 否 | String | 地域信息 示例值: ap-city |
| InstanceId | 是 | 否 | String | 主机id 示例值: ins-61lt4n7u |
| DeviceName | 是 | 否 | String | 主机名 示例值: Ldap主节点 |
| Cmd | 是 | 否 | String | 高危命令或文件传输风险操作的文件名 示例值: cd / |
| Time | 是 | 否 | String | 高危命令执行时间 示例值: 2024-10-23T11:11:14.507458832+08:00 |
| Type | 是 | 否 | Int64 | 事件类型,如shell命令、文件传输等 示例值: 1 |
| Method | 是 | 否 | Int64 | 各Type所属子类型,如:Type为文件传输时,此字段代表文件操作类型 示例值: 1 |
Resource
堡垒机服务信息
被如下接口引用:DescribeAcls、DescribeAppAssetGroupMembers、DescribeAppAssets、DescribeChangePwdTask、DescribeChangePwdTaskDetail、DescribeDeviceGroupMembers、DescribeDevices、DescribeOperationTaskDetail、DescribePushAccountTask、DescribePushAccountTaskDetail、DescribeResourceAll、DescribeResources、DescribeTickets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceId | 否 | 否 | String | 服务实例ID,如bh-saas-s3ed4r5e 示例值: bh-saas-s3ed4r5e |
| ApCode | 否 | 否 | String | 地域编码 示例值: ap-city |
| SvArgs | 否 | 否 | String | 服务实例规格信息 示例值: sv_cds_dasb_saas_xxx |
| VpcId | 否 | 否 | String | VPC ID 示例值: vpc-adfer-ade |
| Nodes | 否 | 否 | Uint64 | 服务规格对应的资产数 示例值: 50 |
| RenewFlag | 否 | 否 | Uint64 | 自动续费标记,0 - 表示默认状态,1 - 表示自动续费,2 - 表示明确不自动续费 示例值: 1 |
| ExpireTime | 否 | 否 | Datetime_iso | 过期时间 示例值: 2021-02-04T15:23:52+08:00 |
| Status | 否 | 否 | Uint64 | 资源状态,0 - 未初始化,1 - 正常,2 - 隔离,3 - 销毁,4 - 初始化失败,5 - 初始化中 示例值: 1 |
| ResourceName | 否 | 否 | String | 服务实例名,如T-Sec-堡垒机(SaaS型) 示例值: T-Sec-堡垒机(SaaS型) |
| Pid | 否 | 否 | Uint64 | 定价模型ID 示例值: 1007488 |
| CreateTime | 否 | 否 | Datetime_iso | 资源创建时间 示例值: 2021-02-04T15:23:52+08:00 |
| ProductCode | 否 | 否 | String | 商品码, p_cds_dasb 示例值: p_cds_dasb |
| SubProductCode | 否 | 否 | String | 子商品码, sp_cds_dasb_bh_saas 示例值: sp_cds_dasb_bh_saas |
| Zone | 否 | 否 | String | 可用区 示例值: ap-city-3 |
| Expired | 否 | 否 | Bool | 是否过期,true-过期,false-未过期 示例值: true |
| Deployed | 否 | 否 | Bool | 是否开通,true-开通,false-未开通 示例值: true |
| VpcName | 否 | 否 | String | 开通服务的 VPC 名称 示例值: vpc1 |
| VpcCidrBlock | 否 | 否 | String | 开通服务的 VPC 对应的网段 示例值: 10.10.10.0/16 |
| SubnetId | 否 | 否 | String | 开通服务的子网ID 示例值: subnet-adecft-exder |
| SubnetName | 否 | 否 | String | 开通服务的子网名称 示例值: subnet1 |
| CidrBlock | 否 | 否 | String | 开通服务的子网网段 示例值: 10.10.10.0/24 |
| PublicIpSet | 否 | 否 | Array of String | 外部IP 示例值: 192.168.41.10 |
| PrivateIpSet | 否 | 否 | Array of String | 内部IP 示例值: 172.10.12.13 |
| ModuleSet | 否 | 否 | Array of String | 服务开通的高级功能列表,如:[DB] 示例值: ["DB"] |
| UsedNodes | 否 | 否 | Uint64 | 已使用的授权点数 示例值: 10 |
| TUICmdPort | 否 | 否 | Uint64 | 命令行运维端口号 示例值: 10001 |
| TUIDirectPort | 否 | 否 | Uint64 | 字符直连端口号 示例值: 10002 |
| ExtendPoints | 否 | 否 | Uint64 | 扩展点数 示例值: 50 |
| PackageBandwidth | 否 | 否 | Uint64 | 带宽扩展包个数(4M) 示例值: 1 |
| PackageNode | 否 | 否 | Uint64 | 授权点数扩展包个数(50点) 示例值: 1 |
| LogDeliveryArgs | 否 | 是 | String | 日志投递规格信息 示例值: sv_cds_dasb_saas_xxx |
| ShareClb | 否 | 否 | Bool | 是否共享clb,true-共享clb,false-独享clb 示例值: false |
| LbVipIsp | 否 | 是 | String | 运营商类型,如果为空字符串表示内网类型 示例值: CMCC/CTCC/CUCC |
| DeployModel | 否 | 否 | Uint64 | 部署模式 默认0 0-cvm 1-tke 示例值: 0 |
| OpenClbId | 否 | 否 | String | 共享clb id 示例值: lb-5fa81478 |
| UsedDomainCount | 否 | 否 | Uint64 | 已经使用的网络域个数 示例值: 1 |
| IOAResourceId | 否 | 否 | String | 堡垒机实例对应的零信任实例id 示例值: ioa-bh-1-833ae717984772235e780aa |
| IntranetPrivateIpSet | 否 | 否 | Array of String | 内网访问的ip 示例值: ["127.0.0.1"] |
| ClbSet | 否 | 否 | Array of Clb | 堡垒机资源LB 示例值:查看 |
| IntranetVpcCidr | 否 | 否 | String | 开通内网访问vpc的网段 示例值: 172.9.9.1/0 |
| ClientAccess | 否 | 否 | Uint64 | 1 默认值,客户单访问开启,0 客户端访问关闭,2 客户端访问开通中,3 客户端访问关闭中 示例值: 1 |
| PackageIOAUserCount | 否 | 否 | Uint64 | 零信任堡垒机用户扩展包个数。1个扩展包对应20个用户数 示例值: 1 |
| CdcClusterId | 否 | 否 | String | cdc集群id 示例值: cdc-dead-exdeas |
| ExternalAccess | 否 | 否 | Uint64 | 1 默认值,外网访问开启,0 外网访问关闭,2 外网访问开通中,3 外网访问关闭中 示例值: 1 |
| DomainCount | 否 | 否 | Uint64 | 网络域个数 示例值: 0 |
| WebAccess | 否 | 否 | Uint64 | 1 默认值,web访问开启,0 web访问关闭,2 web访问开通中,3 web访问关闭中 示例值: 1 |
| IOAResource | 否 | 否 | Uint64 | 0默认值。0-免费版(试用版)ioa,1-付费版ioa 示例值: 0 |
| PackageIOABandwidth | 否 | 否 | Uint64 | 零信任堡垒机带宽扩展包个数。一个扩展包表示4M带宽 示例值: 1 |
| Trial | 否 | 否 | Uint64 | 0 非试用版,1 试用版 示例值: 0 |
| LogDelivery | 否 | 否 | String | 日志投递规格信息 示例值: sc_cds_dasb_saas_xxx |
| IntranetAccess | 否 | 否 | Uint64 | 0 默认值,非内网访问,1 内网访问,2 内网访问开通中,3 内网访问关闭中 示例值: 0 |
| IntranetVpcId | 否 | 否 | String | 开通内网访问的vpc 示例值: vpc-se23s3rf |
| IntranetSubnetId | 否 | 否 | String | 开通内网访问的subnet 示例值: subnet-323s4 |
SearchFileBySidResult
文件操作搜索结果
被如下接口引用:SearchFileBySid
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Time | 是 | 否 | String | 文件操作时间 示例值: 2023-12-20T19:51:23+08:00 |
| Method | 是 | 否 | Int64 | 1-上传文件 2-下载文件 3-删除文件 4-移动文件 5-重命名文件 6-新建文件夹 7-移动文件夹 8-重命名文件夹 9-删除文件夹 示例值: 1 |
| Protocol | 是 | 否 | String | 文件传输协议 示例值: SFTP |
| FileCurr | 是 | 否 | String | method为上传、下载、删除时文件在服务器上的位置, 或重命名、移动文件前文件的位置 示例值: /home/1.txt |
| FileNew | 是 | 是 | String | method为重命名、移动文件时代表移动后的新位置.其他情况为null 示例值: /home/2.txt |
| Size | 是 | 是 | Int64 | method为上传文件、下载文件、删除文件时显示文件大小。其他情况为null 示例值: 1024 |
| Action | 是 | 否 | Int64 | 堡垒机拦截情况, 1-已执行, 2-被阻断 示例值: 1 |
| DeviceDepartmentName | 否 | 否 | String | 设备部门name 示例值: 运维部 |
| Account | 否 | 否 | String | 资产账号 示例值: root |
| UserName | 否 | 否 | String | 用户名 示例值: zhangsan |
| FromIp | 否 | 否 | String | 来源Ip 示例值: 113.10.10.10 |
| DeviceDepartmentId | 否 | 否 | String | 设备部门id 示例值: 1.2 |
| SignValue | 否 | 否 | String | 签名值 示例值: 12we1231wersa |
| InstanceId | 否 | 否 | String | 实例Id 示例值: ins-1a2b3c |
| ConfirmTime | 否 | 否 | Datetime_iso | 复核时间,当Action是3时,需有复核时间 示例值: 2023-12-20T19:51:23+08:00 |
| UserDepartmentId | 否 | 否 | String | 用户部门Id 示例值: 1.2 |
| UserDepartmentName | 否 | 否 | String | 用户部门name 示例值: 运维部 |
| Sid | 否 | 否 | String | 会话Id 示例值: de44c0e4-dcd8-4299-9063-b671cd97a |
Filter
描述键值对过滤器,用于条件过滤查询
被如下接口引用:CreateExportDeviceTask、CreateExportUserTask、DescribeAccessControlRules、DescribeAccessControlTemplates、DescribeAcls、DescribeAppAssets、DescribeChangePwdTask、DescribeChangePwdTaskDetail、DescribeDevices、DescribeDomains、DescribePushAccountTask、DescribePushAccountTaskDetail、DescribeReportTask、DescribeReportTaskHistory、DescribeResourceAll、DescribeTickets、DescribeUsers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 需要过滤的字段。 示例值: "InstanceId" |
| Values | 是 | 否 | Array of String | 字段的过滤值。 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。 示例值: ["ext-19b6c9ece7-8cb8-1"] |
OperationEvent
操作日志
被如下接口引用:DescribeOperationEvent
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UserName | 是 | 否 | String | 用户名 示例值: zhangsan |
| RealName | 是 | 否 | String | 姓名 示例值: 张三 |
| Time | 是 | 否 | Datetime_iso | 操作时间 示例值: 2020-12-20T19:51:23+08:00 |
| SourceIp | 是 | 否 | String | 来源IP 示例值: 1.0.0.1 |
| Kind | 是 | 否 | Uint64 | 操作类型 示例值: 100 |
| Operation | 是 | 否 | String | 具体操作内容 示例值: 新建主机 |
| Result | 是 | 否 | Uint64 | 操作结果,1-成功,2-失败 示例值: 1 |
| SignValue | 否 | 否 | String | 签名值 示例值: ad23daef34 |
ProductCost
产品价格对象
被如下接口引用:InquireCreateDasbResource
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TotalCost | 是 | 否 | Float | 总费用 示例值: 1200.3 |
| RealCost | 是 | 否 | Float | 优惠后总价 示例值: 1800.3 |
| Currency | 是 | 否 | String | 货币 示例值: yuan |
TrialGuide
堡垒机试用引导
被如下接口引用:DescribeTrialGuide
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | Uint64 | id 示例值: 1 |
| AppId | 否 | 否 | Uint64 | 客户appId 示例值: 1 |
| GuideStep | 否 | 否 | Uint64 | 引导步骤 示例值: 1 |
| Status | 否 | 否 | Uint64 | 引导状态,0-未开始引导,1-引导中,2-引导结束 示例值: 0 |
DatabaseStatement
数据库操作
被如下接口引用:SearchStatement、SearchStatementBySid
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Statement | 是 | 否 | String | 数据库操作 示例值: select |
| Time | 是 | 否 | String | 操作时间 示例值: 2020-01-01T01:01:01Z |
| Action | 是 | 否 | Int64 | 执行情况,1--允许,2--拒绝,3--确认 示例值: 1 |
| DBType | 否 | 是 | Int64 | 数据库类型 1-MySQL 2-PostgreSQL 3- MongoDB 示例值: 1 |
| UserName | 否 | 是 | String | 用户名 示例值: zhangsan |
| RealName | 否 | 是 | String | 用户真实姓名 示例值: 张三 |
| InstanceId | 否 | 是 | String | 资产id 示例值: Ins-bhtest |
| DeviceName | 否 | 是 | String | 资产名称 示例值: 运维机器 |
| PublicIp | 否 | 是 | String | 公网ip 示例值: 100.10.10.10 |
| PrivateIp | 否 | 是 | String | 内网ip 示例值: 192.168.0.3 |
| RuleId | 否 | 是 | String | 规则id 示例值: acrule-hxwq9lv4 |
| RuleName | 否 | 是 | String | 规则名称 示例值: 运维控制规则 |
SearchFileTypeFilter
用于搜索文件传输记录等日志时按照protocol和method进行过滤
被如下接口引用:SearchFileBySid
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Protocol | 是 | 否 | String | 需要查询的文件传输类型,如SFTP/CLIP/RDP/RZSZ 示例值: SFTP |
| Method | 否 | 否 | Array of Int64 | 在当前指定的protocol下进一步过滤具体操作类型,如剪贴板文件上传,剪贴板文件下载等 示例值: [1,2] |
Clb
负载均衡
被如下接口引用:DescribeAcls、DescribeAppAssetGroupMembers、DescribeAppAssets、DescribeChangePwdTask、DescribeChangePwdTaskDetail、DescribeDeviceGroupMembers、DescribeDevices、DescribeOperationTaskDetail、DescribePushAccountTask、DescribePushAccountTaskDetail、DescribeResourceAll、DescribeResources、DescribeTickets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClbIp | 否 | 否 | String | 负载均衡IP 示例值: 192.168.0.4 |
AppAsset
应用资产信息
被如下接口引用:DescribeAcls、DescribeAppAssetGroupMembers、DescribeAppAssets、DescribeTickets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Department | 否 | 否 | Department | 资产所属部门 示例值:查看 |
| DeviceId | 否 | 否 | Uint64 | 应用服务器id 示例值: 1 |
| BindStatus | 否 | 否 | Uint64 | 托管状态。0-未托管,1-已托管 示例值: 1 |
| DeviceInstanceId | 否 | 否 | String | 应用服务器实例id 示例值: ins-1a2b3c |
| DomainName | 否 | 否 | String | 网络域名称 示例值: default network domain |
| DeviceName | 否 | 否 | String | 应用服务器名称 示例值: 运维主机 |
| ResourceId | 否 | 否 | String | 堡垒机实例id 示例值: bh-saas-1a2v3s |
| Resource | 否 | 否 | Resource | 堡垒机实例信息 示例值:查看 |
| InstanceId | 否 | 否 | String | 实例id 示例值: ext-asset |
| Name | 否 | 否 | String | 资产名称 示例值: 运维web应用 |
| ClientAppKind | 否 | 否 | String | 客户端工具类型 示例值: chrome |
| Url | 否 | 否 | String | 应用资产url 示例值: https://www.bhasset.com |
| DeviceAccountName | 否 | 否 | String | 应用服务器账号名称 示例值: admin |
| GroupSet | 否 | 否 | Array of Group | 资产组信息 示例值:查看 |
| Id | 否 | 否 | Uint64 | 应用资产id 示例值: 1 |
| DeviceAccountId | 否 | 否 | Uint64 | 应用服务器账号id 示例值: 1 |
| Kind | 否 | 否 | Uint64 | 应用资产类型。1-web应用 示例值: 1 |
| ClientAppPath | 否 | 否 | String | 客户端工具路径 示例值: C:\Chrome\chrome.exe |
| DomainId | 否 | 否 | String | 网络域id 示例值: net-default |
ChangePwdTaskInfoResult
改密任务结果信息
被如下接口引用:SearchChangePwdTaskInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | String | 运维任务结果ID 示例值: 1 |
| OperationId | 否 | 是 | String | 运维任务ID 示例值: ops-bhtest |
| TaskName | 否 | 是 | String | 任务名称 示例值: 运维任务 |
| ChangeMethod | 否 | 是 | Uint64 | 改密方式 示例值: 0 |
| RunAccount | 否 | 是 | String | 执行账号 示例值: root |
| AuthGenerationStrategy | 否 | 是 | Int64 | 密码生成策略 示例值: 1 |
| PasswordLength | 否 | 是 | Int64 | 密码长度 示例值: 12 |
| SmallLetter | 否 | 是 | Uint64 | 包含小写字母 示例值: 1 |
| BigLetter | 否 | 是 | Uint64 | 包含大写字母 示例值: 0 |
| Digit | 否 | 是 | Uint64 | 包含数字:1包含 示例值: 1 |
| Symbol | 否 | 是 | String | 包含字符 示例值: eHl6 |
| CompleteNotify | 否 | 是 | Int64 | 改密完成通知 示例值: 1 |
| NotifyEmails | 否 | 是 | Array of String | 改密通知邮箱 示例值: ["bh@email.com","bhtest@email.com"] |
| FilePassword | 否 | 是 | String | 加密文件密码 示例值: 123456 |
| UserDepartmentId | 否 | 是 | String | 部门ID 示例值: 1.2 |
| UserDepartmentName | 否 | 是 | String | 部门名称 示例值: 运维部 |
EventAlarmSetting
事件告警设置
被如下接口引用:DescribeAlarmSetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AggregateSwitch | 否 | 否 | Uint64 | 聚合开关。0关闭,1开启 示例值: 1 |
| RealTimeCountLimit | 否 | 否 | Uint64 | 实时告警次数上限 示例值: 2 |
| EventAlarmRule | 否 | 否 | Array of EventAlarmRule | 事件告警规则 示例值:查看 |
LoginSetting
登录安全设置
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TimeOut | 是 | 否 | Uint64 | 登录会话超时,10分钟,20分钟,30分钟,默认20分钟 示例值: 20 |
| LockThreshold | 是 | 否 | Uint64 | 连续密码错误次数,超过锁定账号,3-5 示例值: 3 |
| LockTime | 是 | 否 | Uint64 | 账号锁定时长,10分钟,20分钟,30分钟 示例值: 10 |
| InactiveUserLock | 否 | 否 | Uint64 | 用户多少天不活跃,账号自动锁定 示例值: 180 |
LicenseItemList
license使用量组
被如下接口引用:DescribeLicenseUsage
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RuleKey | 否 | 否 | String | 计费项id 示例值: sv_bunker_sli_1n_lic |
| Usage | 否 | 否 | Uint64 | 用量 示例值: 120 |
UKeyUser
USB key绑定用户参数
被如下接口引用:CreateUKeyBatch
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| KeyId | 是 | 否 | String | UKEY ID 示例值: 92b82594-d500-46c8-8f36-22d0122b5f3a |
| KeyName | 是 | 否 | String | UKEY名称 示例值: key1 |
| KeyContainerName | 是 | 否 | String | UKEY容器名 示例值: containername1 |
| KeyCertificate | 是 | 否 | String | UKEY证书 示例值: MTIzNA== |
| UserName | 是 | 否 | String | 待绑定用户的用户名 示例值: TestUser |
AuditLogResult
审计日志
被如下接口引用:SearchAuditLog
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Sid | 是 | 否 | String | 被审计会话的Sid 示例值: 6d751c7c-c428-4216-b50e-63449737ed22 |
| Uin | 是 | 否 | String | 审计者的编号 示例值: 1000*****486 |
| Time | 是 | 否 | String | 审计动作发生的时间 示例值: 2024-10-29T04:04:16+08:00 |
| ClientIp | 是 | 否 | String | 审计者的Ip 示例值: 192.168.0.1 |
| Operation | 是 | 否 | Int64 | 审计动作类型,1--回放、2--中断、3--监控 示例值: 1 |
| InstanceId | 是 | 否 | String | 被审计主机的Id 示例值: ins-o8438w5e |
| DeviceName | 是 | 否 | String | 被审计主机的主机名 示例值: push_account_os |
| Protocol | 是 | 否 | String | 被审计会话所属的类型,如字符会话 示例值: SSH |
| PrivateIp | 是 | 否 | String | 被审计主机的内部Ip 示例值: 10.10.1.1 |
| PublicIp | 是 | 否 | String | 被审计主机的外部Ip 示例值: 100.100.100.100 |
| SubAccountUin | 是 | 否 | String | 审计者的子账号 示例值: 1000*****845 |
| AppAssetUrl | 否 | 否 | String | 被审计资产url 示例值: https://www.baidu.com |
Map
map类型改造,用于返回key、value型数据
被如下接口引用:DescribeOperationType
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 对应map的key 示例值: test-name |
| Value | 是 | 否 | String | 对应map的value 示例值: test-value |
SystemTaskStatistics
系统任务统计信息
被如下接口引用:DescribeSystemTaskStatistics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PushAccountTask | 否 | 是 | SystemTaskStatistic | 账号推送任务统计信息 示例值:查看 |
CkafkaInstance
ckafka实例信息
被如下接口引用:DescribeCkafkaInstanceList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 否 | 是 | String | 地域 示例值: ap-city |
| CkafkaInstanceId | 否 | 是 | String | ckafka实例Id 示例值: ckafka-zaprzqxe |
| CkafkaInstanceName | 否 | 是 | String | ckafka实例名 示例值: 堡垒机ckafka消息队列test |
| VpcId | 否 | 是 | String | vpc Id 示例值: vpc-dffmklm |
| SubnetId | 否 | 是 | String | subnet Id 示例值: subnet-dsj8y4b |
LDAPSetting
LDAP配置信息
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Enable | 是 | 否 | Bool | 是否开启LDAP认证,false-不开启,true-开启 示例值: true |
| Ip | 是 | 否 | String | 服务器地址 示例值: 10.10.10.1 |
| IpBackup | 是 | 否 | String | 备用服务器地址 示例值: 10.10.10.2 |
| Port | 是 | 否 | Uint64 | 服务端口 示例值: 389 |
| EnableSSL | 是 | 否 | Bool | 是否开启SSL,false-不开启,true-开启 示例值: true |
| BaseDN | 是 | 否 | String | Base DN 示例值: true |
| AdminAccount | 是 | 否 | String | 管理员账号 示例值: test-account |
| AttributeUser | 是 | 否 | String | 用户属性 示例值: test-attr |
| AttributeUserName | 是 | 否 | String | 用户名属性 示例值: test-username |
| AutoSync | 是 | 否 | Bool | 自动同步,false-不开启,true-开启 示例值: true |
| Overwrite | 是 | 否 | Bool | 覆盖用户信息,false-不开启,true-开启 示例值: true |
| SyncPeriod | 是 | 否 | Uint64 | 同步周期,30~60000之间的整数 示例值: true |
| SyncAll | 是 | 否 | Bool | 是否同步全部,false-不开启,true-开启 示例值: true |
| SyncUnitSet | 是 | 否 | Array of String | 同步OU列表 示例值: ["xx", "oo"] |
| AttributeUnit | 是 | 否 | String | 组织单元属性 示例值: unit |
| AttributeRealName | 是 | 否 | String | 用户姓名属性 示例值: realname |
| AttributePhone | 是 | 否 | String | 手机号属性 示例值: phone |
| AttributeEmail | 是 | 否 | String | 邮箱属性 示例值: email |
| ResourceId | 否 | 是 | String | 请求LDAP服务的堡垒机实例 示例值: bh-saas-xxxxx |
| DomainId | 否 | 是 | String | 网络域Id 示例值: net-xxxxxxxx |
Department
部门信息
被如下接口引用:CreateUserBatch、DescribeAcls、DescribeAppAssetGroupMembers、DescribeAppAssets、DescribeChangePwdTask、DescribeChangePwdTaskDetail、DescribeDepartments、DescribeDeviceGroupMembers、DescribeDeviceGroups、DescribeDevices、DescribeExportDeviceTask、DescribeExportUserTask、DescribeOperationTaskDetail、DescribePushAccountTask、DescribePushAccountTaskDetail、DescribeReportTask、DescribeReportTaskHistory、DescribeTickets、DescribeUKeys、DescribeUserGroupMembers、DescribeUserGroups、DescribeUsers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | String | 部门ID 示例值: "1.2.3" |
| Name | 否 | 否 | String | 部门名称,1 - 256个字符 示例值: "研发部" |
| Managers | 否 | 是 | Array of String | 部门管理员账号ID 示例值: ["1000*****385"] |
| ManagerUsers | 否 | 是 | Array of DepartmentManagerUser | 管理员用户 示例值:查看 |
| IOAId | 否 | 否 | Uint64 | ioa分组id 示例值: 34 |
ACTemplate
权限控制模板对象
被如下接口引用:DescribeAcls、DescribeTickets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TemplateId | 否 | 是 | String | 模板id 示例值: temp-B5J6dasT5P |
| TemplateName | 否 | 是 | String | 模板名称 示例值: 0105ceshi规则 |
| Description | 否 | 是 | String | 模板描述 示例值: 测试权限模块 |
ReplayInformation
回放所需字段信息
被如下接口引用:KillSession、MonitorSession、ReplaySession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Token | 是 | 否 | String | 令牌 示例值: bh-replay-token |
| StartTime | 是 | 否 | String | 会话开始时间 示例值: 2020-01-01T01:01:01Z |
| Address | 是 | 否 | String | 回放链接 示例值: ws://localhost:8080/bh/replay |
| ReplayType | 否 | 否 | Uint64 | 回放类型 ,默认0, 1-rfb 2-mp4 3-ssh 示例值: 0 |
LogOutputSettings
日志外发配置
被如下接口引用:DescribeLogOutputSettings
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Enabled | 是 | 否 | Bool | 是否已开启日志外发 示例值: true |
| ProductLogin | 是 | 否 | Bool | 是否已开启产品登录日志发送 示例值: true |
| DeviceLogin | 是 | 否 | Bool | 是否已开启资产登录日志发送 示例值: true |
ExternalDevice
主机参数,导入外部主机时使用
被如下接口引用:ImportExternalDevice
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 否 | 否 | String | 主机名,可为空 示例值: Instance-name |
| OsName | 是 | 否 | String | 操作系统名称,只能是Linux、Windows或MySQL 示例值: Linux |
| Ip | 是 | 否 | String | IP地址 示例值: 192.168.0.1 |
| Port | 是 | 否 | Uint64 | 管理端口 示例值: 22 |
| DepartmentId | 否 | 否 | String | 资产所属的部门ID 示例值: 1.2.3 |
| IpPortSet | 否 | 否 | Array of String | 资产多节点:字段ip和端口 示例值: [127.0.0.1:2001,127.0.0.1:2002] |
| SSLCert | 否 | 否 | String | SSL证书,EnableSSL时必填 示例值: true |
| EnableSSL | 否 | 否 | Int64 | 是否启用SSL,1:启用 0:禁用,仅支持Redis资产 示例值: 1 |
| SSLCertName | 否 | 否 | String | SSL证书名称,EnableSSL时必填 示例值: bh-redis-test.crt |
SearchFileResult
文件传输检索结果
被如下接口引用:SearchFile
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Time | 是 | 否 | String | 文件传输的时间 示例值: 2022-01-01T01:01:01Z |
| UserName | 是 | 否 | String | 用户名 示例值: zhangsan |
| RealName | 是 | 否 | String | 姓名 示例值: 张三 |
| InstanceId | 是 | 否 | String | 资产ID 示例值: ins-bhtest |
| DeviceName | 是 | 否 | String | 资产名称 示例值: 运维机器 |
| PublicIp | 是 | 否 | String | 资产公网IP 示例值: 100.100.100.100 |
| PrivateIp | 是 | 否 | String | 资产内网IP 示例值: 192.168.1.100 |
| Action | 是 | 否 | Uint64 | 操作结果:1 - 已执行,2 - 已阻断 示例值: 1 |
| Method | 是 | 否 | Uint64 | 操作类型:1 - 文件上传,2 - 文件下载,3 - 文件删除,4 - 文件(夹)移动,5 - 文件(夹)重命名,6 - 新建文件夹,9 - 删除文件夹 示例值: 1 |
| FileCurr | 是 | 否 | String | 下载的文件(夹)路径及名称 示例值: /home/abc.txt |
| FileNew | 是 | 否 | String | 上传或新建文件(夹)路径及名称 示例值: /home/abc.txt |
| Sid | 否 | 否 | String | 会话id 示例值: bh-test-sid-1a2b3c |
| ConfirmTime | 否 | 否 | Datetime_iso | 复核时间 示例值: 2022-01-01T01:01:01Z |
| UserDepartmentId | 否 | 否 | String | 用户部门id 示例值: 1.2 |
| DeviceDepartmentId | 否 | 否 | String | 设备部门id 示例值: 1.2 |
| FromIp | 否 | 否 | String | 来源id 示例值: 1.1.1.1 |
| DeviceDepartmentName | 否 | 否 | String | 设备部门name 示例值: 运维部 |
| SignValue | 否 | 否 | String | 签名值 示例值: fadc2368ed |
| Account | 否 | 否 | String | 账号 示例值: root |
| Protocol | 否 | 否 | String | 协议 示例值: SSH |
| Size | 否 | 否 | Uint64 | 文件大小 示例值: 1024 |
| UserDepartmentName | 否 | 否 | String | 用户部门name 示例值: 运维部 |
TopResult
用户、主机、高危Top排名和在线用户数的出参
被如下接口引用:ShowTop
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| OnlineUser | 是 | 否 | Int64 | 在线用户数 示例值: 1 |
| DangerUsers | 是 | 否 | Array of KeyCount | 高危用户和高危操作次数 示例值:查看 |
| ActiveUsers | 是 | 否 | Array of KeyCount | 活跃用户和活跃次数 示例值:查看 |
| ActiveDevices | 是 | 否 | Array of ActiveDevice | 活跃主机和活跃次数及主机信息 示例值:查看 |
ProductList
license采集接口返回对象
被如下接口引用:DescribeLicenseUsage
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ProductCode | 否 | 否 | String | 产品代码 示例值: bhsaas |
| LicenseItemList | 否 | 否 | Array of LicenseItemList | license对象组列表 示例值:查看 |
AccountWithDeviceCount
账号名及拥有该同名账号的主机数量
被如下接口引用:DescribeAccountsWithDeviceCount
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Account | 是 | 否 | String | 账号名 示例值: admin |
| DeviceCount | 是 | 否 | Uint64 | 拥有该同名账号的主机数量 示例值: 10 |
ExportDeviceTask
资产导出任务信息
被如下接口引用:DescribeExportDeviceTask、DescribeExportUserTask
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TaskName | 否 | 否 | String | 任务名称 示例值: export-host-woc178772403 |
| Status | 否 | 否 | Uint64 | 任务状态:0 未开始,1 进行中,2 已完成,3 已失败 示例值: 1 |
| RemainTime | 否 | 否 | Uint64 | 任务剩余时间(秒) 示例值: 10 |
| CosAddr | 否 | 否 | String | 文件cos地址 示例值: http:ap-city.cos |
| CreateTime | 否 | 否 | Datetime_iso | 任务创建时间 示例值: 2024-10-12T17:13:24+08:00 |
| Department | 否 | 否 | Department | 部门信息 示例值:查看 |
| Id | 否 | 否 | Uint64 | 任务 Id 示例值: 10 |
| Progress | 否 | 否 | Uint64 | 任务进度 示例值: 100 |
| FilePassword | 否 | 否 | String | 解压文件密码 示例值: qwewsdd |
ExportAppAssetFilter
导出应用资产筛选条件
被如下接口引用:CreateExportDeviceTask
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagFilters | 否 | 否 | Array of TagFilter | 过滤条件,可按照标签键、标签进行过滤。如果同时指定标签键和标签过滤条件,它们之间为“AND”的关系 示例值:查看 |
| Limit | 否 | 否 | Int64 | 每页条目数量,默认20 示例值: 10 |
| IdSet | 否 | 否 | Array of Uint64 | 应用资产ID 示例值: [1,2] |
| Name | 否 | 否 | String | 应用资产名称 示例值: 运维web应用 |
| AuthorizedUserIdSet | 否 | 否 | Array of Uint64 | 有该主机访问权限的用户ID集合 示例值: [1,2] |
| Offset | 否 | 否 | Uint64 | 分页偏移位置,默认值为0 示例值: 0 |
| KindSet | 否 | 否 | Array of Uint64 | 应用资产类型 示例值: [1,2] |
| DepartmentId | 否 | 否 | String | 所属部门ID 示例值: 1.2.3 |
| Filters | 否 | 否 | Array of Filter | 过滤数组。支持的条件:BindingStatus、InstanceId、Url、DeviceName、DeviceInstanceId、ResourceId、DomainId 示例值:查看 |
RunChangePwdTaskDetail
立即执行改密任务的入参
被如下接口引用:RunChangePwdTask
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DeviceId | 是 | 否 | Uint64 | 资产id 示例值: ext-19b6c9ece7-8cb8-1 |
| Account | 是 | 否 | String | 资产账号 示例值: root |
SystemTaskStatistic
系统任务统计
被如下接口引用:DescribeSystemTaskStatistics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Total | 否 | 是 | Int64 | 任务数量 示例值: 1 |
| Used | 否 | 是 | Int64 | 已使用任务数量 示例值: 1 |
| Running | 否 | 是 | Int64 | 运行中的任务数量 示例值: 1 |
| LastWeekRunningTask | 否 | 是 | Int64 | 最近一周执行任务数量 示例值: 1 |
| LastMonthRunningTask | 否 | 是 | Int64 | 最近一个月执行任务数量 示例值: 1 |
ActiveDevice
活跃主机的主机信息
被如下接口引用:ShowTop
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | 主机ID 示例值: ins-61lt4n7u |
| DeviceName | 是 | 否 | String | 主机名 示例值: 运维主机 |
| ApCode | 是 | 否 | String | 地域信息 示例值: ap-city |
| Count | 是 | 否 | Int64 | 活跃主机的活跃次数 示例值: 1 |
TaskResultDetail
运维父任务执行结果详情
被如下接口引用:SearchTaskResultDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | 运维任务结果日志ID 示例值: 1 |
| OperationId | 是 | 否 | String | 运维任务ID 示例值: ops-x2julw6p75997988 |
| Name | 是 | 否 | String | 运维任务名称 示例值: 测试任务 |
| Type | 是 | 否 | Uint64 | 任务类型 1 - 手工任务, 2 - 周期性任务 示例值: 1 |
| Period | 是 | 否 | Int64 | 运维任务周期(单位:天) 示例值: 7 |
| StartTime | 是 | 否 | String | 运维任务开始时间 示例值: 2022-04-13T19:44:57+08:00 |
| EndTime | 是 | 否 | String | 运维任务结束时间 示例值: 2022-04-13T19:44:57+08:00 |
| UserName | 是 | 否 | String | 运维任务创建人员用户名 示例值: okzhang |
| RealName | 是 | 否 | String | 运维任务创建人员姓名 示例值: okzhang |
| Account | 是 | 否 | String | 运维任务执行账户 示例值: root |
| Timeout | 是 | 否 | Uint64 | 运维任务超时时间, 单位秒 示例值: 30 |
| Script | 是 | 否 | String | 运维任务命令 示例值: #!/bin/bash |
| FromIp | 是 | 否 | String | 运维任务来源IP 示例值: 10.10.1.1 |
SessionFile
搜索文件及所属会话的结果集
被如下接口引用:SearchFileSession
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | 会话Id 示例值: 281779b0-e078-4987-9943-910510afdb15 |
| UserName | 是 | 否 | String | 用户名 示例值: tom |
| RealName | 是 | 否 | String | 姓名 示例值: jack |
| Account | 是 | 否 | String | 主机账号 示例值: root |
| InstanceId | 是 | 否 | String | 设备ID 示例值: ins-61lt4n7u |
| DeviceName | 是 | 否 | String | 主机名 示例值: push_account_ubuntu |
| PrivateIp | 是 | 否 | String | 主机内网Ip 示例值: 127.0.0.1 |
| PublicIp | 是 | 否 | String | 主机外网Ip 示例值: 127.0.0.1 |
| FromIp | 是 | 否 | String | 来源Ip 示例值: 127.0.0.1 |
| Files | 是 | 否 | Array of FileInformation | 属于该会话的文件集合 示例值:查看 |
User
用户信息
被如下接口引用:CreateUserBatch、DescribeAcls、DescribeTickets、DescribeUserGroupMembers、DescribeUsers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | Uint64 | 用户ID 示例值: 1 |
| UserName | 是 | 否 | String | 用户名, 3-20个字符 必须以英文字母开头,且不能包含字母、数字、.、_、-以外的字符 示例值: jack |
| RealName | 是 | 否 | String | 用户姓名, 最大20个字符,不能包含空白字符 示例值: 张三 |
| Phone | 否 | 否 | String | 手机号码, 大陆手机号直接填写,如果是其他国家、地区号码,按照"国家地区代码 |
| 否 | 否 | String | 电子邮件 示例值: 177***1234@163.com |
|
| ValidateFrom | 否 | 否 | Datetime_iso | 用户生效时间,如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则用户长期有效 示例值: 2021-01-01T08:00:01+08:00 |
| ValidateTo | 否 | 否 | Datetime_iso | 用户失效时间,如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则用户长期有效 示例值: 2021-01-01T08:00:01+08:00 |
| GroupSet | 否 | 否 | Array of Group | 所属用户组列表 示例值:查看 |
| AuthType | 否 | 否 | Uint64 | 认证方式,0 - 本地,1 - LDAP,2 - OAuth 示例值: 0 |
| ValidateTime | 否 | 否 | String | 访问时间段限制, 由0、1组成的字符串,长度168(7 × 24),代表该用户在一周中允许访问的时间段。字符串中第N个字符代表在一周中的第N个小时, 0 - 代表不允许访问,1 - 代表允许访问 示例值: 0000000000000000000000000000000000000000000000000000000000000000 |
| Department | 否 | 是 | Department | 用户所属部门(用于出参) 示例值:查看 |
| DepartmentId | 否 | 是 | String | 用户所属部门(用于入参) 示例值: 1.2.3 |
| ActiveStatus | 否 | 是 | Uint64 | 激活状态 0 - 未激活 1 - 激活 示例值: 1 |
| LockStatus | 否 | 是 | Uint64 | 锁定状态 0 - 未锁定 1 - 锁定 示例值: 1 |
| Status | 否 | 是 | String | 状态 与Filter中一致 示例值: 0 |
| IOAUserGroup | 否 | 否 | IOAUserGroup | ioa同步过来的用户相关信息 示例值:查看 |
| AclVersion | 否 | 否 | Uint64 | 权限版本 示例值: 1 |
| UserFrom | 否 | 否 | Uint64 | 用户来源,0-bh,1-ioa 示例值: 0 |
| UKeyStatus | 否 | 否 | Int64 | ukey绑定状态 0 - 未绑定 1 - 已绑定 示例值: 1 |
Device
资产信息
被如下接口引用:DescribeAcls、DescribeChangePwdTask、DescribeChangePwdTaskDetail、DescribeDeviceGroupMembers、DescribeDevices、DescribeOperationTaskDetail、DescribePushAccountTask、DescribePushAccountTaskDetail、DescribeTickets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | Uint64 | 资产ID 示例值: 1 |
| InstanceId | 否 | 否 | String | 实例ID,对应CVM、CDB等实例ID 示例值: ins-c6nx |
| Name | 否 | 否 | String | 资产名 示例值: 运维专用机器 |
| PublicIp | 否 | 否 | String | 公网IP 示例值: 1.1.1.1 |
| PrivateIp | 否 | 否 | String | 内网IP 示例值: 1.1.1.1 |
| ApCode | 否 | 否 | String | 地域编码 示例值: ap-city |
| OsName | 否 | 否 | String | 操作系统名称 示例值: Centos 7 |
| Kind | 否 | 否 | Uint64 | 资产类型 1 - Linux, 2 - Windows, 3 - MySQL, 4 - SQLServer 示例值: 1 |
| Port | 否 | 否 | Uint64 | 管理端口 示例值: 22 |
| GroupSet | 否 | 否 | Array of Group | 所属资产组列表 示例值:查看 |
| AccountCount | 否 | 否 | Uint64 | 资产绑定的账号数 示例值: 10 |
| VpcId | 否 | 否 | String | VPC ID 示例值: vpc-bhtest |
| SubnetId | 否 | 否 | String | 子网ID 示例值: subnet-bhtest |
| Resource | 否 | 是 | Resource | 堡垒机服务信息,注意没有绑定服务时为null 示例值:查看 |
| Department | 否 | 是 | Department | 资产所属部门 示例值:查看 |
| IpPortSet | 否 | 是 | Array of String | 数据库资产的多节点 示例值: [127.0.0.1:2001,127.0.0.1:2002] |
| DomainId | 否 | 否 | String | 网络域Id 示例值: net-bhtest |
| SSLCertName | 否 | 否 | String | 已上传的SSL证书名称 示例值: bh-redis-test.crt |
| IOAId | 否 | 否 | Int64 | IOA侧的资源ID 示例值: 10034 |
| Workload | 否 | 否 | String | K8S集群工作负载 示例值: workload |
| SyncPodCount | 否 | 否 | Uint64 | K8S集群pod已同步数量 示例值: 10 |
| TotalPodCount | 否 | 否 | Uint64 | K8S集群pod总数量 示例值: 20 |
| DomainName | 否 | 否 | String | 网络域名称 示例值: 默认网络域 |
| EnableSSL | 否 | 否 | Int64 | 是否启用SSL,仅支持Redis资产。0:禁用 1:启用 示例值: 1 |
| ManageDimension | 否 | 否 | Uint64 | K8S集群托管维度。1-集群,2-命名空间,3-工作负载 示例值: 1 |
| ManageAccountId | 否 | 否 | Uint64 | K8S集群托管账号id 示例值: 100 |
| Namespace | 否 | 否 | String | K8S集群命名空间 示例值: namespace |
UKeyUserDetail
UKEY绑定的用户信息
被如下接口引用:DescribeUKeys
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| KeyId | 否 | 否 | String | UKEY ID 示例值: 92b82594-d500-46c8-8f36-22d0122b5f3a |
| KeyName | 否 | 否 | String | UKEY名称 示例值: key1 |
| UserName | 否 | 否 | String | 已绑定用户的用户名 示例值: TestUser |
| UserRealName | 否 | 否 | String | 已绑定用户的姓名 示例值: TestRealName |
| Department | 否 | 否 | Department | 已绑定用户的部门信息,仅返回DepartmentName 示例值:查看 |
LogDeliveryDetail
日志投递详情
被如下接口引用:DescribeLogDelivery
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LogType | 是 | 否 | String | 日志类型。目前取值: CommandLog 命令日志 FileLog 文件日志 示例值: CommandLog |
| TopicName | 是 | 是 | String | Ckafka name。 示例值: topic-5kj2h52b5 |
| Enabled | 是 | 是 | Bool | 是否启用 示例值: true |
| Status | 是 | 是 | String | 投递状态 示例值: Normal |
AccessWhiteListRule
访问白名单规则
被如下接口引用:DescribeAccessWhiteListRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 规则ID 示例值: 10 |
| Source | 是 | 否 | String | IP或者网段 示例值: 10.10.10.1 |
| Remark | 是 | 否 | String | 备注信息 示例值: 规则1 |
| ModifyTime | 是 | 否 | Datetime_iso | 修改时间 示例值: 2020-12-20T19:51:23+08:00 |
ReportTask
报表任务信息
被如下接口引用:DescribeReportTask
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TemplateId | 否 | 否 | String | 报表模板 id 示例值: tmp-20230111 |
| DataTimeRange | 否 | 否 | Uint64 | 数据时间范围,单位 小时(周期报表) 示例值: 10 |
| Status | 否 | 否 | Uint64 | 任务状态: 0 待生成 1 已生成 2已暂停 3已失败 4 生成中 示例值: 0 |
| Id | 否 | 否 | Uint64 | 报表任务 id 示例值: 1 |
| Period | 否 | 否 | String | 周期 cron 表达式 示例值: 12 |
| User | 否 | 否 | String | 创建者名称 示例值: zhangsan |
| CreateTime | 否 | 否 | Datetime_iso | 创建时间 示例值: 2020-12-19T19:51:23+08:00 |
| LastReportTime | 否 | 否 | Datetime_iso | 上次报告触发时间 示例值: 2020-12-18T19:51:23+08:00 |
| ReportType | 否 | 否 | Uint64 | 报表任务类型:1 单次报表 2 周期报表 示例值: 1 |
| TemplateName | 否 | 否 | String | 报表名称 示例值: 运维安全报表 |
| Enable | 否 | 否 | Uint64 | 开关:0 关闭 1 打开 示例值: 1 |
| Department | 否 | 否 | Department | 部门信息 示例值:查看 |
| DataStartTime | 否 | 否 | Datetime_iso | 数据开始时间(单次报表) 示例值: 2020-12-20T19:51:23+08:00 |
| ReportCount | 否 | 否 | Uint64 | 已生成报表数量 示例值: 1 |
| DataEndTime | 否 | 否 | Datetime_iso | 数据结束时间(单次报表) 示例值: 2020-12-21T19:51:23+08:00 |
| NextReportTime | 否 | 否 | Datetime_iso | 下次触发时间(周期报表) 示例值: 2020-12-22T19:51:23+08:00 |
| ReportName | 否 | 否 | String | 报表任务名称 示例值: 1月份报表 |
| Description | 否 | 否 | String | 报表说明 示例值: 报表说明 |
AccessInfo
认证信息
被如下接口引用:AccessDevice
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip | 否 | 是 | String | 地址 示例值: 127.0.0.1 |
| Port | 否 | 是 | Uint64 | 端口 示例值: 80 |
| User | 否 | 是 | String | 账号 示例值: v_feifei |
| Password | 否 | 是 | String | 密码 示例值: 980930 |
| AccessURL | 否 | 否 | String | 唤起链接|wss链接 示例值: tsecbh://CgcxLjIuMS4xEgNtcmQaDzEyMy4yMDcuMTA2LjIxNyDFQSoNMTkyLjE2OC4xMS4xMzIr546w572R546v5aKD5YaF572R6K6_6Zeu6ZW_5pyf5L2_55SoLeWLv-WIoDoNYWRtaW5pc3RyYXRvckIQcmYwU1pIQ0ozcmlFQ1lVb0gBUIAIWIAGeAA |
ChangePwdTaskDetail
查询改密计划详情
被如下接口引用:DescribeChangePwdTaskDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Device | 否 | 是 | Device | 资产信息 示例值:查看 |
| Account | 否 | 是 | String | 资产账号 示例值: root |
| LastChangeStatus | 否 | 是 | Uint64 | 上次改密结果。0-未改密 1-改密成功 2-改密失败 示例值: 0 |
Group
组信息,用于用户组、主机组
被如下接口引用:CreateUserBatch、DescribeAcls、DescribeAppAssetGroupMembers、DescribeAppAssets、DescribeChangePwdTask、DescribeChangePwdTaskDetail、DescribeDeviceGroupMembers、DescribeDeviceGroups、DescribeDevices、DescribeOperationTaskDetail、DescribePushAccountTask、DescribePushAccountTaskDetail、DescribeTickets、DescribeUserGroupMembers、DescribeUserGroups、DescribeUsers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 组ID 示例值: 1 |
| Name | 是 | 否 | String | 组名称 示例值: 运维组 |
| Department | 是 | 是 | Department | 所属部门信息 示例值:查看 |
| Count | 是 | 是 | Uint64 | 个数 示例值: 10 |
SubtaskResult
运维子任务执行结果
被如下接口引用:SearchSubtaskResultById
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | String | 执行日志ID 示例值: ops-x2julw6p75997988 |
| InstanceId | 否 | 否 | String | 执行主机实例ID 示例值: ins-61lt4n7u |
| Name | 否 | 否 | String | 执行主机名称 示例值: 测试任务 |
| ApCode | 否 | 否 | String | 执行主机地域 示例值: ap-city |
| PublicIp | 否 | 否 | String | 执行主机外网IP 示例值: 127.0.0.1 |
| PrivateIp | 否 | 否 | String | 执行主机内网IP 示例值: 127.0.0.1 |
| Status | 否 | 否 | Uint64 | 运维任务状态 1 - 执行中,2 - 成功, 3 - 失败,4 - 超时 示例值: 1 |
| Reason | 否 | 否 | String | 运维任务失败原因 示例值: 脚本异常退出码 |
| ExitCode | 否 | 否 | Int64 | 运维任务命令退出码 示例值: 0 |
| StartTime | 否 | 否 | String | 运维任务开始时间 示例值: 2022-04-13T19:44:57+08:00 |
| EndTime | 否 | 否 | String | 运维任务结束时间 示例值: 2022-04-13T19:44:57+08:00 |
| StdOut | 否 | 否 | String | 运维任务执行结果输出 示例值: stdout data |
| StdErr | 否 | 否 | String | 运维任务执行结果错误 示例值: stderr data |
| DeviceName | 否 | 是 | String | 资产名 示例值: push_account_ubuntupush_account_ubuntu |
| Account | 否 | 是 | String | 资产账号 示例值: root |
AuthModeSetting
认证方式设置
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AuthMode | 是 | 否 | Uint64 | 双因子认证,0-不开启,1-OTP,2-短信 示例值: 1 |
OAuthSetting
OAuth认证配置
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Scopes | 否 | 否 | Array of String | 使用Okta认证时指定范围。 示例值: ["openid","email"] |
| Enable | 否 | 否 | Bool | 是否开启OAuth认证 示例值: false |
| AuthMethod | 否 | 否 | String | OAuth认证方式。 示例值: OAuth |
| ClientId | 否 | 否 | String | OAuth认证客户端Id。 示例值: 0oai8ntest |
| CodeUrl | 否 | 否 | String | 获取OAuth认证授权码URL。 示例值: https://bh/v1/authorize |
| TokenUrl | 否 | 否 | String | 获取OAuth令牌URL。 示例值: https://bh/v1/token |
| UserInfoUrl | 否 | 否 | String | 获取OAuth用户信息URL。 示例值: https://bh/v1/userinfo |
ACTemplateResponse
访问控制模版返回对象
被如下接口引用:DescribeAccessControlTemplates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TemplateId | 否 | 是 | String | 模版id 示例值: temp-bhtest |
| TemplateName | 否 | 是 | String | 模版名称 示例值: 运维权限模板 |
| Description | 否 | 是 | String | 模版描述 示例值: 这是运维权限模板 |
| AclCount | 否 | 是 | Uint64 | 模版关联的acl数量 示例值: 10 |
| RuleCount | 否 | 是 | Uint64 | 模版关联的rule数量 示例值: 11 |
SearchCommandResult
命令执行检索结果
被如下接口引用:SearchCommand
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Time | 否 | 否 | String | 命令输入的时间 示例值: 2022-01-01T01:01:01Z |
| UserName | 否 | 否 | String | 用户名 示例值: user1 |
| RealName | 否 | 否 | String | 姓名 示例值: 张三 |
| InstanceId | 否 | 否 | String | 资产ID 示例值: ins-xxxxxxx |
| DeviceName | 否 | 否 | String | 资产名称 示例值: 开发机 |
| PublicIp | 否 | 否 | String | 资产公网IP 示例值: 100.100.100.100 |
| PrivateIp | 否 | 否 | String | 资产内网IP 示例值: 192.168.1.100 |
| Cmd | 否 | 否 | String | 命令 示例值: pwd |
| Action | 否 | 否 | Uint64 | 命令执行情况,1--允许,2--拒绝 示例值: 1 |
| Sid | 否 | 否 | String | 命令所属的会话ID 示例值: bh-test-sid-1a2b3c |
| TimeOffset | 否 | 否 | Uint64 | 命令执行时间相对于所属会话开始时间的偏移量,单位ms 示例值: 1 |
| Account | 否 | 是 | String | 账号 示例值: root |
| FromIp | 否 | 是 | String | source ip 示例值: 1.1.1.1 |
| SessionTime | 否 | 是 | String | 该命令所属会话的会话开始时间 示例值: 2023-04-24T18:47:18.118138659+08:00 |
| SessTime | 否 | 是 | String | 该命令所属会话的会话开始时间(废弃,使用SessionTime) 示例值: 2023-04-24T18:47:18.118138659+08:00 |
| ConfirmTime | 否 | 是 | String | 复核时间 示例值: 2023-04-24T18:47:18.118138659+08:00 |
| UserDepartmentId | 否 | 是 | String | 部门id 示例值: 1.3 |
| UserDepartmentName | 否 | 是 | String | 用户部门名称 示例值: 用户部门名称 |
| DeviceDepartmentId | 否 | 是 | String | 设备部门id 示例值: 1 |
| DeviceDepartmentName | 否 | 是 | String | 设备部门名称 示例值: 资产部门名称 |
| Size | 否 | 否 | Uint64 | 会话大小 示例值: 1024 |
| DeviceKind | 否 | 否 | String | 资产类型 示例值: TKE |
| SignValue | 否 | 否 | String | 签名值 示例值: adef2345defdadaefdc1 |
Domain
网络域
被如下接口引用:DescribeDomains
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | Uint64 | 自增id 示例值: 1 |
| DomainId | 否 | 否 | String | 网络域id 示例值: net-bhtest |
| ResourceId | 否 | 否 | String | 堡垒机id 示例值: bh-saas-r1dck9 |
| WhiteIpSet | 否 | 否 | Array of String | ip,网段 示例值: ip 192.168.0.1 网段 192.168.0.0/24 |
| Enabled | 否 | 否 | Uint64 | 是否启用 默认 1启用 0禁用 示例值: 0 |
| CreateTime | 否 | 否 | Datetime_iso | 网络域创建时间 示例值: 2021-02-04T15:23:52+08:00 |
| DomainName | 否 | 否 | String | 网络域名称 示例值: 云平台网络 |
| Status | 否 | 否 | Uint64 | 状态 0-已断开 1-已连接 示例值: 0 |
| Default | 否 | 否 | Uint64 | 是否资源默认网络域 1-资源默认网络域 0-用户添加网络域 示例值: 0 |
OperationTask
运维任务信息
被如下接口引用:DescribeOperationTasks
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Uint64 | 运维任务主键ID 示例值: 1 |
| OperationId | 是 | 否 | String | 运维任务ID 示例值: ops-zc8n78qv77368032 |
| Name | 是 | 否 | String | 运维任务名称 示例值: test1012-勿删 |
| UserName | 是 | 否 | String | 创建用户 示例值: bh_jingsan |
| RealName | 是 | 否 | String | 运维人员姓名 示例值: 张三 |
| Type | 是 | 否 | Uint64 | 任务类型,1 - 手工执行任务, 2 - 周期性任务 示例值: 1 |
| Period | 是 | 否 | Uint64 | 周期性任务执行间隔,单位天 示例值: 7 |
| NextTime | 否 | 是 | String | 执行账户 示例值: root |
| FirstTime | 是 | 否 | String | 下一次执行时间 示例值: 2022-03-17T20:30:32.79977276+08:00 |
ReconnectionSetting
运维资产重连次数
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ReconnectionMaxCount | 否 | 否 | Uint64 | 重连次数 示例值: 0 |
| Enable | 否 | 否 | Bool | true:可以重连,false:不可以重连 示例值: true |
KeyboardLogger
键盘记录出参信息
被如下接口引用:SearchKeyboardLogger
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 否 | 否 | String | 实例ID 示例值: Ins-bhtest |
| UserDepartmentName | 否 | 否 | String | 用户部门名称 示例值: 质量部 |
| DeviceDepartmentName | 否 | 否 | String | 设备部门名称 示例值: 运维部 |
| UserName | 否 | 否 | String | 用户名 示例值: zhangsan |
| FromIp | 否 | 否 | String | 客户端IP 示例值: 1.1.1.1 |
| Timestamp | 否 | 否 | String | 写ES时间 示例值: 2024-08-21 11:45:03 |
| Account | 否 | 否 | String | 账号 示例值: zhangtest |
| ResourceId | 否 | 否 | String | 资产ID 示例值: bh-saas-bhtest |
| UserDepartmentId | 否 | 否 | String | 用户部门ID 示例值: 1 |
| Sid | 否 | 否 | String | 会话ID 示例值: a1b2-c3d4-e5f6-j7h8 |
| KeyTime | 否 | 否 | String | 按键事件时间,按分钟级粒度 示例值: 2024-08-21 11:45:03 |
| Keys | 否 | 否 | String | 按键信息 示例值: abc1234 |
| StartTime | 否 | 否 | String | 会话时间 示例值: 2024-08-21 11:45:03 |
| DeviceDepartmentId | 否 | 否 | String | 设备部门ID 示例值: 1 |
Acl
访问权限
被如下接口引用:DescribeAcls、DescribeTickets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 否 | Uint64 | 访问权限ID 示例值: 1 |
| Name | 否 | 否 | String | 访问权限名称 示例值: testacl |
| AllowDiskRedirect | 否 | 否 | Bool | 是否开启磁盘映射 示例值: true |
| AllowClipFileUp | 否 | 否 | Bool | 是否开启剪贴板文件上行 示例值: true |
| AllowClipFileDown | 否 | 否 | Bool | 是否开启剪贴板文件下行 示例值: true |
| AllowClipTextUp | 否 | 否 | Bool | 是否开启剪贴板文本(目前含图片)上行 示例值: true |
| AllowClipTextDown | 否 | 否 | Bool | 是否开启剪贴板文本(目前含图片)下行 示例值: true |
| AllowFileUp | 否 | 否 | Bool | 是否开启文件传输上传 示例值: true |
| MaxFileUpSize | 否 | 否 | Uint64 | 文件传输上传大小限制(预留参数,暂未启用) 示例值: 0 |
| AllowFileDown | 否 | 否 | Bool | 是否开启文件传输下载 示例值: true |
| MaxFileDownSize | 否 | 否 | Uint64 | 文件传输下载大小限制(预留参数,暂未启用) 示例值: 0 |
| AllowAnyAccount | 否 | 否 | Bool | 是否允许任意账号登录 示例值: true |
| UserSet | 否 | 否 | Array of User | 关联的用户列表 示例值:查看 |
| UserGroupSet | 否 | 否 | Array of Group | 关联的用户组列表 示例值:查看 |
| DeviceSet | 否 | 否 | Array of Device | 关联的资产列表 示例值:查看 |
| DeviceGroupSet | 否 | 否 | Array of Group | 关联的资产组列表 示例值:查看 |
| AccountSet | 否 | 否 | Array of String | 关联的账号列表 示例值: ["root","ubuntu"] |
| CmdTemplateSet | 否 | 否 | Array of CmdTemplate | 关联的高危命令模板列表 示例值:查看 |
| AllowDiskFileUp | 否 | 否 | Bool | 是否开启 RDP 磁盘映射文件上传 示例值: true |
| AllowDiskFileDown | 否 | 否 | Bool | 是否开启 RDP 磁盘映射文件下载 示例值: true |
| AllowShellFileUp | 否 | 否 | Bool | 是否开启 rz sz 文件上传 示例值: true |
| AllowShellFileDown | 否 | 否 | Bool | 是否开启 rz sz 文件下载 示例值: true |
| AllowFileDel | 否 | 否 | Bool | 是否开启 SFTP 文件删除 示例值: true |
| ValidateFrom | 否 | 否 | Datetime_iso | 访问权限生效时间,如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则访问权限长期有效 示例值: 2021-02-04T15:23:52+08:00 |
| ValidateTo | 否 | 否 | Datetime_iso | 访问权限失效时间,如:"2021-09-23T00:00:00+00:00" 生效、失效时间不填则访问权限长期有效 示例值: 2021-02-04T15:23:52+08:00 |
| Status | 否 | 否 | Uint64 | 访问权限状态,1 - 已生效,2 - 未生效,3 - 已过期 示例值: 1 |
| Department | 否 | 是 | Department | 所属部门的信息 示例值:查看 |
| AllowAccessCredential | 否 | 是 | Bool | 是否允许使用访问串,默认允许 示例值: true |
| ACTemplateSet | 否 | 是 | Array of ACTemplate | 关联的数据库高危命令列表 示例值:查看 |
| WhiteCmds | 否 | 否 | Array of String | 关联的白命令命令 示例值: ["rm","rm -f"] |
| AllowKeyboardLogger | 否 | 否 | Bool | 是否允许记录键盘 示例值: false |
| AppAssetSet | 否 | 否 | Array of AppAsset | 关联的应用资产列表 示例值:查看 |
DepartmentManagerUser
部门管理员信息
被如下接口引用:CreateDepartment、CreateUserBatch、DescribeAcls、DescribeAppAssetGroupMembers、DescribeAppAssets、DescribeChangePwdTask、DescribeChangePwdTaskDetail、DescribeDepartments、DescribeDeviceGroupMembers、DescribeDeviceGroups、DescribeDevices、DescribeExportDeviceTask、DescribeExportUserTask、DescribeOperationTaskDetail、DescribePushAccountTask、DescribePushAccountTaskDetail、DescribeReportTask、DescribeReportTaskHistory、DescribeTickets、DescribeUKeys、DescribeUserGroupMembers、DescribeUserGroups、DescribeUsers、ModifyDepartment
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ManagerId | 否 | 是 | String | 管理员Id 示例值: 1000*****385 |
| ManagerName | 否 | 是 | String | 管理员姓名 示例值: carl |
SecuritySetting
系统安全设置
被如下接口引用:DescribeSecuritySetting
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AuthMode | 是 | 否 | AuthModeSetting | 认证方式设置 示例值:查看 |
| Password | 是 | 否 | PasswordSetting | 密码安全设置 示例值:查看 |
| Login | 是 | 否 | LoginSetting | 登录安全设置 示例值:查看 |
| LDAP | 是 | 否 | LDAPSetting | LDAP配置信息 示例值:查看 |
| OAuth | 否 | 否 | OAuthSetting | OAuth配置信息 示例值:查看 |
| AuthModeGM | 否 | 否 | AuthModeSetting | 国密认证方式设置 示例值:查看 |
| Reconnection | 否 | 否 | ReconnectionSetting | 资产重连次数 示例值:查看 |
AccessControlRuleDetail
访问控制策略列表
被如下接口引用:DescribeAccessControlRule、DescribeAccessControlRules
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RuleId | 是 | 否 | String | RuleID 策略ID 示例值: acrule-hxwq9lv4 |
| RuleName | 是 | 否 | String | 策略名称,1~60字符,仅支持中文、英文字母、数字、'_'、'-',并且开头和结尾需为中文、英文字母或者数字,RuleName不可重复 示例值: 运维控制策略 |
| RuleType | 否 | 是 | Int64 | 0: 内置 1: 自定义 示例值: 1 |
| Description | 否 | 是 | String | 策略描述,0~100字符 示例值: 这是运维控制策略 |
| ClientIPList | 否 | 是 | Array of String | 客户端IP,最多10组 示例值: ["1.1.1.1"] |
| DBName | 否 | 是 | Array of String | 数据库名称,最多10组 示例值: ["bhtest_db"] |
| TableName | 否 | 是 | Array of String | 表名称,最多10组 示例值: ["bhtest_table"] |
| SQLCommand | 否 | 是 | Array of String | SQL命令,最多10组 示例值: ["select","update"] |
| SelectRowsCount | 否 | 是 | Uint64 | 限制SELECT结果集行数大于等于此数。默认为0,不限制。 示例值: 0 |
| FieldName | 否 | 是 | Array of String | 字段名,最多50组 示例值: ["id","name"] |
| ExecutePeriod | 否 | 是 | Uint64 | 0: 不限 1:每天 2:指定时间段 示例值: 0 |
| ExecuteBeginDate | 否 | 是 | String | 开始日期,格式::YYYY-MM-DD 示例值: 2023-12-01 |
| ExecuteBeginTime | 否 | 是 | String | 开始时间,24小时制,格式: HH:mm:ss 示例值: 10:00:00 |
| ExecuteEndDate | 否 | 是 | String | 结束日期,格式::YYYY-MM-DD 示例值: 2023-12-02 |
| ExecuteEndTime | 否 | 是 | String | 结束时间,24小时制,格式: HH:mm:ss 示例值: 12:00:00 |
| ExecuteMode | 否 | 是 | Uint64 | 0:阻断 1:放行 示例值: 1 |
| FieldLogicGate | 否 | 是 | Uint64 | 字段名和字段敏感数据分类的逻辑条件。0: or; 1:and 示例值: 1 |
| TemplateCount | 否 | 是 | Int64 | 关联模板数量 示例值: 10 |
Command
命令集合
被如下接口引用:SearchCommandBySid、SearchCommandSession、SearchSessionCommand
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cmd | 否 | 否 | String | 命令 示例值: pwd |
| Time | 否 | 否 | String | 命令输入的时间 示例值: 2020-01-01T01:01:01Z |
| TimeOffset | 否 | 否 | Uint64 | 命令执行时间相对于所属会话开始时间的偏移量,单位ms 示例值: 1 |
| Action | 否 | 否 | Int64 | 命令执行情况,1--允许,2--拒绝,3--确认 示例值: 1 |
| Sid | 否 | 是 | String | 会话id 示例值: bh-test-sid-1a2b3c |
| UserName | 否 | 是 | String | 用户名 示例值: zhangsan |
| Account | 否 | 是 | String | 设备account 示例值: 张三 |
| InstanceId | 否 | 是 | String | 设备ip 示例值: ins-onwx8e9y |
| FromIp | 否 | 是 | String | source ip 示例值: 1.1.124.125 |
| SessionTime | 否 | 是 | String | 该命令所属会话的会话开始时间 示例值: 2020-01-01T01:01:01Z |
| SessTime | 否 | 是 | String | 该命令所属会话的会话开始时间 示例值: 2020-01-01T01:01:01Z |
| ConfirmTime | 否 | 是 | String | 复核时间 示例值: 2020-01-01T01:01:01Z |
| UserDepartmentId | 否 | 是 | String | 用户部门id 示例值: 1.3 |
| UserDepartmentName | 否 | 是 | String | 用户部门name 示例值: 部门名称 |
| DeviceDepartmentId | 否 | 是 | String | 设备部门id 示例值: 1 |
| DeviceDepartmentName | 否 | 是 | String | 设备部门name 示例值: 部门名称 |
| Size | 否 | 否 | Uint64 | 会话大小 示例值: 10 |
| SignValue | 否 | 否 | String | 签名值 示例值: adef2345defdadaefdc1 |
| DeviceKind | 否 | 否 | String | 资产类型 示例值: TKE |
ShareClbIp
共享clb
被如下接口引用:DescribeShareClbIps
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClbId | 否 | 否 | String | clb的实例id 示例值: lb-sefewqer |
| Region | 否 | 否 | String | clb的地域 示例值: ap-city |
| VpcId | 否 | 否 | String | clb所属vpc 示例值: vpc-wasleiaf |
| Ip | 否 | 否 | String | clb的公网ip 示例值: 10.30.2.1 |
| ListenedPortCount | 否 | 否 | Uint64 | 监听的端口数 示例值: 5 |
KeyCount
分组和组员个数
被如下接口引用:ShowGraph、ShowTop
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | 用户名或日期 示例值: 2024-10-23 |
| Count | 是 | 否 | Int64 | 数量 示例值: 1 |
TagFilter
资产标签
被如下接口引用:CreateExportDeviceTask、DescribeAppAssetGroupMembers、DescribeAppAssets、DescribeDeviceGroupMembers、DescribeDevices
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 否 | String | 标签键 示例值: "业务部门" |
| TagValue | 否 | 否 | Array of String | 标签值 示例值: ["研发部", "运营部"] |
ChangePwdTaskInfo
修改密码任务信息
被如下接口引用:DescribeChangePwdTask
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 否 | 是 | Uint64 | id 示例值: 1 |
| OperationId | 否 | 否 | String | 任务id 示例值: ops-test1 |
| TaskName | 否 | 是 | String | 任务名 示例值: 运维改密任务 |
| Department | 否 | 是 | Department | 所属部门信息 示例值:查看 |
| ChangeMethod | 否 | 是 | Uint64 | 改密方式。1:使用执行账号。2:修改自身密码 示例值: 1 |
| RunAccount | 否 | 是 | String | 执行账号 示例值: root |
| AuthGenerationStrategy | 否 | 是 | Uint64 | 密码生成策略 示例值: 1 |
| PasswordLength | 否 | 是 | Uint64 | 密码长度 示例值: 12 |
| SmallLetter | 否 | 是 | Uint64 | 包含小写字母 示例值: 1 |
| BigLetter | 否 | 是 | Uint64 | 包含大写字母 示例值: 1 |
| Digit | 否 | 是 | Uint64 | 包含数字 示例值: 1 |
| Symbol | 否 | 是 | String | 包含的特殊字符,base64 示例值: bh-test-symbol |
| CompleteNotify | 否 | 是 | Uint64 | 改密完成通知。0-通知,1-不通知 示例值: 1 |
| NotifyEmails | 否 | 是 | Array of String | 通知人邮箱 示例值: ["113***1@email.com","bh@email.com"] |
| FilePassword | 否 | 是 | String | 加密附件密码 示例值: jkl789 |
| AccountSet | 否 | 是 | Array of String | 需要改密的账户 示例值: ["ubuntu","account"] |
| DeviceSet | 否 | 是 | Array of Device | 需要改密的主机 示例值:查看 |
| Type | 否 | 是 | Uint64 | 任务类型:4手动,5自动 示例值: 4 |
| Period | 否 | 是 | Uint64 | 周期 示例值: 7 |
| FirstTime | 否 | 是 | Datetime_iso | 首次执行时间 示例值: 2020-12-20T19:51:23+08:00 |
| NextTime | 否 | 是 | Datetime_iso | 下次执行时间 示例值: 2020-12-27T19:51:23+08:00 |
| LastTime | 否 | 否 | Datetime_iso | 上次执行时间 示例值: 2020-12-27T19:51:23+08:00 |
TaskResult
运维父任务执行结果
被如下接口引用:SearchTaskResult
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | String | 运维任务结果日志ID 示例值: dfac9070-8b23-499e-83b2-a50e3ca0 |
| OperationId | 是 | 否 | String | 运维任务ID 示例值: ops-1a2b3c |
| Name | 是 | 否 | String | 运维任务名称 示例值: 运维任务 |
| FromIp | 是 | 否 | String | 执行任务来源IP 示例值: 127.0.0.1 |
| UserName | 是 | 否 | String | 运维任务所属用户 示例值: zhangsan |
| RealName | 是 | 否 | String | 运维任务所属用户的姓名 示例值: 张三 |
| Status | 是 | 否 | Uint64 | 运维任务执行状态 1 - 执行中,2 - 成功,3 - 失败,4 - 部分失败 示例值: 1 |
| StartTime | 是 | 否 | String | 运维任务开始时间 示例值: 2022-04-13T19:44:57+08:00 |
| EndTime | 是 | 否 | String | 运维任务结束时间 示例值: 2022-04-13T19:45:57+08:00 |
LoginEvent
登录日志
被如下接口引用:DescribeLoginEvent
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UserName | 是 | 否 | String | 用户名 示例值: zhangsan |
| RealName | 是 | 否 | String | 姓名 示例值: 张三 |
| Time | 是 | 否 | Datetime_iso | 操作时间 示例值: 2020-12-31T17:34:17+0800 |
| SourceIp | 是 | 否 | String | 来源IP 示例值: 1.0.0.1 |
| Entry | 是 | 否 | Uint64 | 登录入口:1-字符界面,2-图形界面,3-web页面, 4-API 示例值: 1 |
| Result | 是 | 否 | Uint64 | 操作结果,1-成功,2-失败 示例值: 1 |