堡垒机

文档中心堡垒机 API 文档数据结构

数据结构

最近更新时间：2024-01-24 01:26:30

我的收藏

本页目录：

ACTemplate

权限控制模板对象

被如下接口引用：DescribeAcls。

名称	类型	必选	描述
TemplateId	String	否	模板id 注意：此字段可能返回 null，表示取不到有效值。示例值：temp-xxxx
TemplateName	String	否	模板名称注意：此字段可能返回 null，表示取不到有效值。示例值：模板A
Description	String	否	模板描述注意：此字段可能返回 null，表示取不到有效值。示例值：这是一个描述信息

Acl

访问权限

被如下接口引用：DescribeAcls。

名称	类型	描述
Id	Integer	访问权限ID 示例值：1
Name	String	访问权限名称
AllowDiskRedirect	Boolean	是否开启磁盘映射示例值：true
AllowClipFileUp	Boolean	是否开启剪贴板文件上行示例值：true
AllowClipFileDown	Boolean	是否开启剪贴板文件下行示例值：true
AllowClipTextUp	Boolean	是否开启剪贴板文本（目前含图片）上行示例值：true
AllowClipTextDown	Boolean	是否开启剪贴板文本（目前含图片）下行示例值：true
AllowFileUp	Boolean	是否开启文件传输上传示例值：true
MaxFileUpSize	Integer	文件传输上传大小限制（预留参数，暂未启用）示例值：0
AllowFileDown	Boolean	是否开启文件传输下载示例值：true
MaxFileDownSize	Integer	文件传输下载大小限制（预留参数，暂未启用）示例值：0
AllowAnyAccount	Boolean	是否允许任意账号登录示例值：true
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	Boolean	是否开启 RDP 磁盘映射文件上传示例值：true
AllowDiskFileDown	Boolean	是否开启 RDP 磁盘映射文件下载示例值：true
AllowShellFileUp	Boolean	是否开启 rz sz 文件上传示例值：true
AllowShellFileDown	Boolean	是否开启 rz sz 文件下载示例值：true
AllowFileDel	Boolean	是否开启 SFTP 文件删除示例值：true
ValidateFrom	Timestamp ISO8601	访问权限生效时间，如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则访问权限长期有效示例值：2021-02-04T15:23:52+08:00
ValidateTo	Timestamp ISO8601	访问权限失效时间，如:"2021-09-23T00:00:00+00:00" 生效、失效时间不填则访问权限长期有效示例值：2021-02-04T15:23:52+08:00
Status	Integer	访问权限状态，1 - 已生效，2 - 未生效，3 - 已过期示例值：1
Department	Department	所属部门的信息注意：此字段可能返回 null，表示取不到有效值。
AllowAccessCredential	Boolean	是否允许使用访问串，默认允许注意：此字段可能返回 null，表示取不到有效值。示例值：true
ACTemplateSet	Array of ACTemplate	关联的数据库高危命令列表注意：此字段可能返回 null，表示取不到有效值。
WhiteCmds	Array of String	关联的白命令命令注意：此字段可能返回 null，表示取不到有效值。

AssetSyncStatus

资产同步状态

被如下接口引用：DescribeAssetSyncStatus。

名称	类型	描述
LastTime	String	上一次同步完成的时间示例值：xxx
LastStatus	Integer	上一次同步的结果。 0 - 从未进行, 1 - 成功， 2 - 失败示例值：1
InProcess	Boolean	同步任务是否正在进行中示例值：false

AuditLogResult

审计日志

被如下接口引用：SearchAuditLog。

名称	类型	描述
Sid	String	被审计会话的Sid 示例值：xxx
Uin	String	审计者的编号示例值：xxx
Time	String	审计动作发生的时间示例值：xxx
ClientIp	String	审计者的Ip 示例值：xxx
Operation	Integer	审计动作类型，1--回放、2--中断、3--监控示例值：1
InstanceId	String	被审计主机的Id 示例值：xxx
DeviceName	String	被审计主机的主机名示例值：xxx
Protocol	String	被审计会话所属的类型，如字符会话示例值：xxx
PrivateIp	String	被审计主机的内部Ip 示例值：xxx
PublicIp	String	被审计主机的外部Ip 示例值：xxx
SubAccountUin	String	审计者的子账号示例值：xxx

CmdTemplate

高危命令模板

被如下接口引用：DescribeAcls, DescribeCmdTemplates。

名称	类型	描述
Id	Integer	高危命令模板ID 示例值：1
Name	String	高危命令模板名称示例值："我的命令模板"
CmdList	String	命令列表，命令之间用换行符（"\n"）分隔示例值：rm -rf

Command

命令集合

被如下接口引用：SearchCommandBySid, SearchSessionCommand。

名称	类型	描述
Cmd	String	命令示例值：pwd
Time	String	命令输入的时间示例值：2020-01-01T01:01:01Z
TimeOffset	Integer	命令执行时间相对于所属会话开始时间的偏移量，单位ms 示例值：1
Action	Integer	命令执行情况，1--允许，2--拒绝，3--确认示例值：1
Sid	String	会话id 注意：此字段可能返回 null，表示取不到有效值。示例值：sadn1j2121
UserName	String	用户名注意：此字段可能返回 null，表示取不到有效值。示例值：test
Account	String	设备account 注意：此字段可能返回 null，表示取不到有效值。示例值：test
InstanceId	String	设备ip 注意：此字段可能返回 null，表示取不到有效值。示例值：ins-onwx8e9y
FromIp	String	source ip 注意：此字段可能返回 null，表示取不到有效值。示例值：1.1.124.125
SessionTime	String	该命令所属会话的会话开始时间注意：此字段可能返回 null，表示取不到有效值。示例值：2020-01-01T01:01:01Z
ConfirmTime	String	复核时间注意：此字段可能返回 null，表示取不到有效值。示例值：2020-01-01T01:01:01Z
UserDepartmentId	String	用户部门id 注意：此字段可能返回 null，表示取不到有效值。示例值：1.3
UserDepartmentName	String	用户部门name 注意：此字段可能返回 null，表示取不到有效值。示例值：部门名称
DeviceDepartmentId	String	设备部门id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
DeviceDepartmentName	String	设备部门name 注意：此字段可能返回 null，表示取不到有效值。示例值：部门名称
Size	Integer	会话大小注意：此字段可能返回 null，表示取不到有效值。示例值：10

Department

部门信息

被如下接口引用：DescribeAcls, DescribeDeviceGroupMembers, DescribeDeviceGroups, DescribeDevices, DescribeUserGroupMembers, DescribeUserGroups, DescribeUsers。

名称	类型	描述
Id	String	部门ID 示例值："1.2.3"
Name	String	部门名称，1 - 256个字符示例值："研发部"
Managers	Array of String	部门管理员账号ID 注意：此字段可能返回 null，表示取不到有效值。示例值：[]
ManagerUsers	Array of DepartmentManagerUser	管理员用户注意：此字段可能返回 null，表示取不到有效值。

DepartmentManagerUser

部门管理员信息

被如下接口引用：DescribeAcls, DescribeDeviceGroupMembers, DescribeDeviceGroups, DescribeDevices, DescribeUserGroupMembers, DescribeUserGroups, DescribeUsers。

名称	类型	必选	描述
ManagerId	String	否	管理员Id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
ManagerName	String	否	管理员姓名注意：此字段可能返回 null，表示取不到有效值。示例值：user

Device

资产信息

被如下接口引用：DescribeAcls, DescribeDeviceGroupMembers, DescribeDevices。

名称	类型	描述
Id	Integer	资产ID 示例值：1
InstanceId	String	实例ID，对应CVM、CDB等实例ID 示例值：xxx
Name	String	资产名示例值：xxx
PublicIp	String	公网IP 示例值：1.1.1.1
PrivateIp	String	内网IP 示例值：1.1.1.1
ApCode	String	地域编码示例值：ap-guangzhou
OsName	String	操作系统名称示例值：Centos 7
Kind	Integer	资产类型 1 - Linux, 2 - Windows, 3 - MySQL, 4 - SQLServer 示例值：1
Port	Integer	管理端口示例值：22
GroupSet	Array of Group	所属资产组列表示例值：[]
AccountCount	Integer	资产绑定的账号数示例值：10
VpcId	String	VPC ID 示例值：vpc-xxxxxx
SubnetId	String	子网ID 示例值：subnet-a2676p0e
Resource	Resource	堡垒机服务信息，注意没有绑定服务时为null 注意：此字段可能返回 null，表示取不到有效值。
Department	Department	资产所属部门注意：此字段可能返回 null，表示取不到有效值。
IpPortSet	Array of String	数据库资产的多节点注意：此字段可能返回 null，表示取不到有效值。示例值：127.0.0.1:2001

DeviceAccount

主机账号

被如下接口引用：DescribeDeviceAccounts。

名称	类型	描述
Id	Integer	账号ID 示例值：1
DeviceId	Integer	主机ID 示例值：1
Account	String	账号名示例值：admin
BoundPassword	Boolean	true-已托管密码，false-未托管密码示例值：true
BoundPrivateKey	Boolean	true-已托管私钥，false-未托管私钥示例值：true

ExternalDevice

主机参数，导入外部主机时使用

被如下接口引用：ImportExternalDevice。

名称	类型	必选	描述
OsName	String	是	操作系统名称，只能是Linux、Windows或MySQL 示例值：Linux
Ip	String	是	IP地址示例值：1.1.1.1
Port	Integer	是	管理端口示例值：22
Name	String	否	主机名，可为空
DepartmentId	String	否	资产所属的部门ID 示例值：1.2.3
IpPortSet	Array of String	否	资产多节点：字段ip和端口示例值：127.0.0.1:2001

Filter

描述键值对过滤器，用于条件过滤查询

被如下接口引用：DescribeDevices, DescribeUsers。

名称	类型	必选	描述
Name	String	是	需要过滤的字段。
Values	Array of String	是	字段的过滤值。若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

Group

组信息，用于用户组、主机组

被如下接口引用：DescribeAcls, DescribeDeviceGroupMembers, DescribeDeviceGroups, DescribeDevices, DescribeUserGroupMembers, DescribeUserGroups, DescribeUsers。

名称	类型	描述
Id	Integer	组ID 示例值：1
Name	String	组名称
Department	Department	所属部门信息注意：此字段可能返回 null，表示取不到有效值。
Count	Integer	个数注意：此字段可能返回 null，表示取不到有效值。示例值：1

LoginEvent

登录日志

被如下接口引用：DescribeLoginEvent。

名称	类型	描述
UserName	String	用户名
RealName	String	姓名
Time	Timestamp ISO8601	操作时间示例值：2020-12-31T17:34:17+0800
SourceIp	String	来源IP 示例值：1.0.0.1
Entry	Integer	登录入口：1-字符界面,2-图形界面，3-web页面, 4-API 示例值：1
Result	Integer	操作结果，1-成功，2-失败示例值：1

OperationEvent

操作日志

被如下接口引用：DescribeOperationEvent。

名称	类型	描述
UserName	String	用户名
RealName	String	姓名
Time	Timestamp ISO8601	操作时间示例值：2020-12-31T17:34:17+0800
SourceIp	String	来源IP 示例值：1.0.0.1
Kind	Integer	操作类型示例值：100
Operation	String	具体操作内容示例值：新建主机
Result	Integer	操作结果，1-成功，2-失败示例值：1

Resource

堡垒机服务信息

被如下接口引用：DescribeDeviceGroupMembers, DescribeDevices, DescribeResources。

名称	类型	描述
ResourceId	String	服务实例ID，如bh-saas-s3ed4r5e 示例值：bh-saas-s3ed4r5e
ApCode	String	地域编码示例值：ap-guangzhou
SvArgs	String	服务实例规格信息示例值：sv_cds_dasb_saas_xxx
VpcId	String	VPC ID 示例值：vpc-xxxxxx
Nodes	Integer	服务规格对应的资产数示例值：50
RenewFlag	Integer	自动续费标记，0 - 表示默认状态，1 - 表示自动续费，2 - 表示明确不自动续费示例值：1
ExpireTime	Timestamp ISO8601	过期时间示例值：2021-02-04T15:23:52+08:00
Status	Integer	资源状态，0 - 未初始化，1 - 正常，2 - 隔离，3 - 销毁，4 - 初始化失败，5 - 初始化中示例值：1
ResourceName	String	服务实例名，如T-Sec-堡垒机（SaaS型）示例值：T-Sec-堡垒机（SaaS型）
Pid	Integer	定价模型ID 示例值：1007488
CreateTime	Timestamp ISO8601	资源创建时间示例值：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-guangzhou-3
Expired	Boolean	是否过期，true-过期，false-未过期示例值：true
Deployed	Boolean	是否开通，true-开通，false-未开通示例值：true
VpcName	String	开通服务的 VPC 名称示例值：vpc1
VpcCidrBlock	String	开通服务的 VPC 对应的网段示例值：10.10.10.0/16
SubnetId	String	开通服务的子网ID 示例值：subnet-xxxxxx
SubnetName	String	开通服务的子网名称示例值：subnet1
CidrBlock	String	开通服务的子网网段示例值：10.10.10.0/24
PublicIpSet	Array of String	外部IP
PrivateIpSet	Array of String	内部IP
ModuleSet	Array of String	服务开通的高级功能列表，如:[DB]
UsedNodes	Integer	已使用的授权点数示例值：10
ExtendPoints	Integer	扩展点数示例值：50
PackageBandwidth	Integer	带宽扩展包个数(4M) 示例值：1
PackageNode	Integer	授权点数扩展包个数(50点) 示例值：1
LogDeliveryArgs	String	日志投递规格信息注意：此字段可能返回 null，表示取不到有效值。示例值：sv_cds_dasb_saas_xxx

SearchCommandResult

命令执行检索结果

被如下接口引用：SearchCommand。

名称	类型	描述
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	Integer	命令执行情况，1--允许，2--拒绝示例值：1
Sid	String	命令所属的会话ID 示例值：xxxx
TimeOffset	Integer	命令执行时间相对于所属会话开始时间的偏移量，单位ms 示例值：1
Account	String	账号注意：此字段可能返回 null，表示取不到有效值。
FromIp	String	source ip 注意：此字段可能返回 null，表示取不到有效值。示例值：1.1.1.1
SessionTime	String	该命令所属会话的会话开始时间注意：此字段可能返回 null，表示取不到有效值。示例值：2023-04-24T18:47:18.118138659+08:00
ConfirmTime	String	复核时间注意：此字段可能返回 null，表示取不到有效值。
UserDepartmentId	String	部门id 注意：此字段可能返回 null，表示取不到有效值。示例值：1.3
UserDepartmentName	String	用户部门名称注意：此字段可能返回 null，表示取不到有效值。示例值：部门名称
DeviceDepartmentId	String	设备部门id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
DeviceDepartmentName	String	设备部门名称注意：此字段可能返回 null，表示取不到有效值。示例值：部门名称
Size	Integer	会话大小注意：此字段可能返回 null，表示取不到有效值。示例值：10

SearchFileBySidResult

文件操作搜索结果

被如下接口引用：SearchFileBySid。

名称	类型	描述
Time	String	文件操作时间示例值：2006-01-02T15:04:05Z
Method	Integer	1-上传文件 2-下载文件 3-删除文件 4-移动文件 5-重命名文件 6-新建文件夹 7-移动文件夹 8-重命名文件夹 9-删除文件夹示例值：1
Protocol	String	文件传输协议示例值："SFTP"
FileCurr	String	method为上传、下载、删除时文件在服务器上的位置, 或重命名、移动文件前文件的位置示例值："/home/1.txt"
FileNew	String	method为重命名、移动文件时代表移动后的新位置.其他情况为null 注意：此字段可能返回 null，表示取不到有效值。示例值："/home/2.txt"
Size	Integer	method为上传文件、下载文件、删除文件时显示文件大小。其他情况为null 注意：此字段可能返回 null，表示取不到有效值。示例值：123
Action	Integer	堡垒机拦截情况, 1-已执行， 2-被阻断示例值：1

SearchFileResult

文件传输检索结果

被如下接口引用：SearchFile。

名称	类型	描述
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
Action	Integer	操作结果：1 - 已执行，2 - 已阻断示例值：1
Method	Integer	操作类型：1 - 文件上传，2 - 文件下载，3 - 文件删除，4 - 文件(夹)移动，5 - 文件(夹)重命名，6 - 新建文件夹，9 - 删除文件夹示例值：1
FileCurr	String	下载的文件（夹）路径及名称示例值：/home/abc.txt
FileNew	String	上传或新建文件（夹）路径及名称示例值：/home/abc.txt

SearchFileTypeFilter

用于搜索文件传输记录等日志时按照protocol和method进行过滤

被如下接口引用：SearchFileBySid。

名称	类型	必选	描述
Protocol	String	是	需要查询的文件传输类型，如SFTP/CLIP/RDP/RZSZ 示例值：SFTP
Method	Array of Integer	否	在当前指定的protocol下进一步过滤具体操作类型,如剪贴板文件上传，剪贴板文件下载等示例值：1, 2

SessionCommand

命令和所属会话

被如下接口引用：SearchSessionCommand。

名称	类型	描述
StartTime	String	开始时间示例值：2020-01-01T01:01:01Z
EndTime	String	结束时间示例值：2020-01-01T01:01:01Z
UserName	String	用户名示例值：user1
RealName	String	账号示例值：administrator
DeviceName	String	设备名示例值：xxx
PrivateIp	String	内部Ip 示例值：127.0.0.1
PublicIp	String	外部Ip 示例值：127.0.0.1
Commands	Array of Command	命令列表示例值：[]
Count	Integer	记录数示例值：10
Id	String	会话Id 示例值：xxx
InstanceId	String	设备id 示例值：xxx
ApCode	String	设备所属的地域示例值：ap-guangzhou

SessionResult

搜索字符或图形会话时返回的SessionResul结构体

被如下接口引用：SearchSession。

名称	类型	描述
UserName	String	用户名示例值：user1
RealName	String	姓名示例值：王建国
Account	String	主机账号示例值：administrator
StartTime	String	开始时间示例值：2006-01-02T15:04:05Z
EndTime	String	结束时间示例值：2006-01-02T15:04:05Z
Size	Integer	会话大小示例值：10
InstanceId	String	设备ID 示例值：xxx
DeviceName	String	设备名示例值：xxxxx
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	Integer	该会话内命令数量，搜索图形会话时该字段无意义示例值：20
DangerCount	Integer	该会话内高危命令数，搜索图形时该字段无意义示例值：3
Status	Integer	会话状态，如1会话活跃 2会话结束 3强制离线 4其他错误示例值：2
Id	String	会话Id 示例值：xxx
ApCode	String	设备所属的地域示例值：ap-guangzhou
Protocol	String	会话协议示例值：SSH

TagFilter

资产标签

被如下接口引用：DescribeDeviceGroupMembers, DescribeDevices。

名称	类型	必选	描述
TagKey	String	是	标签键示例值："业务部门"
TagValue	Array of String	否	标签值示例值：["研发部", "运营部"]

User

用户信息

被如下接口引用：DescribeAcls, DescribeUserGroupMembers, DescribeUsers。

名称	类型	必选	描述
UserName	String	是	用户名, 3-20个字符必须以英文字母开头，且不能包含字母、数字、.、_、-以外的字符示例值：user001
RealName	String	是	用户姓名，最大20个字符，不能包含空白字符示例值：张三
Id	Integer	否	用户ID 示例值：1
Phone	String	否	手机号码，大陆手机号直接填写，如果是其他国家、地区号码,按照"国家地区代码\|手机号"的格式输入。如: "+852\|xxxxxxxx" 示例值：138xxxx1111
Email	String	否	电子邮件示例值：xxx@xx.com
ValidateFrom	Timestamp ISO8601	否	用户生效时间，如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则用户长期有效示例值：2021-01-01T08:00:01+08:00
ValidateTo	Timestamp ISO8601	否	用户失效时间，如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则用户长期有效示例值：2021-01-01T08:00:01+08:00
GroupSet	Array of Group	否	所属用户组列表示例值：[]
AuthType	Integer	否	认证方式，0 - 本地，1 - LDAP，2 - OAuth 示例值：0
ValidateTime	String	否	访问时间段限制，由0、1组成的字符串，长度168(7 × 24)，代表该用户在一周中允许访问的时间段。字符串中第N个字符代表在一周中的第N个小时， 0 - 代表不允许访问，1 - 代表允许访问示例值：0000000000000000000000000000000000000000000000000000000000000000
Department	Department	否	用户所属部门（用于出参）注意：此字段可能返回 null，表示取不到有效值。
DepartmentId	String	否	用户所属部门（用于入参）注意：此字段可能返回 null，表示取不到有效值。示例值：1.2.3
ActiveStatus	Integer	否	激活状态 0 - 未激活 1 - 激活注意：此字段可能返回 null，表示取不到有效值。示例值：1
LockStatus	Integer	否	锁定状态 0 - 未锁定 1 - 锁定注意：此字段可能返回 null，表示取不到有效值。示例值：1
Status	String	否	状态与Filter中一致注意：此字段可能返回 null，表示取不到有效值。示例值：0
AclVersion	Integer	否	权限版本注意：此字段可能返回 null，表示取不到有效值。示例值：1

上一篇: 设置OAuth认证参数下一篇: 错误码