{ "name": "bh", "display_name": "运维安全中心（堡垒机）", "description": "介绍如何使用API对运维安全中心（堡垒机）进行操作，包括管理用户、访问权限等资源。", "domain": "security", "api_version": "2023-04-18", "endpoint": "bh.tencentcloudapi.com", "actions": [ { "name": "AccessDevices", "description": "外部客户访问资产", "status": "online", "parameters": [ { "name": "Account", "type": "string", "required": true, "description": "资产的登录账号", "example": "root" }, { "name": "DeviceId", "type": "integer", "required": false, "description": "资产ID", "example": "12" }, { "name": "InstanceId", "type": "string", "required": false, "description": "资源id(优先使用DeviceId)", "example": "ins-bhtest" }, { "name": "Password", "type": "string", "required": false, "description": "未托管密码私钥时，填入", "example": "1a2b3c" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "未托管密码私钥时，填入", "example": "bh-test-private-key" }, { "name": "PrivateKeyPassword", "type": "string", "required": false, "description": "未托管密码私钥时，填入", "example": "1a2b3c" }, { "name": "Exe", "type": "string", "required": false, "description": "客户端工具", "example": "mrd" }, { "name": "Drivers", "type": "array", "required": false, "description": "RDP挂载盘符驱动（mstsc支持）", "example": "[\"c:\",\"d:\"]", "item_type": "string" }, { "name": "Width", "type": "integer", "required": false, "description": "窗口宽度（RDP支持）", "example": "800" }, { "name": "Height", "type": "integer", "required": false, "description": "窗口高度（RDP支持）", "example": "600" }, { "name": "IntranetAccess", "type": "boolean", "required": false, "description": "是否内网访问（默认不是）", "example": "false" }, { "name": "AutoManageAccessCredential", "type": "boolean", "required": false, "description": "是否自动管理访问串，删掉过期的，新建可用的（默认false）", "example": "false" } ], "required": [ "Account" ] }, { "name": "AddDeviceGroupMembers", "description": "添加资产组成员", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "资产组ID", "example": "1" }, { "name": "MemberIdSet", "type": "array", "required": true, "description": "需要添加到资产组的资产ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "Id", "MemberIdSet" ] }, { "name": "AddUserGroupMembers", "description": "添加用户组成员", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "用户组ID", "example": "1" }, { "name": "MemberIdSet", "type": "array", "required": true, "description": "成员用户ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "Id", "MemberIdSet" ] }, { "name": "BindDeviceAccountPassword", "description": "绑定主机账号密码", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "主机账号ID", "example": "1" }, { "name": "Password", "type": "string", "required": true, "description": "主机账号密码", "example": "testpassword" } ], "required": [ "Id", "Password" ] }, { "name": "BindDeviceAccountPrivateKey", "description": "绑定主机账号私钥", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "主机账号ID", "example": "1" }, { "name": "PrivateKey", "type": "string", "required": true, "description": "主机账号私钥，最小长度128字节，最大长度8192字节", "example": "bh-test-key" }, { "name": "PrivateKeyPassword", "type": "string", "required": false, "description": "主机账号私钥口令，最大长度256字节", "example": "bh-test-pwd" } ], "required": [ "Id", "PrivateKey" ] }, { "name": "BindDeviceResource", "description": "修改资产绑定的堡垒机服务", "status": "online", "parameters": [ { "name": "DeviceIdSet", "type": "array", "required": true, "description": "资产ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "ResourceId", "type": "string", "required": false, "description": "堡垒机服务ID", "example": "bh-saas-1a2b3c" }, { "name": "DomainId", "type": "string", "required": false, "description": "网络域ID", "example": "net-default" }, { "name": "ManageDimension", "type": "integer", "required": false, "description": "K8S集群托管账号维度。1-集群，2-命名空间，3-工作负载", "example": "1" }, { "name": "ManageAccountId", "type": "integer", "required": false, "description": "K8S集群托管账号id", "example": "1" }, { "name": "ManageAccount", "type": "string", "required": false, "description": "K8S集群托管账号名称", "example": "root" }, { "name": "ManageKubeconfig", "type": "string", "required": false, "description": "K8S集群托管账号凭证", "example": "test-kubeconfig" }, { "name": "Namespace", "type": "string", "required": false, "description": "K8S集群托管的namespace", "example": "nameSpace0" }, { "name": "Workload", "type": "string", "required": false, "description": "K8S集群托管的workload", "example": "workload0" } ], "required": [ "DeviceIdSet" ] }, { "name": "CheckLDAPConnection", "description": "测试LDAP连接", "status": "online", "parameters": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否开启LDAP认证，必须为true", "example": "true" }, { "name": "Ip", "type": "string", "required": true, "description": "服务器地址", "example": "10.10.10.1" }, { "name": "Port", "type": "integer", "required": true, "description": "服务端口", "example": "389" }, { "name": "EnableSSL", "type": "boolean", "required": true, "description": "是否开启SSL，false-不开启，true-开启", "example": "true" }, { "name": "BaseDN", "type": "string", "required": true, "description": "Base DN", "example": "bh-test-DN" }, { "name": "AdminAccount", "type": "string", "required": true, "description": "管理员账号", "example": "admin" }, { "name": "AdminPassword", "type": "string", "required": true, "description": "管理员密码", "example": "pwd" }, { "name": "IpBackup", "type": "string", "required": false, "description": "备用服务器地址", "example": "10.10.10.2" }, { "name": "DomainId", "type": "string", "required": false, "description": "网络域id", "example": "net-default" }, { "name": "AttributeUserName", "type": "string", "required": false, "description": "用户名称映射属性", "example": "cn" } ], "required": [ "Enable", "Ip", "Port", "EnableSSL", "BaseDN", "AdminAccount", "AdminPassword" ] }, { "name": "CreateAccessWhiteListRule", "description": "添加访问白名单规则", "status": "online", "parameters": [ { "name": "Source", "type": "string", "required": true, "description": "ip 10.10.10.1或者网段10.10.10.0/24，最小长度4字节，最大长度40字节。", "example": "10.10.10.0/24" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息，最小长度0字符，最大长度40字符。", "example": "规则1" } ], "required": [ "Source" ] }, { "name": "CreateAcl", "description": "新建访问权限", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "权限名称，最大32字符，不能包含空白字符", "example": "acl1" }, { "name": "AllowDiskRedirect", "type": "boolean", "required": true, "description": "是否开启磁盘映射", "example": "true" }, { "name": "AllowAnyAccount", "type": "boolean", "required": true, "description": "是否允许任意账号登录", "example": "false" }, { "name": "AllowClipFileUp", "type": "boolean", "required": false, "description": "是否开启剪贴板文件上行", "example": "true" }, { "name": "AllowClipFileDown", "type": "boolean", "required": false, "description": "是否开启剪贴板文件下行", "example": "true" }, { "name": "AllowClipTextUp", "type": "boolean", "required": false, "description": "是否开启剪贴板文本（含图片）上行", "example": "true" }, { "name": "AllowClipTextDown", "type": "boolean", "required": false, "description": "是否开启剪贴板文本（含图片）下行", "example": "true" }, { "name": "AllowFileUp", "type": "boolean", "required": false, "description": "是否开启 SFTP 文件上传", "example": "true" }, { "name": "MaxFileUpSize", "type": "integer", "required": false, "description": "文件传输上传大小限制（预留参数，目前暂未使用）", "example": "0" }, { "name": "AllowFileDown", "type": "boolean", "required": false, "description": "是否开启 SFTP 文件下载", "example": "true" }, { "name": "MaxFileDownSize", "type": "integer", "required": false, "description": "文件传输下载大小限制（预留参数，目前暂未使用）", "example": "0" }, { "name": "UserIdSet", "type": "array", "required": false, "description": "关联的用户ID集合", "example": "[1]", "item_type": "integer" }, { "name": "UserGroupIdSet", "type": "array", "required": false, "description": "关联的用户组ID", "example": "[1]", "item_type": "integer" }, { "name": "DeviceIdSet", "type": "array", "required": false, "description": "关联的资产ID集合", "example": "[1]", "item_type": "integer" }, { "name": "AppAssetIdSet", "type": "array", "required": false, "description": "关联的应用资产ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "DeviceGroupIdSet", "type": "array", "required": false, "description": "关联的资产组ID", "example": "[1]", "item_type": "integer" }, { "name": "AccountSet", "type": "array", "required": false, "description": "关联的账号", "example": "[\"root\",\"ubuntu\"]", "item_type": "string" }, { "name": "CmdTemplateIdSet", "type": "array", "required": false, "description": "关联的高危命令模板ID", "example": "[1]", "item_type": "integer" }, { "name": "ACTemplateIdSet", "type": "array", "required": false, "description": "关联高危DB模板ID", "example": "[\"template1\",\"template2\"]", "item_type": "string" }, { "name": "AllowDiskFileUp", "type": "boolean", "required": false, "description": "是否开启rdp磁盘映射文件上传", "example": "true" }, { "name": "AllowDiskFileDown", "type": "boolean", "required": false, "description": "是否开启rdp磁盘映射文件下载", "example": "true" }, { "name": "AllowShellFileUp", "type": "boolean", "required": false, "description": "是否开启rz sz文件上传", "example": "true" }, { "name": "AllowShellFileDown", "type": "boolean", "required": false, "description": "是否开启rz sz文件下载", "example": "true" }, { "name": "AllowFileDel", "type": "boolean", "required": false, "description": "是否开启 SFTP 文件删除", "example": "true" }, { "name": "ValidateFrom", "type": "string", "required": false, "description": "访问权限生效时间，如:\"2021-09-22T00:00:00+00:00\" 生效、失效时间不填则访问权限长期有效", "example": "2021-02-04T15:23:52+08:00" }, { "name": "ValidateTo", "type": "string", "required": false, "description": "访问权限失效时间，如:\"2021-09-23T00:00:00+00:00\" 生效、失效时间不填则访问权限长期有效", "example": "2021-02-04T15:23:52+08:00" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "访问权限所属部门的ID", "example": "1.2.3" }, { "name": "AllowAccessCredential", "type": "boolean", "required": false, "description": "是否允许使用访问串，默认允许", "example": "true" }, { "name": "AllowKeyboardLogger", "type": "boolean", "required": false, "description": "是否允许键盘记录", "example": "false" } ], "required": [ "Name", "AllowDiskRedirect", "AllowAnyAccount" ] }, { "name": "CreateAssetSyncJob", "description": "创建手工资产同步任务", "status": "online", "parameters": [ { "name": "Category", "type": "integer", "required": true, "description": "同步资产类别，1 - 主机资产, 2 - 数据库资产，3-容器资产", "example": "1" } ], "required": [ "Category" ] }, { "name": "CreateChangePwdTask", "description": "创建修改密码任务", "status": "online", "parameters": [ { "name": "TaskName", "type": "string", "required": true, "description": "任务名", "example": "周期改密任务" }, { "name": "DeviceIdSet", "type": "array", "required": true, "description": "资产id数组", "example": "[1]", "item_type": "integer" }, { "name": "AccountSet", "type": "array", "required": true, "description": "修改的账户数组", "example": "[\"root\",\"test\"]", "item_type": "string" }, { "name": "ChangeMethod", "type": "integer", "required": true, "description": "改密方式。1：使用执行账号修改密码；2：修改自身密码", "example": "1" }, { "name": "AuthGenerationStrategy", "type": "integer", "required": true, "description": "认证生成方式。 1:自动生成相同密码 2:自动生成不同密码 3:手动指定相同密码", "example": "1" }, { "name": "RunAccount", "type": "string", "required": false, "description": "执行账号", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "手动指定密码时必传", "example": "1a****3f" }, { "name": "PasswordLength", "type": "integer", "required": false, "description": "密码限制长度，长度大于 12 位", "example": "12" }, { "name": "SmallLetter", "type": "integer", "required": false, "description": "密码包含小写字母。0：否，1：是", "example": "1" }, { "name": "BigLetter", "type": "integer", "required": false, "description": "密码包含大写字母。0：否，1：是", "example": "1" }, { "name": "Digit", "type": "integer", "required": false, "description": "密码包含数字。0：否，1：是", "example": "1" }, { "name": "Symbol", "type": "string", "required": false, "description": "密码包含的特殊字符（base64编码），包含：^[-_#();%~!+=]*$", "example": "ISMkJQ==" }, { "name": "CompleteNotify", "type": "integer", "required": false, "description": "改密完成通知。0：不通知 1：通知", "example": "0" }, { "name": "NotifyEmails", "type": "array", "required": false, "description": "通知邮箱", "example": "[\"123@qq.com\",\"234@qq.com\"]", "item_type": "string" }, { "name": "FilePassword", "type": "string", "required": false, "description": "加密压缩文件密码", "example": "testFilePwd" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "所属部门id。“1.2.3”", "example": "1.2" }, { "name": "Type", "type": "integer", "required": false, "description": "任务类型 4-手工执行 5-周期自动执行", "example": "4" }, { "name": "Period", "type": "integer", "required": false, "description": "执行周期，单位天（大于等于 1，小于等于 365）", "example": "1" }, { "name": "FirstTime", "type": "string", "required": false, "description": "周期任务首次执行时间", "example": "2020-12-20T19:51:23+08:00" } ], "required": [ "TaskName", "DeviceIdSet", "AccountSet", "ChangeMethod", "AuthGenerationStrategy" ] }, { "name": "CreateCmdTemplate", "description": "新建高危命令模板", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "模板名，最大长度32字符，不能包含空白字符", "example": "cmd-temp-name" }, { "name": "CmdList", "type": "string", "required": true, "description": "命令列表，\\n分隔，最大长度32768字节", "example": "rm -f" }, { "name": "Encoding", "type": "integer", "required": false, "description": "标识CmdList字段前端是否为base64加密传值.0:表示非base64加密1:表示是base64加密", "example": "0" } ], "required": [ "Name", "CmdList" ] }, { "name": "CreateDeviceAccount", "description": "新建主机账号", "status": "online", "parameters": [ { "name": "DeviceId", "type": "integer", "required": true, "description": "主机记录ID", "example": "1" }, { "name": "Account", "type": "string", "required": true, "description": "账号名", "example": "admin" } ], "required": [ "DeviceId", "Account" ] }, { "name": "CreateDeviceGroup", "description": "新建资产组", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "资产组名，最大长度32字符", "example": "运维资产组" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "资产组所属部门ID，如：1.2.3", "example": "1.2.3" } ], "required": [ "Name" ] }, { "name": "CreateOperationTask", "description": "创建运维任务", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "运维任务名称", "example": "runshell" }, { "name": "Type", "type": "integer", "required": true, "description": "运维任务类型,1 - 手工执行, 2 - 周期性自动执行", "example": "1" }, { "name": "Account", "type": "string", "required": true, "description": "执行账号", "example": "root" }, { "name": "Timeout", "type": "integer", "required": true, "description": "超时时间,单位秒", "example": "5" }, { "name": "Script", "type": "string", "required": true, "description": "执行脚本内容", "example": "ls -a" }, { "name": "DeviceIdSet", "type": "array", "required": true, "description": "执行主机集合，满足条件以下三个条件：1. 资产绑定可用的专业版或国密版堡垒机服务；2、资产类型为linux资产；3、用户具有资产权限，且资产添加了指定执行账号", "example": "[13,25]", "item_type": "integer" }, { "name": "Period", "type": "integer", "required": false, "description": "执行间隔，单位天. 手工执行时无需传入", "example": "1" }, { "name": "FirstTime", "type": "string", "required": false, "description": "首次执行日期 默认1970-01-01T08:00:01+08:00,手工执行时无需传入", "example": "1970-01-01T08:00:01+08:00" }, { "name": "Encoding", "type": "integer", "required": false, "description": "Script参数是否需要进行base64编码后传递，1-需要进行base64编码后传递，非1值-不需要进行base64编码后传递", "example": "1" } ], "required": [ "Name", "Type", "Account", "Timeout", "Script", "DeviceIdSet" ] }, { "name": "CreateResource", "description": "创建堡垒机实例", "status": "online", "parameters": [ { "name": "DeployRegion", "type": "string", "required": true, "description": "部署region", "example": "ap-guangzhou" }, { "name": "VpcId", "type": "string", "required": true, "description": "部署堡垒机的VpcId", "example": "vpc-8jghau" }, { "name": "SubnetId", "type": "string", "required": true, "description": "部署堡垒机的SubnetId", "example": "subnet-92j4ns" }, { "name": "ResourceEdition", "type": "string", "required": true, "description": "资源类型。取值:standard/pro", "example": "standard" }, { "name": "ResourceNode", "type": "integer", "required": true, "description": "资源节点数", "example": "2" }, { "name": "TimeUnit", "type": "string", "required": true, "description": "计费周期", "example": "m" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "计费时长", "example": "1" }, { "name": "PayMode", "type": "integer", "required": true, "description": "计费模式 1预付费", "example": "1" }, { "name": "AutoRenewFlag", "type": "integer", "required": true, "description": "自动续费", "example": "1" }, { "name": "DeployZone", "type": "string", "required": false, "description": "部署zone", "example": "ap-guangzhou-1" }, { "name": "Trial", "type": "integer", "required": false, "description": "0非试用版，1试用版", "example": "0" }, { "name": "ShareClb", "type": "integer", "required": false, "description": "是否共享clb，0：不共享，1：共享", "example": "0" } ], "required": [ "DeployRegion", "VpcId", "SubnetId", "ResourceEdition", "ResourceNode", "TimeUnit", "TimeSpan", "PayMode", "AutoRenewFlag" ] }, { "name": "CreateSyncUserTask", "description": "创建用户同步任务", "status": "online", "parameters": [ { "name": "UserKind", "type": "integer", "required": true, "description": "同步用户类型, 1-同步ioa用户", "example": "1" } ], "required": [ "UserKind" ] }, { "name": "CreateUser", "description": "新建用户", "status": "online", "parameters": [ { "name": "UserName", "type": "string", "required": true, "description": "用户名, 3-20个字符, 必须以英文字母开头，且不能包含字母、数字、.、_、-以外的字符", "example": "zhangsan" }, { "name": "RealName", "type": "string", "required": true, "description": "用户姓名，最大长度20个字符，不能包含空白字符", "example": "张三" }, { "name": "Phone", "type": "string", "required": false, "description": "按照\"国家地区代码|手机号\"的格式输入，如: \"+86|xxxxxxxx\"。手机号和邮箱参数至少传一项", "example": "86|133*****34" }, { "name": "Email", "type": "string", "required": false, "description": "电子邮件。手机号和邮箱参数至少传一项", "example": "1980**76@qq.com" }, { "name": "ValidateFrom", "type": "string", "required": false, "description": "用户生效时间，如:\"2021-09-22T00:00:00+00:00\" 生效、失效时间不填则用户长期有效", "example": "2021-01-01T08:00:01+08:00" }, { "name": "ValidateTo", "type": "string", "required": false, "description": "用户失效时间，如:\"2021-09-23T00:00:00+00:00\" 生效、失效时间不填则用户长期有效", "example": "2021-01-01T08:00:01+08:00" }, { "name": "GroupIdSet", "type": "array", "required": false, "description": "所属用户组ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "AuthType", "type": "integer", "required": false, "description": "认证方式，0 - 本地， 1 - LDAP， 2 - OAuth 不传则默认为0", "example": "1" }, { "name": "ValidateTime", "type": "string", "required": false, "description": "访问时间段限制， 由0、1组成的字符串，长度168(7 × 24)，代表该用户在一周中允许访问的时间段。字符串中第N个字符代表在一周中的第N个小时， 0 - 代表不允许访问，1 - 代表允许访问", "example": "0000000000000000000000000000000000000000000000000000000000000000" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "所属部门ID，如：“1.2.3”", "example": "1.2.3" } ], "required": [ "UserName", "RealName" ] }, { "name": "CreateUserDirectory", "description": "创建用户目录", "status": "online", "parameters": [ { "name": "DirId", "type": "integer", "required": true, "description": "目录id", "example": "523353" }, { "name": "DirName", "type": "string", "required": true, "description": "目录名称", "example": "dept1" }, { "name": "UserOrgSet", "type": "array", "required": true, "description": "ioa分组信息", "example": "无", "item_type": "object", "children": [ { "name": "OrgId", "type": "integer", "required": true, "description": "ioa用户组织id", "example": "85232" }, { "name": "OrgName", "type": "string", "required": true, "description": "ioa用户组织名称", "example": "钉钉" }, { "name": "OrgIdPath", "type": "string", "required": true, "description": "ioa用户组织id路径", "example": "1233.85232.45245" }, { "name": "OrgNamePath", "type": "string", "required": true, "description": "ioa用户组织名称路径", "example": "全网账户.钉钉.开发部" }, { "name": "UserTotal", "type": "integer", "required": false, "description": "ioa用户组织id下的用户数", "example": "21" } ] }, { "name": "Source", "type": "integer", "required": true, "description": "ioa关联用户源类型", "example": "0" }, { "name": "SourceName", "type": "string", "required": true, "description": "ioa关联用户源名称", "example": "自建账号" }, { "name": "UserCount", "type": "integer", "required": false, "description": "目录包含用户数", "example": "45" } ], "required": [ "DirId", "DirName", "UserOrgSet", "Source", "SourceName" ] }, { "name": "CreateUserGroup", "description": "新建用户组", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "用户组名，最大长度32字符", "example": "运维用户组" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "用户组所属部门的ID，如：1.2.3", "example": "1.2.3" } ], "required": [ "Name" ] }, { "name": "DeleteAccessWhiteListRules", "description": "删除访问白名单规则", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "待删除的ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteAcls", "description": "删除访问权限", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "待删除的权限ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteChangePwdTask", "description": "删除改密任务", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "改密任务id列表", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteCmdTemplates", "description": "删除高危命令模板", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "待删除的ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteDeviceAccounts", "description": "删除主机账号", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "待删除的ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteDeviceGroupMembers", "description": "删除资产组成员", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "资产组ID", "example": "1" }, { "name": "MemberIdSet", "type": "array", "required": true, "description": "需要删除的资产ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "Id", "MemberIdSet" ] }, { "name": "DeleteDeviceGroups", "description": "删除资产组", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "待删除的资产组ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteDevices", "description": "删除主机", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "待删除的ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteOperationTasks", "description": "删除运维任务", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "运维任务ID集合", "example": "[3,4]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteUserDirectory", "description": "删除用户目录", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "目录id集合", "example": "[5,23,5]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteUserGroupMembers", "description": "删除用户组成员", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "用户组ID", "example": "1" }, { "name": "MemberIdSet", "type": "array", "required": true, "description": "需删除的成员用户ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "Id", "MemberIdSet" ] }, { "name": "DeleteUserGroups", "description": "删除用户组", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "待删除的用户组ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeleteUsers", "description": "删除用户", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "待删除的用户ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "DeployResource", "description": "开通服务，初始化资源，只针对新购资源", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "需要开通服务的资源ID", "example": "bh-saas-test" }, { "name": "ApCode", "type": "string", "required": true, "description": "需要开通服务的地域", "example": "ap-guangzhou" }, { "name": "Zone", "type": "string", "required": true, "description": "子网所在可用区", "example": "ap-guangzhou-3" }, { "name": "VpcId", "type": "string", "required": true, "description": "需要开通服务的VPC", "example": "vpc-bhtest" }, { "name": "SubnetId", "type": "string", "required": true, "description": "需要开通服务的子网ID", "example": "subnet-bhtest" }, { "name": "CidrBlock", "type": "string", "required": true, "description": "需要开通服务的子网网段", "example": "10.10.10.0/24" }, { "name": "VpcName", "type": "string", "required": false, "description": "需要开通服务的VPC名称", "example": "vpc1" }, { "name": "VpcCidrBlock", "type": "string", "required": false, "description": "需要开通服务的VPC对应的网段", "example": "10.10.0.0/16" }, { "name": "SubnetName", "type": "string", "required": false, "description": "需要开通服务的子网名称", "example": "subnet1" }, { "name": "CdcClusterId", "type": "string", "required": false, "description": "需要开通实例所属的CDC集群ID", "example": "cdc-bhtest" }, { "name": "ShareClbId", "type": "string", "required": false, "description": "开通堡垒机指定共享的clbId", "example": "lb-xefesef" }, { "name": "WebAccess", "type": "integer", "required": false, "description": "0-关闭web访问堡垒机，1-开启web访问堡垒机", "example": "1" }, { "name": "ClientAccess", "type": "integer", "required": false, "description": "0-关闭客户端访问堡垒机，1-开启客户端访问堡垒机", "example": "1" }, { "name": "IntranetAccess", "type": "integer", "required": false, "description": "0-关闭内网访问堡垒机，1-开启内网访问堡垒机", "example": "0" }, { "name": "ExternalAccess", "type": "integer", "required": false, "description": "0-关闭公网访问堡垒机，1-开启公网访问堡垒机", "example": "1" } ], "required": [ "ResourceId", "ApCode", "Zone", "VpcId", "SubnetId", "CidrBlock" ] }, { "name": "DescribeAccessWhiteListRules", "description": "查询访问白名单规则列表", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": false, "description": "用户ID集合，非必需，如果使用IdSet参数则忽略Name参数", "example": "[1,2]", "item_type": "integer" }, { "name": "Name", "type": "string", "required": false, "description": "来源IP或网段，模糊查询，最大长度64字符", "example": "10.10.10.1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，默认20", "example": "10" } ], "required": [] }, { "name": "DescribeAccountGroups", "description": "获取账号组信息", "status": "online", "parameters": [ { "name": "DeepIn", "type": "integer", "required": false, "description": "是否递归查询，0为不递归，1为递归", "example": "0" }, { "name": "ParentId", "type": "integer", "required": false, "description": "父账号组ID, 默认0,查询根账号组下所有分组", "example": "0" }, { "name": "GroupName", "type": "string", "required": false, "description": "账号组名称，模糊查询", "example": "开发" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页查询，每页条数", "example": "10" }, { "name": "PageNum", "type": "integer", "required": false, "description": "获取第几页的数据", "example": "1" } ], "required": [] }, { "name": "DescribeAcls", "description": "查询访问权限列表", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": false, "description": "访问权限ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "Name", "type": "string", "required": false, "description": "访问权限名称，模糊查询，最长64字符", "example": "aclname" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，默认20，最大500", "example": "10" }, { "name": "Exact", "type": "boolean", "required": false, "description": "是否根据Name进行精确查询，默认值false", "example": "true" }, { "name": "AuthorizedUserIdSet", "type": "array", "required": false, "description": "有访问权限的用户ID集合", "example": "[1,2,3]", "item_type": "integer" }, { "name": "AuthorizedDeviceIdSet", "type": "array", "required": false, "description": "有访问权限的资产ID集合", "example": "[8,9,10]", "item_type": "integer" }, { "name": "AuthorizedAppAssetIdSet", "type": "array", "required": false, "description": "有访问权限的应用资产ID集合", "example": "[8,9]", "item_type": "integer" }, { "name": "Status", "type": "integer", "required": false, "description": "访问权限状态，1 - 已生效，2 - 未生效，3 - 已过期", "example": "0" }, { "name": "StatusSet", "type": "array", "required": false, "description": "访问权限状态，1 - 已生效，2 - 未生效，3 - 已过期", "example": "[1,2]", "item_type": "integer" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "部门ID，用于过滤属于某个部门的访问权限", "example": "1.2.3" }, { "name": "ExactAccount", "type": "boolean", "required": false, "description": "是否根据AuthorizedDeviceIdSet,对资产账号进行精确匹配，默认false, 设置true时，确保AuthorizedDeviceIdSet只有一个元素", "example": "false" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤数组", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "\"InstanceId\"" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"ext-19b6c9ece7-8cb8-1\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeAssetSyncFlag", "description": "查询资产自动同步开关", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAssetSyncStatus", "description": "查询资产同步状态", "status": "online", "parameters": [ { "name": "Category", "type": "integer", "required": true, "description": "查询的资产同步类型。1 -主机资产， 2 - 数据库资产", "example": "1" } ], "required": [ "Category" ] }, { "name": "DescribeChangePwdTask", "description": "查询改密任务列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤数组。过滤数组。Name支持以下值: OperationId 任务ID TaskName 任务名", "example": "[{\"Name\": \"TaskName\", \"Values\": [\"task1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "\"InstanceId\"" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"ext-19b6c9ece7-8cb8-1\"]", "item_type": "string" } ] }, { "name": "DepartmentId", "type": "string", "required": false, "description": "所属部门ID", "example": "\"1,2\"" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，默认20", "example": "20" } ], "required": [] }, { "name": "DescribeChangePwdTaskDetail", "description": "查询改密任务详情", "status": "online", "parameters": [ { "name": "OperationId", "type": "string", "required": true, "description": "改密任务Id", "example": "ops-bhtest" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "所属部门ID，如：“1.2.3”", "example": "\"1,2\"" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤数组，支持：InstanceId 资产ID，DeviceName 资产名称，Ip 内外IP，Account 资产账号，LastChangeStatus 上次改密状态。", "example": "[{\"Name\": \"InstanceId\", \"Values\": [\"ins-xxx\"]}，{\"Name\": \"InstanceId\", \"Values\": [\"ins-xxx\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "\"InstanceId\"" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"ext-19b6c9ece7-8cb8-1\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目。默认20", "example": "20" } ], "required": [ "OperationId" ] }, { "name": "DescribeCmdTemplates", "description": "查询命令模板列表", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": false, "description": "命令模板ID集合，非必需", "example": "[1,2]", "item_type": "integer" }, { "name": "Name", "type": "string", "required": false, "description": "命令模板名，模糊查询，最大长度64字符", "example": "CmdTempName" }, { "name": "Type", "type": "integer", "required": false, "description": "命令模板类型 1-内置模板 2-自定义模板", "example": "1" }, { "name": "TypeSet", "type": "array", "required": false, "description": "命令模板类型 1-内置模板 2-自定义模板", "example": "[1,2]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，默认20", "example": "10" } ], "required": [] }, { "name": "DescribeDepartments", "description": "查询部门信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDeviceAccounts", "description": "查询主机账号列表", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": false, "description": "主机账号ID集合，非必需，如果使用IdSet则忽略其他过滤参数", "example": "[1,2]", "item_type": "integer" }, { "name": "Account", "type": "string", "required": false, "description": "主机账号名，模糊查询，不能单独出现，必须于DeviceId一起提交", "example": "root" }, { "name": "DeviceId", "type": "integer", "required": false, "description": "主机ID，未使用IdSet时必须携带", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，默认20", "example": "10" } ], "required": [] }, { "name": "DescribeDeviceGroupMembers", "description": "查询资产组成员列表", "status": "online", "parameters": [ { "name": "Bound", "type": "boolean", "required": true, "description": "true - 查询已在该资产组的资产，false - 查询未在该资产组的资产", "example": "true" }, { "name": "Id", "type": "integer", "required": false, "description": "资产组ID，Id和IdSet二选一", "example": "1" }, { "name": "IdSet", "type": "array", "required": false, "description": "资产组ID集合，传Id，IdSet不生效。", "example": "[1,2,3]", "item_type": "integer" }, { "name": "Name", "type": "string", "required": false, "description": "资产名或资产IP，模糊查询", "example": "运维主机" }, { "name": "ResourceIdSet", "type": "array", "required": false, "description": "主机绑定的堡垒机服务ID集合 未绑定的通过Filters进行传递", "example": "[\"bh-sass-dhxaidaad\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数，默认20, 最大500", "example": "10" }, { "name": "Kind", "type": "integer", "required": false, "description": "资产类型，1 - Linux，2 - Windows，3 - MySQL，4 - SQLServer", "example": "1" }, { "name": "KindSet", "type": "array", "required": false, "description": "资产类型集合，1 - Linux，2 - Windows，3 - MySQL，4 - SQLServer", "example": "[1,2,3]", "item_type": "integer" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "所属部门ID", "example": "1.2.3" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件,支持 BindingStatus｜VpcId ｜InstanceId ｜DeviceAccount ｜ManageDimension｜DomainId｜Ip｜Name", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "\"InstanceId\"" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"ext-19b6c9ece7-8cb8-1\"]", "item_type": "string" } ] }, { "name": "TagFilters", "type": "array", "required": false, "description": "过滤条件，可按照标签键、标签进行过滤。如果同时指定标签键和标签过滤条件，它们之间为“AND”的关系", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "\"业务部门\"" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签值", "example": "[\"研发部\", \"运营部\"]", "item_type": "string" } ] } ], "required": [ "Bound" ] }, { "name": "DescribeDeviceGroups", "description": "查询资产组列表", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": false, "description": "资产组ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "Name", "type": "string", "required": false, "description": "资产组名，最长64个字符，模糊查询", "example": "bh-test-group" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，缺省20，最大500", "example": "10" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "部门ID，用于过滤属于某个部门的资产组", "example": "1.2.3" } ], "required": [] }, { "name": "DescribeDevices", "description": "查询资产列表", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": false, "description": "资产ID集合", "example": "[1,2,3]", "item_type": "integer" }, { "name": "Name", "type": "string", "required": false, "description": "资产名或资产IP，模糊查询", "example": "运维主机" }, { "name": "Ip", "type": "string", "required": false, "description": "暂未使用", "example": "192.168.0.3" }, { "name": "ApCodeSet", "type": "array", "required": false, "description": "地域码集合", "example": "[\"ap-guangzhou\"]", "item_type": "string" }, { "name": "Kind", "type": "integer", "required": false, "description": "操作系统类型, 1 - Linux, 2 - Windows, 3 - MySQL, 4 - SQLServer", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，默认20", "example": "10" }, { "name": "AuthorizedUserIdSet", "type": "array", "required": false, "description": "有该资产访问权限的用户ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "ResourceIdSet", "type": "array", "required": false, "description": "过滤条件，资产绑定的堡垒机服务ID集合", "example": "[\"bh-saas-test\"]", "item_type": "string" }, { "name": "KindSet", "type": "array", "required": false, "description": "可提供按照多种类型过滤, 1 - Linux, 2 - Windows, 3 - MySQL, 4 - SQLServer", "example": "[1,2]", "item_type": "integer" }, { "name": "ManagedAccount", "type": "string", "required": false, "description": "资产是否包含托管账号。1，包含；0，不包含", "example": "root" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "过滤条件，可按照部门ID进行过滤", "example": "1.2.3" }, { "name": "AccountIdSet", "type": "array", "required": false, "description": "资产所属云账号id", "example": "[2,3]", "item_type": "integer" }, { "name": "ProviderTypeSet", "type": "array", "required": false, "description": "云厂商类型，1-腾讯云，2-阿里云", "example": "[1]", "item_type": "integer" }, { "name": "CloudDeviceStatusSet", "type": "array", "required": false, "description": "同步的云资产状态，标记同步的资产的状态情况，0-已删除,1-正常,2-已隔离,3-已过期", "example": "[1,2]", "item_type": "integer" }, { "name": "TagFilters", "type": "array", "required": false, "description": "过滤条件，可按照标签键、标签进行过滤。如果同时指定标签键和标签过滤条件，它们之间为“AND”的关系", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "\"业务部门\"" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签值", "example": "[\"研发部\", \"运营部\"]", "item_type": "string" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "过滤数组。支持的Name： BindingStatus 绑定状态", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "\"InstanceId\"" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"ext-19b6c9ece7-8cb8-1\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeDomains", "description": "查询网络域", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，默认20，最大500", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤数组", "example": "[\"Name\":\"DomainId\",\"Values\":[\"net-default\"]]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "\"InstanceId\"" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"ext-19b6c9ece7-8cb8-1\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" } ], "required": [] }, { "name": "DescribeLDAPUnitSet", "description": "获取LDAP ou 列表", "status": "online", "parameters": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否开启LDAP认证，true-开启", "example": "true" }, { "name": "Ip", "type": "string", "required": true, "description": "服务器地址", "example": "10.10.10.1" }, { "name": "Port", "type": "integer", "required": true, "description": "服务端口", "example": "389" }, { "name": "EnableSSL", "type": "boolean", "required": true, "description": "是否开启SSL，false-不开启，true-开启", "example": "true" }, { "name": "BaseDN", "type": "string", "required": true, "description": "Base DN", "example": "bh-test-DN" }, { "name": "AdminAccount", "type": "string", "required": true, "description": "管理员账号", "example": "admin" }, { "name": "AdminPassword", "type": "string", "required": true, "description": "管理员密码", "example": "pwd" }, { "name": "AttributeUserName", "type": "string", "required": true, "description": "用户名映射属性", "example": "attr-user-name" }, { "name": "AttributeUnit", "type": "string", "required": true, "description": "部门过滤", "example": "bh-attr-test" }, { "name": "IpBackup", "type": "string", "required": false, "description": "备用服务器地址", "example": "10.10.10.2" }, { "name": "DomainId", "type": "string", "required": false, "description": "网络域Id", "example": "net-default" } ], "required": [ "Enable", "Ip", "Port", "EnableSSL", "BaseDN", "AdminAccount", "AdminPassword", "AttributeUserName", "AttributeUnit" ] }, { "name": "DescribeLoginEvent", "description": "查询登录日志", "status": "online", "parameters": [ { "name": "UserName", "type": "string", "required": false, "description": "用户名，如果不包含其他条件时对user_name or real_name两个字段模糊查询", "example": "zhangsan" }, { "name": "RealName", "type": "string", "required": false, "description": "姓名，模糊查询", "example": "张三" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询时间范围，起始时间", "example": "2021-02-04T15:23:52+08:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询时间范围，结束时间", "example": "2021-02-04T15:23:52+08:00" }, { "name": "SourceIp", "type": "string", "required": false, "description": "来源IP，模糊查询", "example": "10.0.0.1" }, { "name": "Entry", "type": "integer", "required": false, "description": "登录入口：1-字符界面,2-图形界面，3-web页面, 4-API", "example": "1" }, { "name": "EntrySet", "type": "array", "required": false, "description": "登录入口：1-字符界面,2-图形界面，3-web页面, 4-API", "example": "[1,2]", "item_type": "integer" }, { "name": "Result", "type": "integer", "required": false, "description": "操作结果，1-成功，2-失败", "example": "1" }, { "name": "ResultSet", "type": "array", "required": false, "description": "操作结果，1-成功，2-失败", "example": "[1,2]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页每页记录数，默认20", "example": "20" } ], "required": [] }, { "name": "DescribeOperationEvent", "description": "查询操作日志", "status": "online", "parameters": [ { "name": "UserName", "type": "string", "required": false, "description": "用户名，如果不包含其他条件时对user_name or real_name两个字段模糊查询", "example": "zhangsan" }, { "name": "RealName", "type": "string", "required": false, "description": "姓名，模糊查询", "example": "张三" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询时间范围，起始时间", "example": "2021-02-04T15:23:52+08:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询时间范围，结束时间", "example": "2021-02-04T15:23:52+08:00" }, { "name": "SourceIp", "type": "string", "required": false, "description": "来源IP，模糊查询", "example": "1.0.0.1" }, { "name": "Kind", "type": "integer", "required": false, "description": "操作类型，参考DescribeOperationType返回结果", "example": "100" }, { "name": "KindSet", "type": "array", "required": false, "description": "操作类型，参考DescribeOperationType返回结果", "example": "[100,300]", "item_type": "integer" }, { "name": "Result", "type": "integer", "required": false, "description": "操作结果，1-成功，2-失败", "example": "1" }, { "name": "ResultSet", "type": "array", "required": false, "description": "操作结果，1-成功，2-失败", "example": "[1,2]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页每页记录数，默认20", "example": "20" } ], "required": [] }, { "name": "DescribeOperationTask", "description": "获取运维任务列表", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "运维任务名称", "example": "测试运维任务\t" }, { "name": "Type", "type": "integer", "required": false, "description": "运维任务类型，1 - 手工执行任务， 2 - 周期性任务", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数，默认20", "example": "20" } ], "required": [] }, { "name": "DescribeResources", "description": "查询用户购买的堡垒机服务信息，包括资源ID、授权点数、VPC、过期时间等。", "status": "online", "parameters": [ { "name": "ApCode", "type": "string", "required": false, "description": "地域码, 如: ap-guangzhou", "example": "ap-guangzhou" }, { "name": "VpcId", "type": "string", "required": false, "description": "按照堡垒机开通的 VPC 实例ID查询", "example": "vpc-9juy78n" }, { "name": "ResourceIds", "type": "array", "required": false, "description": "资源ID集合，当传入ID集合时忽略 ApCode 和 VpcId", "example": "[\"bh-saas-8jy7jg\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置", "example": "0" } ], "required": [] }, { "name": "DescribeSecuritySetting", "description": "查询安全配置信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSourceTypes", "description": "获取认证源信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeUserDirectory", "description": "获取用户目录", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "分页大小", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移", "example": "0" } ], "required": [] }, { "name": "DescribeUserGroupMembers", "description": "查询用户组成员列表", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "用户组ID", "example": "1" }, { "name": "Bound", "type": "boolean", "required": true, "description": "true - 查询已添加到该用户组的用户，false - 查询未添加到该用户组的用户", "example": "true" }, { "name": "Name", "type": "string", "required": false, "description": "用户名或用户姓名，最长64个字符，模糊查询", "example": "zhangsan" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，默认20, 最大500", "example": "10" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "所属部门ID", "example": "1.2" } ], "required": [ "Id", "Bound" ] }, { "name": "DescribeUserGroups", "description": "查询用户组列表", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": false, "description": "用户组ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "Name", "type": "string", "required": false, "description": "用户组名，模糊查询,长度：0-64字符", "example": "运维组" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，缺省20，最大500", "example": "10" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "部门ID，用于过滤属于某个部门的用户组", "example": "1.2.3" } ], "required": [] }, { "name": "DescribeUserSyncStatus", "description": "获取用户同步状态", "status": "online", "parameters": [ { "name": "UserKind", "type": "integer", "required": true, "description": "获取用户同步状态， 1-获取ioa用户同步状态", "example": "1" } ], "required": [ "UserKind" ] }, { "name": "DescribeUsers", "description": "查询用户列表", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": false, "description": "如果IdSet不为空，则忽略其他参数", "example": "[1,2]", "item_type": "integer" }, { "name": "Name", "type": "string", "required": false, "description": "模糊查询，IdSet、UserName、Phone为空时才生效，对用户名和姓名进行模糊查询", "example": "zhangsan" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页条目数量，默认20, 最大500", "example": "10" }, { "name": "UserName", "type": "string", "required": false, "description": "精确查询，IdSet为空时才生效", "example": "zhangsan" }, { "name": "Phone", "type": "string", "required": false, "description": "精确查询，IdSet、UserName为空时才生效。 大陆手机号直接填写，如果是其他国家、地区号码,按照\"国家地区代码|手机号\"的格式输入。如: \"+852|xxxxxxxx\"", "example": "1980***76" }, { "name": "Email", "type": "string", "required": false, "description": "邮箱，精确查询", "example": "109****@qq.com" }, { "name": "AuthorizedDeviceIdSet", "type": "array", "required": false, "description": "查询具有指定资产ID访问权限的用户", "example": "[1,2]", "item_type": "integer" }, { "name": "AuthorizedAppAssetIdSet", "type": "array", "required": false, "description": "查询具有指定应用资产ID访问权限的用户", "example": "[1,2]", "item_type": "integer" }, { "name": "AuthTypeSet", "type": "array", "required": false, "description": "认证方式，0 - 本地, 1 - LDAP, 2 - OAuth, 3-ioa 不传为全部", "example": "[0,1]", "item_type": "integer" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "部门ID，用于过滤属于某个部门的用户", "example": "1.2.3" }, { "name": "Filters", "type": "array", "required": false, "description": "参数过滤数组", "example": "[\"Name\":\"Status\",\"Values\":[\"Locked\"]]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "\"InstanceId\"" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"ext-19b6c9ece7-8cb8-1\"]", "item_type": "string" } ] }, { "name": "IsCamUser", "type": "integer", "required": false, "description": "是否获取cam用户, 0-否，1-是", "example": "1" }, { "name": "UserFromSet", "type": "array", "required": false, "description": "用户来源，0-bh，1-ioa,不传为全部", "example": "[1]", "item_type": "integer" } ], "required": [] }, { "name": "DisableExternalAccess", "description": "关闭公网访问堡垒机", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "堡垒机id", "example": "bh-saas-sdafwe3e" } ], "required": [ "ResourceId" ] }, { "name": "DisableIntranetAccess", "description": "关闭内网访问", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": false, "description": "堡垒机id", "example": "bh-saas-sdafwe3e" } ], "required": [] }, { "name": "EnableExternalAccess", "description": "开启公网访问堡垒机", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "堡垒机id", "example": "bh-saas-sdafwe3e" } ], "required": [ "ResourceId" ] }, { "name": "EnableIntranetAccess", "description": "开通内网访问", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": false, "description": "堡垒机实例id", "example": "bh-saas-ssafee1d" }, { "name": "VpcId", "type": "string", "required": false, "description": "开通内网访问的vpc id", "example": "vpc-dfawsdae" }, { "name": "VpcCidrBlock", "type": "string", "required": false, "description": "vpc的网段", "example": "10.0.0.0/0" }, { "name": "SubnetId", "type": "string", "required": false, "description": "开通内网访问的subnet id", "example": "subnet-weafawe" }, { "name": "DomainName", "type": "string", "required": false, "description": "内网ip的自定义域名，可为空", "example": "test.com" } ], "required": [] }, { "name": "ImportExternalDevice", "description": "导入外部资产信息", "status": "online", "parameters": [ { "name": "DeviceSet", "type": "array", "required": true, "description": "资产参数列表", "example": "无", "item_type": "object", "children": [ { "name": "OsName", "type": "string", "required": true, "description": "操作系统名称，只能是主机（Linux、Windows）、数据库（MySQL、SQL Server、MariaDB、PostgreSQL、MongoDBReplicaSet、MongoDBSharded、Redis）、容器（TKE、EKS）", "example": "Linux" }, { "name": "Ip", "type": "string", "required": true, "description": "IP地址", "example": "192.168.0.1" }, { "name": "Port", "type": "integer", "required": true, "description": "管理端口", "example": "22" }, { "name": "Name", "type": "string", "required": false, "description": "主机名，可为空", "example": "Instance-name" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "资产所属的部门ID", "example": "1.2.3" }, { "name": "IpPortSet", "type": "array", "required": false, "description": "资产多节点：字段ip和端口", "example": "[\"127.0.0.1:2001\",\"127.0.0.1:2002\"]", "item_type": "string" }, { "name": "EnableSSL", "type": "integer", "required": false, "description": "是否启用SSL,1:启用 0：禁用，仅支持Redis资产", "example": "1" }, { "name": "SSLCert", "type": "string", "required": false, "description": "SSL证书，EnableSSL时必填", "example": "true" }, { "name": "SSLCertName", "type": "string", "required": false, "description": "SSL证书名称，EnableSSL时必填", "example": "bh-redis-test.crt" }, { "name": "InstanceId", "type": "string", "required": false, "description": "资产实例id", "example": "ins-dftadff" }, { "name": "ApCode", "type": "string", "required": false, "description": "资产所属地域", "example": "ap-guangzhou" }, { "name": "ApName", "type": "string", "required": false, "description": "地域名称", "example": "广州" }, { "name": "VpcId", "type": "string", "required": false, "description": "资产所属VPC", "example": "vpc-sduahd" }, { "name": "SubnetId", "type": "string", "required": false, "description": "资产所属子网", "example": "subnet-duhxse" }, { "name": "PublicIp", "type": "string", "required": false, "description": "公网IP", "example": "192.182.23.23" } ] }, { "name": "AccountId", "type": "integer", "required": false, "description": "资产所属云账号id", "example": "1" } ], "required": [ "DeviceSet" ] }, { "name": "ModifyAccessWhiteListAutoStatus", "description": "修改访问白名单自动添加IP状态：开启或关闭自动添加IP", "status": "online", "parameters": [ { "name": "AllowAuto", "type": "boolean", "required": true, "description": "true：放开自动添加IP；false：不放开自动添加IP", "example": "true" } ], "required": [ "AllowAuto" ] }, { "name": "ModifyAccessWhiteListRule", "description": "修改访问白名单规则", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "白名单规则ID", "example": "1" }, { "name": "Source", "type": "string", "required": true, "description": "ip或网段信息，如10.10.10.1或10.10.10.0/24，最大长度40字节", "example": "10.10.10.1" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息，最大长度64字符。", "example": "规则1" } ], "required": [ "Id", "Source" ] }, { "name": "ModifyAccessWhiteListStatus", "description": "修改访问白名单状态：开启或关闭放开全部来源IP。", "status": "online", "parameters": [ { "name": "AllowAny", "type": "boolean", "required": true, "description": "true：放开全部来源IP；false：不放开全部来源IP", "example": "true" } ], "required": [ "AllowAny" ] }, { "name": "ModifyAcl", "description": "修改访问权限", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "访问权限名称，最大32字符，不能包含空白字符", "example": "test-acl" }, { "name": "AllowDiskRedirect", "type": "boolean", "required": true, "description": "是否开启磁盘映射", "example": "true" }, { "name": "AllowAnyAccount", "type": "boolean", "required": true, "description": "是否允许任意账号登录", "example": "false" }, { "name": "Id", "type": "integer", "required": true, "description": "访问权限ID", "example": "1" }, { "name": "AllowClipFileUp", "type": "boolean", "required": false, "description": "是否开启剪贴板文件上行", "example": "true" }, { "name": "AllowClipFileDown", "type": "boolean", "required": false, "description": "是否开启剪贴板文件下行", "example": "true" }, { "name": "AllowClipTextUp", "type": "boolean", "required": false, "description": "是否开启剪贴板文本（含图片）上行", "example": "true" }, { "name": "AllowClipTextDown", "type": "boolean", "required": false, "description": "是否开启剪贴板文本（含图片）下行", "example": "true" }, { "name": "AllowFileUp", "type": "boolean", "required": false, "description": "是否开启文件传输上传", "example": "true" }, { "name": "MaxFileUpSize", "type": "integer", "required": false, "description": "文件传输上传大小限制（预留参数，目前暂未使用）", "example": "1" }, { "name": "AllowFileDown", "type": "boolean", "required": false, "description": "是否开启文件传输下载", "example": "true" }, { "name": "MaxFileDownSize", "type": "integer", "required": false, "description": "文件传输下载大小限制（预留参数，目前暂未使用）", "example": "1" }, { "name": "UserIdSet", "type": "array", "required": false, "description": "关联的用户ID", "example": "[1]", "item_type": "integer" }, { "name": "UserGroupIdSet", "type": "array", "required": false, "description": "关联的用户组ID", "example": "[1]", "item_type": "integer" }, { "name": "DeviceIdSet", "type": "array", "required": false, "description": "关联的资产ID", "example": "[1]", "item_type": "integer" }, { "name": "AppAssetIdSet", "type": "array", "required": false, "description": "关联的应用资产ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "DeviceGroupIdSet", "type": "array", "required": false, "description": "关联的资产组ID", "example": "[1]", "item_type": "integer" }, { "name": "AccountSet", "type": "array", "required": false, "description": "关联的账号", "example": "[\"admin\"]", "item_type": "string" }, { "name": "CmdTemplateIdSet", "type": "array", "required": false, "description": "关联的高危命令模板ID", "example": "[1]", "item_type": "integer" }, { "name": "ACTemplateIdSet", "type": "array", "required": false, "description": "关联高危DB模板ID", "example": "[\"1\"]", "item_type": "string" }, { "name": "AllowDiskFileUp", "type": "boolean", "required": false, "description": "是否开启 RDP 磁盘映射文件上传", "example": "true" }, { "name": "AllowDiskFileDown", "type": "boolean", "required": false, "description": "是否开启 RDP 磁盘映射文件下载", "example": "true" }, { "name": "AllowShellFileUp", "type": "boolean", "required": false, "description": "是否开启rz sz文件上传", "example": "true" }, { "name": "AllowShellFileDown", "type": "boolean", "required": false, "description": "是否开启rz sz文件下载", "example": "true" }, { "name": "AllowFileDel", "type": "boolean", "required": false, "description": "是否开启 SFTP 文件删除", "example": "true" }, { "name": "ValidateFrom", "type": "string", "required": false, "description": "访问权限生效时间，如:\"2021-09-22T00:00:00+00:00\" 生效、失效时间不填则访问权限长期有效", "example": "2021-02-04T15:23:52+08:00" }, { "name": "ValidateTo", "type": "string", "required": false, "description": "访问权限失效时间，如:\"2021-09-23T00:00:00+00:00\" 生效、失效时间不填则访问权限长期有效", "example": "2021-02-04T15:23:52+08:00" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "权限所属部门的ID，如：1.2.3", "example": "1.2.3" }, { "name": "AllowAccessCredential", "type": "boolean", "required": false, "description": "是否允许使用访问串", "example": "true" }, { "name": "AllowKeyboardLogger", "type": "boolean", "required": false, "description": "是否允许键盘记录", "example": "false" } ], "required": [ "Name", "AllowDiskRedirect", "AllowAnyAccount", "Id" ] }, { "name": "ModifyAssetSyncFlag", "description": "修改资产自动同步开关", "status": "online", "parameters": [ { "name": "AutoSync", "type": "boolean", "required": true, "description": "是否开启资产自动同步，false-不开启，true-开启", "example": "true" } ], "required": [ "AutoSync" ] }, { "name": "ModifyAuthModeSetting", "description": "修改认证方式配置信息", "status": "online", "parameters": [ { "name": "AuthMode", "type": "integer", "required": false, "description": "双因子认证，0-不开启（暂停使用），1-OTP，2-短信，3-USB Key（只有ResourceType=1且AuthModeGM不传时有效，其他情况不能为3） 备注：AuthMode和AuthModeGM至少有一个有效传参", "example": "1" }, { "name": "AuthModeGM", "type": "integer", "required": false, "description": "国密双因子认证，0-不开启（暂停使用），1-OTP，2-短信，3-USB Key 备注：AuthMode和AuthModeGM至少有一个有效传参，AuthModeGM优先级高于ResourceType", "example": "2" }, { "name": "ResourceType", "type": "integer", "required": false, "description": "资源类型，0：普通（暂停使用，由AuthMode和AuthModeGM传参决定） 1：国密", "example": "0" } ], "required": [] }, { "name": "ModifyChangePwdTask", "description": "更新修改密码任务", "status": "online", "parameters": [ { "name": "OperationId", "type": "string", "required": true, "description": "改密任务id", "example": "ops-111111" }, { "name": "DeviceIdSet", "type": "array", "required": true, "description": "改密资产id列表", "example": "[1,2,3]", "item_type": "integer" }, { "name": "AccountSet", "type": "array", "required": true, "description": "改密资产的账号列表", "example": "[\"root\",\"user\"]", "item_type": "string" }, { "name": "ModifyType", "type": "integer", "required": true, "description": "修改类型：1：修改任务信息 2：关联任务资产账号", "example": "1" }, { "name": "ChangeMethod", "type": "integer", "required": true, "description": "改密方式。1：使用执行账号修改密码；2：修改自身密码", "example": "1" }, { "name": "AuthGenerationStrategy", "type": "integer", "required": true, "description": "密码生成方式。 1:自动生成相同密码 2:自动生成不同密码 3:手动指定相同密码", "example": "1" }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称", "example": "bh-task" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "所属部门ID，\"1,2,3\"", "example": "1.2" }, { "name": "RunAccount", "type": "string", "required": false, "description": "任务的执行账号", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "密码，手动指定密码时必传。", "example": "pwd" }, { "name": "PasswordLength", "type": "integer", "required": false, "description": "密码限制长度，自动生成密码必传。", "example": "12" }, { "name": "SmallLetter", "type": "integer", "required": false, "description": "密码包含小写字母，0：否，1：是。", "example": "1" }, { "name": "BigLetter", "type": "integer", "required": false, "description": "密码包含大写字母，0：否，1：是。", "example": "1" }, { "name": "Digit", "type": "integer", "required": false, "description": "密码包含数字，0：否，1：是。", "example": "1" }, { "name": "Symbol", "type": "string", "required": false, "description": "密码包含的特殊字符（base64编码），包含：^[-_#();%~!+=]*$", "example": "ISMkJQ==" }, { "name": "CompleteNotify", "type": "integer", "required": false, "description": "改密完成通知。0：不通知 1：通知", "example": "1" }, { "name": "NotifyEmails", "type": "array", "required": false, "description": "通知邮箱", "example": "[\"123@qq.com\",\"234@qq.com\"]", "item_type": "string" }, { "name": "FilePassword", "type": "string", "required": false, "description": "加密压缩文件密码", "example": "filepwd" }, { "name": "Type", "type": "integer", "required": false, "description": "任务类型， 4：手工执行 5：周期自动执行", "example": "4" }, { "name": "Period", "type": "integer", "required": false, "description": "周期任务周期，单位天（大于等于 1，小于等于 365）", "example": "7" }, { "name": "FirstTime", "type": "string", "required": false, "description": "周期任务首次执行时间", "example": "2020-12-20T19:51:23+08:00" } ], "required": [ "OperationId", "DeviceIdSet", "AccountSet", "ModifyType", "ChangeMethod", "AuthGenerationStrategy" ] }, { "name": "ModifyCmdTemplate", "description": "修改高危命令模板", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "模板名，最长32字符，不能包含空白字符", "example": "test-name" }, { "name": "CmdList", "type": "string", "required": true, "description": "命令列表，\\n分隔，最长32768字节", "example": "rm -f" }, { "name": "Id", "type": "integer", "required": true, "description": "命令模板ID", "example": "1" }, { "name": "Encoding", "type": "integer", "required": false, "description": "CmdList字段前端是否base64传值。 0：否，1：是", "example": "0" }, { "name": "Type", "type": "integer", "required": false, "description": "命令模板类型 1-内置模板 2-自定义模板", "example": "1" } ], "required": [ "Name", "CmdList", "Id" ] }, { "name": "ModifyDevice", "description": "修改资产信息", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "资产记录ID", "example": "1" }, { "name": "Port", "type": "integer", "required": false, "description": "管理端口", "example": "22" }, { "name": "GroupIdSet", "type": "array", "required": false, "description": "资产所属组ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "资产所属部门ID", "example": "1.2.3" }, { "name": "DomainId", "type": "string", "required": false, "description": "网络域Id", "example": "net-default" } ], "required": [ "Id" ] }, { "name": "ModifyDeviceGroup", "description": "修改资产组", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "资产组名，最大长度32字符，不能为空", "example": "device-name" }, { "name": "Id", "type": "integer", "required": true, "description": "资产组ID", "example": "1" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "资产组所属部门ID，如：1.2.3", "example": "1.2.3" } ], "required": [ "Name", "Id" ] }, { "name": "ModifyLDAPSetting", "description": "修改LDAP配置信息", "status": "online", "parameters": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否开启LDAP认证，false-不开启，true-开启", "example": "true" }, { "name": "Ip", "type": "string", "required": false, "description": "服务器地址", "example": "10.10.10.1" }, { "name": "IpBackup", "type": "string", "required": false, "description": "备用服务器地址", "example": "10.10.10.2" }, { "name": "Port", "type": "integer", "required": false, "description": "服务端口", "example": "389" }, { "name": "EnableSSL", "type": "boolean", "required": false, "description": "是否开启SSL，false-不开启，true-开启", "example": "true" }, { "name": "BaseDN", "type": "string", "required": false, "description": "Base DN", "example": "base-dn" }, { "name": "AdminAccount", "type": "string", "required": false, "description": "管理员账号", "example": "admin" }, { "name": "AdminPassword", "type": "string", "required": false, "description": "管理员密码", "example": "adminpwd" }, { "name": "AttributeUser", "type": "string", "required": false, "description": "用户属性", "example": "attr-user" }, { "name": "AttributeUserName", "type": "string", "required": false, "description": "用户名属性", "example": "attr-username" }, { "name": "AutoSync", "type": "boolean", "required": false, "description": "自动同步，false-不开启，true-开启", "example": "true" }, { "name": "Overwrite", "type": "boolean", "required": false, "description": "覆盖用户信息，false-不开启，true-开启", "example": "true" }, { "name": "SyncPeriod", "type": "integer", "required": false, "description": "同步周期，30～60000之间的整数", "example": "30" }, { "name": "SyncAll", "type": "boolean", "required": false, "description": "是否同步全部，false-不开启，true-开启", "example": "true" }, { "name": "SyncUnitSet", "type": "array", "required": false, "description": "同步OU列表，SyncAll为false时必传", "example": "[\"ou=GGG,dc=my-domain,dc=com\"]", "item_type": "string" }, { "name": "AttributeUnit", "type": "string", "required": false, "description": "组织单元属性", "example": "unit" }, { "name": "AttributeRealName", "type": "string", "required": false, "description": "用户姓名属性", "example": "realname" }, { "name": "AttributePhone", "type": "string", "required": false, "description": "手机号属性", "example": "phone" }, { "name": "AttributeEmail", "type": "string", "required": false, "description": "邮箱属性", "example": "email" }, { "name": "DomainId", "type": "string", "required": false, "description": "网络域Id", "example": "net-default" } ], "required": [ "Enable" ] }, { "name": "ModifyOAuthSetting", "description": "设置OAuth认证参数", "status": "online", "parameters": [ { "name": "Enable", "type": "boolean", "required": true, "description": "是否开启OAuth认证，false-不开启，true-开启。", "example": "true" }, { "name": "AuthMethod", "type": "string", "required": false, "description": "OAuth认证方式。", "example": "okta" }, { "name": "ClientId", "type": "string", "required": false, "description": "OAuth认证客户端Id", "example": "client-id" }, { "name": "ClientSecret", "type": "string", "required": false, "description": "OAuth认证客户端密钥", "example": "client-secret" }, { "name": "CodeUrl", "type": "string", "required": false, "description": "获取OAuth认证授权码URL", "example": "https://some-url/oauth2/v1/authorize" }, { "name": "TokenUrl", "type": "string", "required": false, "description": "获取OAuth令牌URL", "example": "https://some-url/oauth2/v1/token" }, { "name": "UserInfoUrl", "type": "string", "required": false, "description": "获取OAuth用户信息URL", "example": "https://some-url/oauth2/v1/userinfo" }, { "name": "Scopes", "type": "array", "required": false, "description": "使用Okta认证时指定范围。为空时默认使用 openid、profile、email。", "example": "[\"email\"]", "item_type": "string" } ], "required": [ "Enable" ] }, { "name": "ModifyOperationTask", "description": "修改运维任务", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "任务Id", "example": "2" }, { "name": "Name", "type": "string", "required": true, "description": "任务名称", "example": "test_ssh" }, { "name": "Type", "type": "integer", "required": true, "description": "任务类型, 1 - 手工执行, 2 - 周期性自动执行", "example": "1" }, { "name": "Account", "type": "string", "required": true, "description": "执行账号", "example": "ubuntu" }, { "name": "Timeout", "type": "integer", "required": true, "description": "超时时间,单位秒", "example": "5" }, { "name": "Script", "type": "string", "required": true, "description": "执行脚本内容", "example": "ls" }, { "name": "DeviceIdSet", "type": "array", "required": true, "description": "执行主机集合，满足条件以下三个条件：1. 资产绑定可用的专业版或国密版堡垒机服务；2、资产类型为linux资产；3、用户具有资产权限，且资产添加了指定执行账号", "example": "[1,3]", "item_type": "integer" }, { "name": "Period", "type": "integer", "required": false, "description": "执行间隔，单位天. 手工执行时无需传入", "example": "2" }, { "name": "FirstTime", "type": "string", "required": false, "description": "首次执行日期，默认1970-01-01T08:00:01+08:00,手工执行时无需传入", "example": "1970-01-01T08:00:01+08:00" }, { "name": "Encoding", "type": "integer", "required": false, "description": "Script参数是否需要进行base64编码后传递，1-需要进行base64编码后传递，非1值-不需要进行base64编码后传递", "example": "1" } ], "required": [ "Id", "Name", "Type", "Account", "Timeout", "Script", "DeviceIdSet" ] }, { "name": "ModifyReconnectionSetting", "description": "修改运维资产连接重连次数", "status": "online", "parameters": [ { "name": "ReconnectionMaxCount", "type": "integer", "required": true, "description": "重试次数,取值范围：0-20", "example": "0" }, { "name": "Enable", "type": "boolean", "required": true, "description": "true：限制重连次数，false：不限制重连次数", "example": "true" } ], "required": [ "ReconnectionMaxCount", "Enable" ] }, { "name": "ModifyResource", "description": "资源变配", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "需要开通服务的资源ID", "example": "bh-saas-9jasuf" }, { "name": "ResourceEdition", "type": "string", "required": false, "description": "实例版本", "example": "standard" }, { "name": "ResourceNode", "type": "integer", "required": false, "description": "资源节点数", "example": "50" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费", "example": "1" }, { "name": "PackageBandwidth", "type": "integer", "required": false, "description": "带宽扩展包个数(4M)", "example": "1" }, { "name": "PackageNode", "type": "integer", "required": false, "description": "授权点数扩展包个数(50点)", "example": "1" }, { "name": "LogDelivery", "type": "integer", "required": false, "description": "日志投递", "example": "1" } ], "required": [ "ResourceId" ] }, { "name": "ModifyUser", "description": "修改用户信息", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "用户ID", "example": "1" }, { "name": "RealName", "type": "string", "required": true, "description": "用户姓名，最大长度20个字符，不能包含空格", "example": "zhangsan" }, { "name": "Phone", "type": "string", "required": false, "description": "按照\"国家地区代码|手机号\"的格式输入。如: \"+86|xxxxxxxx\"", "example": "+86|133****" }, { "name": "Email", "type": "string", "required": false, "description": "电子邮件", "example": "198***@qq.com" }, { "name": "ValidateFrom", "type": "string", "required": false, "description": "用户生效时间，如:\"2021-09-22T00:00:00+00:00\" 生效、失效时间不填则用户长期有效", "example": "2021-01-01T08:00:01+08:00" }, { "name": "ValidateTo", "type": "string", "required": false, "description": "用户失效时间，如:\"2021-09-23T00:00:00+00:00\" 生效、失效时间不填则用户长期有效", "example": "2021-01-01T08:00:01+08:00" }, { "name": "GroupIdSet", "type": "array", "required": false, "description": "所属用户组ID集合", "example": "[1,2]", "item_type": "integer" }, { "name": "AuthType", "type": "integer", "required": false, "description": "认证方式，0 - 本地，1 - LDAP，2 - OAuth 不传则默认为0", "example": "0" }, { "name": "ValidateTime", "type": "string", "required": false, "description": "访问时间段限制， 由0、1组成的字符串，长度168(7 × 24)，代表该用户在一周中允许访问的时间段。字符串中第N个字符代表在一周中的第N个小时， 0 - 代表不允许访问，1 - 代表允许访问", "example": "0000000000000000000000000000000000000000000000000000000000000000" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "用户所属部门的ID，如1.2.3", "example": "1.2.3" } ], "required": [ "Id", "RealName" ] }, { "name": "ModifyUserDirectory", "description": "修改用户目录信息", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "目录id", "example": "3" }, { "name": "UserOrgSet", "type": "array", "required": true, "description": "ioa分组信息", "example": "[{\"OrgId\":47723,\"OrgName\":\"开发部\"\"}]", "item_type": "object", "children": [ { "name": "OrgId", "type": "integer", "required": true, "description": "ioa用户组织id", "example": "85232" }, { "name": "OrgName", "type": "string", "required": true, "description": "ioa用户组织名称", "example": "钉钉" }, { "name": "OrgIdPath", "type": "string", "required": true, "description": "ioa用户组织id路径", "example": "1233.85232.45245" }, { "name": "OrgNamePath", "type": "string", "required": true, "description": "ioa用户组织名称路径", "example": "全网账户.钉钉.开发部" }, { "name": "UserTotal", "type": "integer", "required": false, "description": "ioa用户组织id下的用户数", "example": "21" } ] } ], "required": [ "Id", "UserOrgSet" ] }, { "name": "ModifyUserGroup", "description": "修改用户组", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "用户组ID", "example": "1" }, { "name": "Name", "type": "string", "required": true, "description": "用户组名", "example": "运维组" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "用户组所属的部门ID，如：1.2.3", "example": "1.2.3" } ], "required": [ "Id", "Name" ] }, { "name": "ReplaySession", "description": "会话回放", "status": "online", "parameters": [ { "name": "Sid", "type": "string", "required": true, "description": "会话Sid", "example": "d6021542-c198-4d6f-a1fd-a8091544847c" } ], "required": [ "Sid" ] }, { "name": "ResetDeviceAccountPassword", "description": "清除设备账号绑定密码", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "ID集合", "example": "[1,2]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "ResetDeviceAccountPrivateKey", "description": "清除设备账号绑定的密钥", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "ID集合", "example": "[1,3]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "ResetUser", "description": "重置用户", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "用户ID集合", "example": "[1]", "item_type": "integer" } ], "required": [ "IdSet" ] }, { "name": "RunChangePwdTask", "description": "执行改密任务", "status": "online", "parameters": [ { "name": "OperationId", "type": "string", "required": true, "description": "任务Id", "example": "op-9asdu2n" }, { "name": "DepartmentId", "type": "string", "required": false, "description": "部门id", "example": "1.2" }, { "name": "Details", "type": "array", "required": false, "description": "改密任务详情", "example": "[{\"DeviceId\":100,\"Account\":\"admin1\"},{\"DeviceId\":100,\"Account\":\"admin2\"},{\"DeviceId\":200,\"Account\":\"admin1\"}]", "item_type": "object", "children": [ { "name": "DeviceId", "type": "integer", "required": true, "description": "资产id", "example": "ext-19b6c9ece7-8cb8-1" }, { "name": "Account", "type": "string", "required": true, "description": "资产账号", "example": "root" } ] } ], "required": [ "OperationId" ] }, { "name": "RunOperationTask", "description": "执行运维任务", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "运维任务ID", "example": "3" } ], "required": [ "Id" ] }, { "name": "SearchAuditLog", "description": "搜索审计日志", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，不得早于当前时间的180天前", "example": "2020-01-01T01:01:01Z" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2020-01-01T01:01:01Z" }, { "name": "OperationSet", "type": "array", "required": false, "description": "操作类型", "example": "[1,2,3,4,5,6,7]", "item_type": "integer" }, { "name": "ProtocolSet", "type": "array", "required": false, "description": "会话类型", "example": "[\"SSH\",\"RDP\",\"SFTP\",\"DB\",\"App\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页容量，默认为20，最大200", "example": "5" } ], "required": [ "StartTime" ] }, { "name": "SearchCommand", "description": "命令执行检索", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "搜索区间的开始时间", "example": "2020-01-02T01:01:01+08:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "搜索区间的结束时间，不填默认为开始时间到现在为止", "example": "2020-01-03T01:01:01+08:00" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名", "example": "Charlotte" }, { "name": "RealName", "type": "string", "required": false, "description": "姓名", "example": "张三" }, { "name": "InstanceId", "type": "string", "required": false, "description": "资产实例ID", "example": "ins-wess22w" }, { "name": "DeviceName", "type": "string", "required": false, "description": "资产名称", "example": "开发机" }, { "name": "PublicIp", "type": "string", "required": false, "description": "资产的公网IP", "example": "100.100.100.100" }, { "name": "PrivateIp", "type": "string", "required": false, "description": "资产的内网IP", "example": "192.168.1.100" }, { "name": "Cmd", "type": "string", "required": false, "description": "执行的命令", "example": "ls" }, { "name": "Encoding", "type": "integer", "required": false, "description": "Cmd字段是前端传值是否进行base64. 0:否，1：是", "example": "0" }, { "name": "AuditAction", "type": "array", "required": false, "description": "根据拦截状态进行过滤：1 - 已执行，2 - 被阻断", "example": "[1]", "item_type": "integer" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页容量，默认20，最大200", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "1" } ], "required": [ "StartTime" ] }, { "name": "SearchCommandBySid", "description": "根据会话Id搜索Command", "status": "online", "parameters": [ { "name": "Sid", "type": "string", "required": true, "description": "会话Id", "example": "dfac9070-8b23-499e-83b2-a50e3ca05" }, { "name": "Cmd", "type": "string", "required": false, "description": "命令，可模糊搜索", "example": "pwd" }, { "name": "Encoding", "type": "integer", "required": false, "description": "Cmd字段是前端传值是否进行base64. 0:否，1：是", "example": "0" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页容量，默认20，最大200", "example": "10" }, { "name": "AuditAction", "type": "array", "required": false, "description": "根据拦截状态进行过滤", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "Sid" ] }, { "name": "SearchFile", "description": "文件传输检索", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间", "example": "2020-01-03T01:01:01Z" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询结束时间", "example": "2020-01-04T01:01:01Z" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名", "example": "Daniel" }, { "name": "RealName", "type": "string", "required": false, "description": "姓名", "example": "张三" }, { "name": "InstanceId", "type": "string", "required": false, "description": "资产ID", "example": "ins-wesdeww" }, { "name": "DeviceName", "type": "string", "required": false, "description": "资产名称", "example": "开发机" }, { "name": "PublicIp", "type": "string", "required": false, "description": "资产公网IP", "example": "100.100.100.100" }, { "name": "PrivateIp", "type": "string", "required": false, "description": "资产内网IP", "example": "192.168.1.100" }, { "name": "Method", "type": "array", "required": false, "description": "操作类型：1 - 文件上传，2 - 文件下载，3 - 文件删除，4 - 文件(夹)移动，5 - 文件(夹)重命名，6 - 新建文件夹，9 - 删除文件夹", "example": "1", "item_type": "integer" }, { "name": "FileName", "type": "string", "required": false, "description": "可填写路径名或文件（夹）名", "example": "1.txt" }, { "name": "AuditAction", "type": "array", "required": false, "description": "1-已执行， 2-被阻断", "example": "1", "item_type": "integer" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页的页内记录数，默认为20，最大200", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" } ], "required": [ "StartTime" ] }, { "name": "SearchFileBySid", "description": "搜索文件传输会话下文件操作列表", "status": "online", "parameters": [ { "name": "Sid", "type": "string", "required": true, "description": "若入参为Id，则其他入参字段不作为搜索依据，仅按照Id来搜索会话", "example": "bh-test-sid-1a2b3c" }, { "name": "AuditLog", "type": "boolean", "required": true, "description": "是否创建审计日志,通过查看按钮调用时为true,其他为false", "example": "true" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页的页内记录数，默认为20，最大200", "example": "10" }, { "name": "FileName", "type": "string", "required": false, "description": "可填写路径名或文件名", "example": "1.txt" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页用偏移量", "example": "0" }, { "name": "AuditAction", "type": "integer", "required": false, "description": "1-已执行， 2-被阻断", "example": "1" }, { "name": "AuditActionSet", "type": "array", "required": false, "description": "1-已执行， 2-被阻断", "example": "[1,2]", "item_type": "integer" }, { "name": "TypeFilters", "type": "array", "required": false, "description": "以Protocol和Method为条件查询", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "需要查询的文件传输类型，如SFTP/CLIP/RDP/RZSZ", "example": "SFTP" }, { "name": "Method", "type": "array", "required": false, "description": "在当前指定的protocol下进一步过滤具体操作类型,如剪贴板文件上传，剪贴板文件下载等", "example": "[1,2]", "item_type": "integer" } ] } ], "required": [ "Sid", "AuditLog" ] }, { "name": "SearchSession", "description": "搜索会话", "status": "online", "parameters": [ { "name": "PrivateIp", "type": "string", "required": false, "description": "内部Ip", "example": "127.0.0.1" }, { "name": "PublicIp", "type": "string", "required": false, "description": "外部Ip", "example": "127.0.0.1" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名，长度不超过20", "example": "user1" }, { "name": "Account", "type": "string", "required": false, "description": "账号，长度不超过64", "example": "administrator" }, { "name": "FromIp", "type": "string", "required": false, "description": "来源Ip", "example": "127.0.0.1" }, { "name": "StartTime", "type": "string", "required": false, "description": "搜索区间的开始时间。若入参是Id，则非必传，否则为必传。", "example": "2020-12-20T19:51:23+08:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "搜索区间的结束时间", "example": "2020-12-30T19:51:23+08:00" }, { "name": "Kind", "type": "integer", "required": false, "description": "会话协议类型，只能是1、2、3或4 对应关系为1-tui 2-gui 3-file 4-数据库。若入参是Id，则非必传，否则为必传。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页的页内记录数，默认为20，最大200", "example": "10" }, { "name": "RealName", "type": "string", "required": false, "description": "姓名，长度不超过20", "example": "zhangsan" }, { "name": "DeviceName", "type": "string", "required": false, "description": "主机名，长度不超过64", "example": "运维主机" }, { "name": "Status", "type": "integer", "required": false, "description": "状态，1为活跃，2为结束，3为强制离线，4为其他错误，5暂停会话", "example": "1" }, { "name": "StatusSet", "type": "array", "required": false, "description": "状态，1为活跃，2为结束，3为强制离线", "example": "[1]", "item_type": "integer" }, { "name": "Id", "type": "string", "required": false, "description": "若入参为Id，则其他入参字段不作为搜索依据，仅按照Id来搜索会话", "example": "bh-test-sid-1a2b3c" }, { "name": "AppAssetKindSet", "type": "array", "required": false, "description": "应用资产类型, 1-web", "example": "[1]", "item_type": "integer" }, { "name": "AppAssetUrl", "type": "string", "required": false, "description": "应用资产Url", "example": "http://www.shen.com" }, { "name": "DeviceKind", "type": "string", "required": false, "description": "资产类型", "example": "Linux" }, { "name": "DeviceKindSet", "type": "array", "required": false, "description": "资产类型 Linux, EKS,TKE", "example": "[\"Linux\"]", "item_type": "string" } ], "required": [] }, { "name": "SearchSessionCommand", "description": "命令检索", "status": "online", "parameters": [ { "name": "Cmd", "type": "string", "required": true, "description": "检索的目标命令，为模糊搜索", "example": "pwd" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，不得早于当前时间的180天前", "example": "2020-01-01T01:01:01+08:00" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移位置，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "默认值为20，最大200", "example": "10" }, { "name": "Encoding", "type": "integer", "required": false, "description": "Cmd字段前端是否做base64加密 0：否，1：是", "example": "0" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "2020-01-01T01:01:01+08:00" } ], "required": [ "Cmd", "StartTime" ] }, { "name": "SearchSubtaskResultById", "description": "查询运维子任务执行结果", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "运维任务名称", "example": "\"运维任务1\"" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页的页内记录数，默认为20，最大200", "example": "10" }, { "name": "Id", "type": "string", "required": false, "description": "运维父任务执行日志ID", "example": "1" }, { "name": "Status", "type": "array", "required": false, "description": "运维父任务执行状态。1 - 执行中，2 - 成功，3 - 失败，4 - 超时", "example": "[1, 2]", "item_type": "integer" } ], "required": [] }, { "name": "SearchTaskResult", "description": "搜索运维任务执行结果", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": false, "description": "搜索区间的开始时间", "example": "2020-01-02T01:01:01+08:0" }, { "name": "EndTime", "type": "string", "required": false, "description": "搜索区间的结束时间", "example": "2020-01-02T01:01:01+08:0" }, { "name": "OperationId", "type": "string", "required": false, "description": "运维任务ID", "example": "ops-awe1d23" }, { "name": "Name", "type": "string", "required": false, "description": "运维任务名称", "example": "\"运维任务1\"" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名，长度不超过20", "example": "nick" }, { "name": "RealName", "type": "string", "required": false, "description": "姓名，长度不超过20", "example": "tom" }, { "name": "TaskType", "type": "array", "required": false, "description": "任务类型 1 手工运维任务 2 定时任务 3 账号推送任务", "example": "[1]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询偏移", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页的页内记录数，默认为20，最大200", "example": "10" } ], "required": [] }, { "name": "SetLDAPSyncFlag", "description": "设置LDAP 立即同步标记", "status": "online", "parameters": [], "required": [] }, { "name": "SyncDevicesToIOA", "description": "同步资产到IOA", "status": "online", "parameters": [ { "name": "DeviceIdSet", "type": "array", "required": true, "description": "资产ID集合。资产必须已绑定支持IOA功能的堡垒机实例。每次最多同步200个资产。", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "DeviceIdSet" ] }, { "name": "SyncUserToIOA", "description": "同步堡垒机本地用户到IOA", "status": "online", "parameters": [ { "name": "UserIdSet", "type": "array", "required": true, "description": "需要同步到ioa的本地用户的id集合", "example": "[152]", "item_type": "integer" } ], "required": [ "UserIdSet" ] }, { "name": "UnlockUser", "description": "解锁用户", "status": "online", "parameters": [ { "name": "IdSet", "type": "array", "required": true, "description": "用户id", "example": "[1]", "item_type": "integer" } ], "required": [ "IdSet" ] } ] }