堡垒机实例(仅支持V3.2.X版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
DescribeInstanceAttribute![]() | 查询实例所有的属性信息,例如:实例ID、实例的备注信息 | 查看文档去调试 |
DescribeInstances![]() | 查询实例的列表信息 | 查看文档去调试 |
StartInstance | 启动指定堡垒机实例 | 查看文档去调试 |
EnableInstancePublicAccess | 打开指定堡垒机实例公网访问开关 | 查看文档去调试 |
DisableInstancePublicAccess | 关闭实例的公网访问开关 | 查看文档去调试 |
ModifyInstanceAttribute | 修改指定堡垒机实例的信息 | 查看文档去调试 |
MoveResourceGroup | 移动堡垒机实例至指定资源组 | 查看文档去调试 |
ConfigInstanceSecurityGroups | 为指定的堡垒机实例配置安全组 | 查看文档去调试 |
ConfigInstanceWhiteList | 堡垒机实例开启公网访问后,可以将指定公网IP地址加入白名单,允许公网流量访问堡垒机实例 | 查看文档去调试 |
主机(仅支持V3.2.17及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateHost![]() | 堡垒机支持运维阿里云ECS服务器、线下IDC服务器以及其他云上服务器等不同来源的主机。在通过堡垒机运维主机之前,首先需要在堡垒机中导入主机。您可以参考本接口在堡垒机中创建需要运维的主机 | 查看文档去调试 |
GetHost![]() | 包括主机名称、来源、主机地址、协议端口等信息 | 查看文档去调试 |
ListHosts![]() | 查询指定堡垒机实例下的主机列表 | 查看文档去调试 |
ModifyHostsPort | 堡垒机对于服务器的RDP和SSH协议使用的是默认端口(RDP协议默认使用3389端口,SSH协议默认使用22端口),如果您在主机中自定义了端口,可通过本接口进行修改 | 查看文档去调试 |
ModifyHostsActiveAddressType | 堡垒机支持公网运维和私网运维,您可以通过本接口修改运维主机时使用的连接地址类型 | 查看文档去调试 |
ModifyHost | 支持修改主机的地址、名称、操作系统类型和备注信息 | 查看文档去调试 |
DeleteHost | 删除单个主机 | 查看文档去调试 |
数据库(仅支持V3.2.40及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateDatabase | 您可以通过本接口,将MySQL、SQL Server、PostgreSQL类型的RDS和MySQL、PostgreSQL、PostgreSQL(兼容Oracle)的PolarDB以及MySQL、SQL Server、PostgreSQL、Oracle类型的自建数据库资产导入至堡垒机 | 查看文档去调试 |
ModifyDatabase | 修改数据库基本信息 | 查看文档去调试 |
GetDatabase | 获取指定数据库的详细信息 | 查看文档去调试 |
ListDatabases | 查询指定堡垒机实例下的数据库列表 | 查看文档去调试 |
DeleteDatabase | 删除单个数据库实例 | 查看文档去调试 |
网络域(仅支持V3.2.40及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateNetworkDomain | 如果您想统一运维分布在不同网络环境中或与堡垒机所在专有网络(VPC)网络不互通的资产,推荐使用堡垒机的网络域功能。您可以为这些资产配置一台代理服务器,然后在堡垒机中创建网络域并添加代理服务器,将资产加入该网络域后即可通过堡垒机运维资产 | 查看文档去调试 |
GetNetworkDomain | 获取指定网络域详情 | 查看文档去调试 |
ListNetworkDomains | 获取指定堡垒机下的网络域列表 | 查看文档去调试 |
ModifyNetworkDomain | 修改网络域基本信息 | 查看文档去调试 |
MoveHostsToNetworkDomain | 批量将主机移入指定网络域 | 查看文档去调试 |
MoveDatabasesToNetworkDomain | 批量将数据库移入指定网络域 | 查看文档去调试 |
DeleteNetworkDomain | 删除单个网络域 | 查看文档去调试 |
主机账户(仅支持V3.2.17及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateHostAccount | 在堡垒机中新建主机后,您可以为其创建相应的主机账户,即将您主机已有的账户托管至堡垒机。创建主机账户后,运维人员即可使用该账户通过堡垒机登录主机进行运维 | 查看文档去调试 |
GetHostAccount | 获取指定主机账户详情 | 查看文档去调试 |
ListHostAccounts![]() | 获取主机账户列表 | 查看文档去调试 |
ModifyHostAccount | 修改主机账户信息,支持修改主机账户的名称、密码和私钥信息 | 查看文档去调试 |
ResetHostAccountCredential | 清除指定主机账户登录凭据(密码或SSH私钥) | 查看文档去调试 |
DeleteHostAccount | 删除单个主机账户 | 查看文档去调试 |
数据库账户(仅支持V3.2.40及以上版本使用)
用户(仅支持V3.2.17及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateUser![]() | 创建用户 | 查看文档去调试 |
CreateUserPublicKey | 您可以创建用户公钥后将公钥托管至堡垒机,运维员即可使用私钥通过运维客户端登录堡垒机 | 查看文档去调试 |
GetUser![]() | 获取指定堡垒机用户的详细信息 | 查看文档去调试 |
ListUsers![]() | 获取指定堡垒机的用户列表 | 查看文档去调试 |
ListUserPublicKeys | 查询用户名下所有的公钥列表 | 查看文档去调试 |
ModifyUser | 修改堡垒机用户信息 | 查看文档去调试 |
ModifyUserPublicKey | 修改用户公钥信息 | 查看文档去调试 |
LockUsers | 批量锁定堡垒机用户 | 查看文档去调试 |
UnlockUsers | 批量解锁堡垒机用户 | 查看文档去调试 |
DeleteUser | 删除单个堡垒机用户 | 查看文档去调试 |
DeleteUserPublicKey | 删除用户公钥 | 查看文档去调试 |
资产组(仅支持V3.2.17及以上的版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateHostGroup | 您可以按照业务需要创建不同的资产组,然后将同一类型的资产添加到资产组,实现对资产的分类管理和批量操作 | 查看文档去调试 |
AddDatabasesToGroup | 批量将数据库实例加入指定资产组 | 查看文档去调试 |
AddHostsToGroup![]() | 批量将主机加入指定资产组 | 查看文档去调试 |
GetHostGroup | 获取指定资产组详情 | 查看文档去调试 |
ListHostGroups | 获取指定堡垒机下的资产组列表 | 查看文档去调试 |
ModifyHostGroup | 修改资产组名称或备注信息 | 查看文档去调试 |
RemoveDatabasesFromGroup | 从指定资产组中批量移除数据库 | 查看文档去调试 |
DeleteHostGroup | 删除单个资产组 | 查看文档去调试 |
RemoveHostsFromGroup | 从指定资产组中批量移除主机 | 查看文档去调试 |
主机授权(仅支持V3.2.17及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
ListHostsForUser | 查询指定堡垒机用户已授权或未授权的主机列表 | 查看文档去调试 |
ListHostAccountsForUser | 查询指定用户在指定主机下已授权和未授权的主机账户列表 | 查看文档去调试 |
ListHostAccountsForUserGroup | 查询指定用户组在指定主机下已授权和未授权的主机账户列表 | 查看文档去调试 |
ListHostGroupAccountNamesForUser | 查询指定用户在指定主机组中已授权的主机账户名称 | 查看文档去调试 |
ListHostGroupAccountNamesForUserGroup | 查询指定用户组在指定主机组中已授权的主机账户名称 | 查看文档去调试 |
ListHostGroupsForUser | 查询指定堡垒机用户已授权或未授权的主机组列表 | 查看文档去调试 |
ListHostGroupsForUserGroup | 查询指定堡垒机用户组已授权或未授权的主机组列表 | 查看文档去调试 |
ListHostsForUserGroup | 查询指定堡垒机用户组已授权或未授权的主机列表 | 查看文档去调试 |
AttachHostAccountsToUser | 当您新建用户之后,您需要为该用户授权资产。授权后该用户才可以使用堡垒机运维已授权的资产 | 查看文档去调试 |
DetachHostAccountsFromUser | 移除给用户授权的主机及主机账户 | 查看文档去调试 |
DetachHostAccountsFromUserGroup | 移除给用户组授权的主机及主机账户 | 查看文档去调试 |
DetachHostGroupAccountsFromUser | 移除用户已授权的主机组及主机账户 | 查看文档去调试 |
AttachHostAccountsToUserGroup | 为用户组授权主机及主机账户 | 查看文档去调试 |
DetachHostGroupAccountsFromUserGroup | 移除用户组已授权的主机组及主机账户 | 查看文档去调试 |
AttachHostGroupAccountsToUser | 为用户授权主机组和主机账号 | 查看文档去调试 |
AttachHostGroupAccountsToUserGroup | 为用户组授权主机组和主机账号 | 查看文档去调试 |
数据库授权(仅支持V3.2.40及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
AttachDatabaseAccountsToUser | 为用户授权数据库及数据库账户 | 查看文档去调试 |
ListDatabasesForUser | 查询用户已授权的数据库列表 | 查看文档去调试 |
DetachDatabaseAccountsFromUserGroup | 移除给用户组授权的数据库及数据库账户 | 查看文档去调试 |
ListDatabaseAccountsForUser | 查询用户已授权和未授权的数据库账户列表 | 查看文档去调试 |
DetachDatabaseAccountsFromUser | 移除给用户授权的数据库及数据库账户 | 查看文档去调试 |
AttachDatabaseAccountsToUserGroup | 为用户组授权数据库及数据库账户 | 查看文档去调试 |
ListDatabasesForUserGroup | 查询用户组已授权的数据库列表 | 查看文档去调试 |
运维令牌(仅支持V3.2.40及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
GenerateAssetOperationToken | 您可以通过该接口申请主机或数据库运维令牌,并通过运维令牌运维资产 | 查看文档去调试 |
ListOperationDatabases | 获取当前RAM用户已授权的数据库列表 | 查看文档去调试 |
ListOperationHosts | 获取当前RAM用户已授权的主机列表 | 查看文档去调试 |
ListOperationHostAccounts | 获取当前RAM用户已授权的主机账户列表 | 查看文档去调试 |
ListOperationDatabaseAccounts | 获取当前RAM用户已授权的数据库账户列表 | 查看文档去调试 |
RenewAssetOperationToken | 您可以通过该接口续期运维令牌,单次可将运维令牌续期1小时 | 查看文档去调试 |
CreateOperationTicket | 管理员配置控制策略时开启了运维审批时,运维人员需要先创建运维申请且管理员审批通过后才能进行运维 | 查看文档去调试 |
控制策略(仅支持V3.2.40及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreatePolicy | 通过设置命令控制、命令审批、协议控制、访问控制策略等,对运维行为进行管控,有效防止用户进行高危命令操作或误操作,以保障运维安全 | 查看文档去调试 |
GetPolicy | 获取指定控制策略详情 | 查看文档去调试 |
ListPolicies | 获取控制策略列表 | 查看文档去调试 |
GetPolicyAssetScope | 获取指定控制策略生效资产范围 | 查看文档去调试 |
GetPolicyUserScope | 获取指定控制策略生效用户范围 | 查看文档去调试 |
ModifyPolicy | 修改控制策略基本信息 | 查看文档去调试 |
SetPolicyProtocolConfig | 配置控制策略的RDP选项、SSH选项以及SFTP选项 | 查看文档去调试 |
SetPolicyCommandConfig | 配置在指定策略生效用户和主机中,允许或禁止执行的命令,以及需要审批的命令 | 查看文档去调试 |
SetPolicyIPAclConfig | 配置来源IP是否可以访问当前策略生效的主机 | 查看文档去调试 |
SetPolicyAccessTimeRangeConfig | 设置指定控制策略的登录时段限制配置 | 查看文档去调试 |
SetPolicyAssetScope | 设置指定控制策略的资产生效范围 | 查看文档去调试 |
SetPolicyUserScope | 设置指定控制策略的用户生效范围 | 查看文档去调试 |
SetPolicyApprovalConfig | 设置指定控制策略的运维审批配置 | 查看文档去调试 |
DeletePolicy | 删除单个控制策略 | 查看文档去调试 |
审批(仅支持V3.2.37及以上版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
ListApproveCommands | 获取需要审批的命令列表 | 查看文档去调试 |
AcceptApproveCommand | 如果运维员执行了配置在命令审批控制策略中的命令,管理员会在堡垒机控制台收到该命令的审批,只有管理员审批允许后该命令才能正常执行,审批拒绝后该命令不可执行 | 查看文档去调试 |
RejectApproveCommand | 如果运维员执行了配置在命令审批控制策略中的命令,管理员会在堡垒机控制台收到该命令的审批,只有管理员审批允许后该命令才能正常执行,审批拒绝后该命令不可执行 | 查看文档去调试 |
ListOperationTickets | 获取需要审批的运维申请列表 | 查看文档去调试 |
AcceptOperationTicket | 如果管理员配置控制策略时开启了运维审批,则运维员登录资产时,需要申请运维且管理员审批通过后才能进行运维 | 查看文档去调试 |
RejectOperationTicket | 如果管理员配置控制策略时开启了运维审批,则运维员登录资产时,需要申请运维且管理员审批通过后才能进行运维 | 查看文档去调试 |
共享密钥(仅支持V3.2.X版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateHostShareKey | 堡垒机的共享密钥功能可以将用于登录主机的私钥托管在堡垒机中。托管后的私钥可以被共享到多个主机账户中,从而提高主机账户的管理效率 | 查看文档去调试 |
GetHostShareKey | 查询主机共享密钥的详情 | 查看文档去调试 |
ListHostShareKeys | 查询主机共享密钥的列表 | 查看文档去调试 |
ListHostAccountsForHostShareKey | 获取主机共享密钥关联的主机账号 | 查看文档去调试 |
ModifyHostShareKey | 修改主机共享密钥 | 查看文档去调试 |
AttachHostAccountsToHostShareKey | 关联主机账号到主机共享密钥 | 查看文档去调试 |
DetachHostAccountsFromHostShareKey | 移除主机账号和主机共享密钥的关联 | 查看文档去调试 |
DeleteHostShareKey | 删除主机共享密钥 | 查看文档去调试 |
系统设置(仅支持V3.2.X版本使用)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
GetInstanceADAuthServer | 查询堡垒机实例上AD认证的配置信息 | 查看文档去调试 |
ModifyInstanceADAuthServer | 修改堡垒机实例的AD认证服务器的配置 | 查看文档去调试 |
GetInstanceTwoFactor | 查询堡垒机实例的双因子认证的配置信息 | 查看文档去调试 |
ModifyInstanceTwoFactor | 修改堡垒机实例的双因子配置 | 查看文档去调试 |
ModifyInstanceLDAPAuthServer | 修改堡垒机实例LDAP认证服务器的配置 | 查看文档去调试 |
GetInstanceLDAPAuthServer | 获取堡垒机实例LDAP认证的配置 | 查看文档去调试 |
GetInstanceStoreInfo | 查询堡垒机实例存储空间的使用情况 | 查看文档去调试 |
CreateExportConfigJob | 创建配置备份导出任务。一个堡垒机实例只能同时存在一个正在运行的配置备份导出任务 | 查看文档去调试 |
GetExportConfigJob | null | 查看文档去调试 |