运维安全中心(堡垒机)_API文档

运维安全中心(堡垒机) - OpenAPI 概览2019-12-09
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
堡垒机实例(仅支持V3.2.X版本使用)
OpenAPI 名称描述操作
DescribeInstanceAttributehot查询实例所有的属性信息,例如:实例ID、实例的备注信息查看文档去调试
DescribeInstanceshot查询实例的列表信息查看文档去调试
StartInstance启动指定堡垒机实例查看文档去调试
EnableInstancePublicAccess打开指定堡垒机实例公网访问开关查看文档去调试
DisableInstancePublicAccess关闭实例的公网访问开关查看文档去调试
ModifyInstanceAttribute修改指定堡垒机实例的信息查看文档去调试
MoveResourceGroup移动堡垒机实例至指定资源组查看文档去调试
ConfigInstanceSecurityGroups为指定的堡垒机实例配置安全组查看文档去调试
ConfigInstanceWhiteList堡垒机实例开启公网访问后,可以将指定公网IP地址加入白名单,允许公网流量访问堡垒机实例查看文档去调试
标签(仅支持V3.2.X版本使用)
OpenAPI 名称描述操作
ListTagKeys查询一个资源已经绑定的标签列表查看文档去调试
ListTagResources查询一个或多个堡垒机实例已经绑定的标签列表查看文档去调试
UntagResources为指定堡垒机实例批量解绑并删除标签查看文档去调试
TagResources为指定的堡垒机实例统一创建并绑定标签查看文档去调试
地域(仅支持V3.2.X版本使用)
OpenAPI 名称描述操作
DescribeRegions查询堡垒机实例支持的阿里云地域查看文档去调试
主机(仅支持V3.2.17及以上版本使用)
OpenAPI 名称描述操作
CreateHosthot堡垒机支持运维阿里云ECS服务器、线下IDC服务器以及其他云上服务器等不同来源的主机。在通过堡垒机运维主机之前,首先需要在堡垒机中导入主机。您可以参考本接口在堡垒机中创建需要运维的主机查看文档去调试
GetHosthot包括主机名称、来源、主机地址、协议端口等信息查看文档去调试
ListHostshot查询指定堡垒机实例下的主机列表查看文档去调试
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获取指定主机账户详情查看文档去调试
ListHostAccountshot获取主机账户列表查看文档去调试
ModifyHostAccount修改主机账户信息,支持修改主机账户的名称、密码和私钥信息查看文档去调试
ResetHostAccountCredential清除指定主机账户登录凭据(密码或SSH私钥)查看文档去调试
DeleteHostAccount删除单个主机账户查看文档去调试
数据库账户(仅支持V3.2.40及以上版本使用)
OpenAPI 名称描述操作
CreateDatabaseAccount数据库创建成功后,您可以为其新建数据库账户。创建成功后,运维员可以使用该账号登录并运维数据库查看文档去调试
GetDatabaseAccount获取指定数据库账户详情查看文档去调试
ListDatabaseAccounts获取数据库账户列表查看文档去调试
ListDatabaseAccountsForUserGroup查询用户组已授权和未授权的数据库账户列表查看文档去调试
ModifyDatabaseAccount修改数据库账户基本信息查看文档去调试
DeleteDatabaseAccount删除单个数据库账户查看文档去调试
用户(仅支持V3.2.17及以上版本使用)
OpenAPI 名称描述操作
CreateUserhot创建用户查看文档去调试
CreateUserPublicKey您可以创建用户公钥后将公钥托管至堡垒机,运维员即可使用私钥通过运维客户端登录堡垒机查看文档去调试
GetUserhot获取指定堡垒机用户的详细信息查看文档去调试
ListUsershot获取指定堡垒机的用户列表查看文档去调试
ListUserPublicKeys查询用户名下所有的公钥列表查看文档去调试
ModifyUser修改堡垒机用户信息查看文档去调试
ModifyUserPublicKey修改用户公钥信息查看文档去调试
LockUsers批量锁定堡垒机用户查看文档去调试
UnlockUsers批量解锁堡垒机用户查看文档去调试
DeleteUser删除单个堡垒机用户查看文档去调试
DeleteUserPublicKey删除用户公钥查看文档去调试
用户组(仅支持V3.2.17及以上版本使用)
OpenAPI 名称描述操作
CreateUserGroup创建堡垒机用户组查看文档去调试
AddUsersToGroup将用户批量添加到用户组查看文档去调试
GetUserGroup获取指定堡垒机用户组的详细信息查看文档去调试
ListUserGroups获取指定堡垒机下的用户组列表查看文档去调试
ModifyUserGroup修改用户组信息查看文档去调试
DeleteUserGroup删除单个堡垒机用户组查看文档去调试
RemoveUsersFromGroup批量移除用户组内用户查看文档去调试
资产组(仅支持V3.2.17及以上的版本使用)
OpenAPI 名称描述操作
CreateHostGroup您可以按照业务需要创建不同的资产组,然后将同一类型的资产添加到资产组,实现对资产的分类管理和批量操作查看文档去调试
AddDatabasesToGroup批量将数据库实例加入指定资产组查看文档去调试
AddHostsToGrouphot批量将主机加入指定资产组查看文档去调试
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 名称描述操作
CreateRule通过创建授权规则,按需求为多个用户批量授权资产,以及设置这些用户访问资产的有效期。授权规则功能不仅可以提升管理用户和资产的效率,还可以对用户访问资产的时间加以控制查看文档去调试
GetRule获取指定授权规则详情查看文档去调试
ListRules获取指定堡垒机下授权规则列表查看文档去调试
ModifyRule修改授权规则基本信息查看文档去调试
EnableRule启用授权规则查看文档去调试
DisableRule禁用授权规则查看文档去调试
DeleteRule删除单个授权规则查看文档去调试
控制策略(仅支持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创建配置备份导出任务。一个堡垒机实例只能同时存在一个正在运行的配置备份导出任务查看文档去调试
GetExportConfigJobnull查看文档去调试
其他
OpenAPI 名称描述操作
VerifyInstanceLDAPAuthServer验证实例LDAP服务配置查看文档去调试
VerifyInstanceADAuthServer验证实例AD服务配置查看文档去调试