数据结构

最近更新时间:2024-11-15 01:27:56

我的收藏

ACTemplate

权限控制模板对象

被如下接口引用:DescribeAcls。

名称 类型 必选 描述
TemplateId String 模板id
示例值:temp-20231101
TemplateName String 模板名称
示例值:改密计划模板
Description String 模板描述
示例值:这是一个模板

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 关联的用户列表
示例值:[{"Id": 23}]
UserGroupSet Array of Group 关联的用户组列表
示例值:[{"Id": 58}]
DeviceSet Array of Device 关联的资产列表
示例值:[{"Id":47}]
DeviceGroupSet Array of Group 关联的资产组列表
示例值:[{"Id": 45}]
AccountSet Array of String 关联的账号列表
示例值:["root"]
CmdTemplateSet Array of CmdTemplate 关联的高危命令模板列表
示例值:[{"Id":589}]
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 所属部门的信息
示例值:{"Id":"1", "Name":"总部"}
AllowAccessCredential Boolean 是否允许使用访问串,默认允许
示例值:true
ACTemplateSet Array of ACTemplate 关联的数据库高危命令列表
示例值:[{"TemplateId":" temp-20231101"}]
WhiteCmds Array of String 关联的白命令命令
示例值:["ls","pwd"]
AllowKeyboardLogger Boolean 是否允许记录键盘
示例值:false

AssetSyncStatus

资产同步状态

被如下接口引用:DescribeAssetSyncStatus。

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

AuditLogResult

审计日志

被如下接口引用:SearchAuditLog。

名称 类型 描述
Sid String 被审计会话的Sid
示例值:dfac9070-8b23-499e-83b2-a50e3ca
Uin String 审计者的编号
示例值:100245200143
Time String 审计动作发生的时间
示例值:2023-10-30T10:02:31+08:00
ClientIp String 审计者的Ip
示例值:10.12.10.11
Operation Integer 审计动作类型,1--回放、2--中断、3--监控
示例值:1
InstanceId String 被审计主机的Id
示例值:ins-eadwssddf
DeviceName String 被审计主机的主机名
示例值:linux
Protocol String 被审计会话所属的类型,如字符会话
示例值:SSH
PrivateIp String 被审计主机的内部Ip
示例值:172.10.12.15
PublicIp String 被审计主机的外部Ip
示例值:192.168.45.125
SubAccountUin String 审计者的子账号
示例值:1002452741033

ChangePwdTaskDetail

查询改密计划详情

被如下接口引用:DescribeChangePwdTaskDetail。

名称 类型 描述
Device Device 资产信息
示例值:{"Id":41, "Name":"开发机"}
Account String 资产账号
示例值:root
LastChangeStatus Integer 上次改密结果。0-未改密 1-改密成功 2-改密失败
示例值:0

ChangePwdTaskInfo

修改密码任务信息

被如下接口引用:DescribeChangePwdTask。

名称 类型 描述
Id Integer id
示例值:1
OperationId String 任务id
示例值:ops-9n64a
TaskName String 任务名
示例值:改密任务
Department Department 所属部门信息
示例值:{"Id":78, "Name":"开发部"}
ChangeMethod Integer 改密方式。1:使用执行账号。2:修改自身密码
示例值:1
RunAccount String 执行账号
示例值:root
AuthGenerationStrategy Integer 密码生成策略
示例值:1
PasswordLength Integer 密码长度
示例值:12
SmallLetter Integer 包含小写字母
示例值:1
BigLetter Integer 包含大写字母
示例值:1
Digit Integer 包含数字
示例值:1
Symbol String 包含的特殊字符,base64
示例值:&$#@
CompleteNotify Integer 改密完成通知。0-通知,1-不通知
示例值:1
NotifyEmails Array of String 通知人邮箱
示例值:["215892240@qq.com","17785425015@163.com"]
FilePassword String 加密附件密码
示例值:bh-test-file-pwd
AccountSet Array of String 需要改密的账户
示例值:["ubuntu"]
DeviceSet Array of Device 需要改密的主机
示例值:["Id":47, "InstanceId":"ins-easfe"]
Type Integer 任务类型:4手动,5自动
示例值:5
Period Integer 周期
示例值:7
FirstTime Timestamp ISO8601 首次执行时间
示例值:2020-12-20T19:51:23+08:00
NextTime Timestamp ISO8601 下次执行时间
示例值:2020-12-20T19:51:23+08:00

Clb

负载均衡

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

名称 类型 描述
ClbIp String 负载均衡IP
示例值:192.168.0.2

CmdTemplate

高危命令模板

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

名称 类型 描述
Id Integer 高危命令模板ID
示例值:1
Name String 高危命令模板名称
示例值:"我的命令模板"
CmdList String 命令列表,命令之间用换行符("\n")分隔
示例值:rm -rf
Type Integer 命令模板类型 1-内置 2-自定义
示例值:1

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
示例值:sadn1j2121
UserName String 用户名
示例值:zhangsan
Account String 设备account
示例值:root
InstanceId String 设备ip
示例值:ins-onwx8e9y
FromIp String source ip
示例值:1.1.124.125
SessionTime 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 Integer 会话大小
示例值:10

Department

部门信息

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

名称 类型 必选 描述
Id String 部门ID
示例值:1.2
Name String 部门名称,1 - 256个字符
示例值:研发部
Managers Array of String 部门管理员账号ID
示例值:["154245475"]
ManagerUsers Array of DepartmentManagerUser 管理员用户
示例值:[{"ManagerId":"154245475","ManagerName":"jack" }]

DepartmentManagerUser

部门管理员信息

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

名称 类型 必选 描述
ManagerId String 管理员Id
示例值:1
ManagerName String 管理员姓名
示例值:user

Device

资产信息

被如下接口引用:DescribeAcls, DescribeChangePwdTask, DescribeChangePwdTaskDetail, DescribeDeviceGroupMembers, DescribeDevices。

名称 类型 描述
Id Integer 资产ID
示例值:1
InstanceId String 实例ID,对应CVM、CDB等实例ID
示例值:Ins-bhtest
Name String 资产名
示例值:运维主机
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 所属资产组列表
示例值:[{"Id":542, "Name":"linux集群"}]
AccountCount Integer 资产绑定的账号数
示例值:10
VpcId String VPC ID
示例值:vpc-ij89n2
SubnetId String 子网ID
示例值:subnet-a2676p0e
Resource Resource 堡垒机服务信息,注意没有绑定服务时为null
示例值:bh-saas-8n1najs
Department Department 资产所属部门
示例值:{"Id":54, "Name":"开发部"}
IpPortSet Array of String 数据库资产的多节点
示例值:["127.0.0.1:2001"]
DomainId String 网络域Id
示例值:net-default
DomainName String 网络域名称
示例值:默认网络域
EnableSSL Integer 是否启用SSL,仅支持Redis资产。0:禁用 1:启用
示例值:1
SSLCertName String 已上传的SSL证书名称
示例值:bh-redis-test.crt

DeviceAccount

主机账号

被如下接口引用:DescribeDeviceAccounts。

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

Domain

网络域

被如下接口引用:DescribeDomains。

名称 类型 描述
Id Integer 自增id
示例值:1
DomainId String 网络域id
示例值:net-default1
DomainName String 网络域名称
示例值:腾讯云网络
ResourceId String 堡垒机id
示例值:bh-saas-n9j7hu
WhiteIpSet Array of String ip,网段
示例值:ip 192.168.0.1 网段 192.168.0.0/24
Enabled Integer 是否启用 默认 1启用 0禁用
示例值:0
Status Integer 状态 0-已断开 1-已连接
示例值:0
CreateTime Timestamp ISO8601 网络域创建时间
示例值:2021-02-04T15:23:52+08:00
Default Integer 是否资源默认网络域 1-资源默认网络域 0-用户添加网络域
示例值:0

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"]
EnableSSL Integer 是否启用SSL,1:启用 0:禁用,仅支持Redis资产
示例值:1
SSLCert String SSL证书,EnableSSL时必填
示例值:bh-test-cert
SSLCertName String SSL证书名称,EnableSSL时必填
示例值:bh-redis-test.crt

Filter

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

被如下接口引用:DescribeAcls, DescribeChangePwdTask, DescribeChangePwdTaskDetail, DescribeDevices, DescribeDomains, DescribeUsers。

名称 类型 必选 描述
Name String 需要过滤的字段。
示例值:UserName
Values Array of String 字段的过滤值。
若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。
示例值:["Nathan","Luke"]

Group

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

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

名称 类型 必选 描述
Id Integer 组ID
示例值:1
Name String 组名称
示例值:运维组
Department Department 所属部门信息
示例值:{"Id":23, "Name":"开发部"}
Count Integer 个数
示例值:1

LoginEvent

登录日志

被如下接口引用:DescribeLoginEvent。

名称 类型 描述
UserName String 用户名
示例值:Evan
RealName String 姓名
示例值:Tyler
Time Timestamp ISO8601 操作时间
示例值:2020-12-31T17:34:17+08:00
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 用户名
示例值:Nathan
RealName String 姓名
示例值:Dylan
Time Timestamp ISO8601 操作时间
示例值:2020-12-31T17:34:17+08:00
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_dasdsa
VpcId String VPC ID
示例值:vpc-sdfsc-esd
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-dfedas-feasd
SubnetName String 开通服务的子网名称
示例值:subnet1
CidrBlock String 开通服务的子网网段
示例值:10.10.10.0/24
PublicIpSet Array of String 外部IP
示例值:["127.0.0.1"]
PrivateIpSet Array of String 内部IP
示例值:["127.0.0.1"]
ModuleSet Array of String 服务开通的高级功能列表,如:[DB]
示例值:["DB"]
UsedNodes Integer 已使用的授权点数
示例值:10
ExtendPoints Integer 扩展点数
示例值:50
PackageBandwidth Integer 带宽扩展包个数(4M)
示例值:1
PackageNode Integer 授权点数扩展包个数(50点)
示例值:1
LogDeliveryArgs String 日志投递规格信息
示例值:sv_cds_dasb_saas_sdfaswa
ClbSet Array of Clb 堡垒机资源LB
示例值:[{"ClbIp":"192.168.11.20"}]
DomainCount Integer 网络域个数
示例值:0
UsedDomainCount Integer 已使用网络域个数
示例值:1
Trial Integer 0 非试用版,1 试用版
示例值:0
CdcClusterId String cdc集群id
示例值:cdc-dfsed-eda
LogDelivery String 日志投递规格信息
示例值:sc_cds_dasb_saas_dssa
DeployModel Integer 部署模式
示例值:1
IntranetAccess Integer 0 默认值,非内网访问,1 内网访问
示例值:0
IntranetPrivateIpSet Array of String 内网访问的ip
示例值:["127.0.0.1"]
IntranetVpcId String 开通内网访问的vpc
示例值:vpc-se23s3rf
IntranetVpcCidr String 开通内网访问vpc的网段
示例值:172.9.9.1/0

RunChangePwdTaskDetail

立即执行改密任务的入参

被如下接口引用:RunChangePwdTask。

名称 类型 必选 描述
DeviceId Integer 资产id
示例值:1
Account String 资产账号
示例值:root

SearchCommandResult

命令执行检索结果

被如下接口引用:SearchCommand。

名称 类型 描述
Time String 命令输入的时间
示例值:2022-01-01T01:01:01+08:00
UserName String 用户名
示例值:user1
RealName String 姓名
示例值:张三
InstanceId String 资产ID
示例值:ins-liyv81n
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
示例值:asdad-9maid-sda-bhtest
TimeOffset Integer 命令执行时间相对于所属会话开始时间的偏移量,单位ms
示例值:1
Account String 账号
示例值:root
FromIp String source ip
示例值:1.1.1.1
SessionTime String 该命令所属会话的会话开始时间
示例值:2023-04-24T18:47:18+08:00
ConfirmTime String 复核时间
示例值:2023-01-01T01:03:01+08:00
UserDepartmentId String 部门id
示例值:1.3
UserDepartmentName String 用户部门名称
示例值:部门名称
DeviceDepartmentId String 设备部门id
示例值:1
DeviceDepartmentName String 设备部门名称
示例值:部门名称
Size Integer 会话大小
示例值:10

SearchFileBySidResult

文件操作搜索结果

被如下接口引用:SearchFileBySid。

名称 类型 描述
Time String 文件操作时间
示例值:2006-01-02T15:04:05+08:00
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
示例值:/home/2.txt
Size Integer method为上传文件、下载文件、删除文件时显示文件大小。其他情况为null
示例值:56
Action Integer 堡垒机拦截情况, 1-已执行, 2-被阻断
示例值:1

SearchFileResult

文件传输检索结果

被如下接口引用:SearchFile。

名称 类型 描述
Time String 文件传输的时间
示例值:2022-01-01T01:01:01Z
UserName String 用户名
示例值:zhangsan
RealName String 姓名
示例值:张三
InstanceId String 资产ID
示例值:ins-8nh087
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:01+08:00
EndTime String 结束时间
示例值:2020-01-01T01:01:01+08:00
UserName String 用户名
示例值:Ryan
RealName String 账号
示例值:administrator
DeviceName String 设备名
示例值:LDAP测试
PrivateIp String 内部Ip
示例值:127.0.0.1
PublicIp String 外部Ip
示例值:127.0.0.1
Commands Array of Command 命令列表
示例值:[{"Sid":"sadn1j2121"}]
Count Integer 记录数
示例值:10
Id String 会话Id
示例值:wfdsdweqrewe233
InstanceId String 设备id
示例值:ins-weafsdrq1w
ApCode String 设备所属的地域
示例值:ap-guangzhou

SessionResult

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

被如下接口引用:SearchSession。

名称 类型 描述
UserName String 用户名
示例值:zhangsan
RealName String 姓名
示例值:张三
Account String 主机账号
示例值:administrator
StartTime String 开始时间
示例值:2006-01-02T15:04:05+08:00
EndTime String 结束时间
示例值:2006-01-02T15:04:05+08:00
Size Integer 会话大小
示例值:10
InstanceId String 设备ID
示例值:Ins-au9j1
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 Integer 该会话内命令数量 ,搜索图形会话时该字段无意义
示例值:20
DangerCount Integer 该会话内高危命令数,搜索图形时该字段无意义
示例值:3
Status Integer 会话状态,如1会话活跃 2会话结束 3强制离线 4其他错误
示例值:2
Id String 会话Id
示例值:dfac9070-8b23-499e-83b2-a50e
ApCode String 设备所属的地域
示例值:ap-guangzhou
Protocol String 会话协议
示例值:SSH

TagFilter

资产标签

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

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

User

用户信息

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

名称 类型 必选 描述
UserName String 用户名, 3-20个字符 必须以英文字母开头,且不能包含字母、数字、.、_、-以外的字符
示例值:zhangsan
RealName String 用户姓名, 最大20个字符,不能包含空白字符
示例值:张三
Id Integer 用户ID
示例值:1
Phone String 手机号码, 大陆手机号直接填写,如果是其他国家、地区号码,按照"国家地区代码|手机号"的格式输入。如: "+852|xxxxxxxx"
示例值:138****1111
Email String 电子邮件
示例值:198***@qq.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 所属用户组列表
示例值:[{"Id":85,"Name":"开发组"}]
AuthType Integer 认证方式,0 - 本地,1 - LDAP,2 - OAuth
示例值:0
ValidateTime String 访问时间段限制, 由0、1组成的字符串,长度168(7 × 24),代表该用户在一周中允许访问的时间段。字符串中第N个字符代表在一周中的第N个小时, 0 - 代表不允许访问,1 - 代表允许访问
示例值:0000000000000000000000000000000000000000000000000000000000000000
Department Department 用户所属部门(用于出参)
示例值:{"Id":"1.2","Name":"运维部"}
DepartmentId String 用户所属部门(用于入参)
示例值:1.2.3
ActiveStatus Integer 激活状态 0 - 未激活 1 - 激活
示例值:1
LockStatus Integer 锁定状态 0 - 未锁定 1 - 锁定
示例值:1
Status String 状态 与Filter中一致
示例值:0
AclVersion Integer 权限版本
示例值:1