本文介绍堡垒机提供的API接口。

开通堡垒机实例

API 描述
CreateInstance 堡垒机不提供创建实例的接口。您可以通过调用阿里云交易和账单管理API提供的CreateInstance接口来创建堡垒机实例。
ModifyInstance 堡垒机不提供修改实例配置的接口。您可以通过调用阿里云交易和账单管理API提供的ModifyInstance接口来修改堡垒机实例的配置。
RenewInstance 堡垒机不提供为实例续费的接口。您可以通过调用阿里云交易和账单管理API提供的RenewInstance接口来为堡垒机的实例续费。
SetRenewal 堡垒机不提供为实例设置自动续费的接口。您可以通过调用阿里云交易和账单管理API提供的SetRenewal接口为堡垒机实例设置自动续费。

堡垒机实例(仅支持V3.2.X版本使用)

API 描述
DescribeInstanceAttribute 调用DescribeInstanceAttribute接口查询实例所有的属性信息。
DescribeInstances 调用DescribeInstances接口查询实例的列表信息。
ConfigInstanceSecurityGroups 调用ConfigInstanceSecurityGroups接口为指定的堡垒机实例配置安全组。
ConfigInstanceWhiteList 调用ConfigInstanceWhiteList接口配置公网IP地址白名单。
StartInstance 调用StartInstance接口启动堡垒机实例。
EnableInstancePublicAccess 调用EnableInstancePublicAccess接口开启指定堡垒机实例的公网访问能力。
DisableInstancePublicAccess 调用DisableInstancePublicAccess接口关闭堡垒机实例的公网访问能力。
ModifyInstanceAttribute 调用ModifyInstanceAttribute接口修改指定堡垒机实例的信息。
MoveResourceGroup 调用MoveResourceGroup接口移动资源组堡垒机实例至其他资源组。

标签(仅支持V3.2.X版本使用)

API 描述
ListTagKeys 调用ListTagKeys接口查询指定堡垒机实例已绑定的标签列表。
ListTagResources 调用ListTagResources接口查询一个或多个堡垒机实例已经绑定的标签列表。
UntagResources 调用UntagResources接口为指定的堡垒机实例资源统一解绑并删除标签。
TagResources 调用TagResources接口为指定的堡垒机实例资源统一创建并绑定标签。

地域(仅支持V3.2.X版本使用)

API 描述
DescribeRegions 调用DescribeRegions接口查询堡垒机实例支持的阿里云地域。

主机(仅支持V3.2.17及以上版本使用)

API 描述
CreateHost 调用CreateHost接口在堡垒机中创建需要运维的主机。
GetHost 调用GetHost接口获取指定主机的详细信息。
ListHosts 调用ListHosts接口查询指定堡垒机实例下的主机列表。
DeleteHost 调用DeleteHost接口删除单个主机。
ModifyHostsPort 调用ModifyHostsPort接口批量修改主机指定协议的端口。
ModifyHostsActiveAddressType 调用ModifyHostsActiveAddressType接口修改运维主机时使用的连接地址类型。
ModifyHost 调用ModifyHost接口修改主机基本信息。

主机组(仅支持V3.2.17及以上版本使用)

API 描述
CreateHostGroup 调用CreateHostGroup接口创建主机组。
GetHostGroup 调用GetHostGroup接口获取指定主机组详情。
ListHostGroups 调用ListHostGroups接口获取指定堡垒机下的主机组列表。
ModifyHostGroup 调用ModifyHostGroup接口修改主机组名称或备注信息。
DeleteHostGroup 调用DeleteHostGroup接口删除单个主机组。
AddHostsToGroup 调用AddHostsToGroup接口批量将主机加入指定主机组。
RemoveHostsFromGroup 调用RemoveHostsFromGroup接口从指定主机组中批量移除主机。

主机账户(仅支持V3.2.17及以上版本使用)

API 描述
CreateHostAccount 调用CreateHostAccount接口为指定主机创建主机账户。
GetHostAccount 调用GetHostAccount接口获取指定主机账户详情。
ListHostAccounts 调用ListHostAccounts接口获取主机账户列表。
ModifyHostAccount 调用ModifyHostAccount接口修改主机账户信息,支持修改主机账户的名称、密码和私钥信息。
DeleteHostAccount 调用DeleteHostAccount接口删除单个主机账户。
ResetHostAccountCredential 调用ResetHostAccountCredential接口清除指定主机账户登录凭据(密码或SSH私钥)。

用户(仅支持V3.2.17及以上版本使用)

API 描述
CreateUser 调用CreateUser接口创建用户。
GetUser 调用GetUser接口获取指定堡垒机用户的详细信息。
ListUsers 调用ListUsers接口获取指定堡垒机的用户列表。
ModifyUser 调用ModifyUser接口修改堡垒机用户信息。
DeleteUser 调用DeleteUser接口删除单个堡垒机用户。
LockUsers 调用LockUsers接口批量锁定堡垒机用户。
UnlockUsers 调用UnlockUsers接口批量解锁堡垒机用户。

用户组(仅支持V3.2.17及以上版本使用)

API 描述
CreateUserGroup 调用CreateUserGroup接口创建堡垒机用户组。
GetUserGroup 调用GetUserGroup接口获取指定堡垒机用户组的详细信息。
ListUserGroups 调用ListUserGroups接口获取指定堡垒机下的用户组列表。
ModifyUserGroup 调用ModifyUserGroup接口修改用户组信息。
DeleteUserGroup 调用DeleteUserGroup接口删除单个堡垒机用户组。
AddUsersToGroup 调用AddUsersToGroup接口批量为用户组添加用户。
RemoveUsersFromGroup 调用RemoveUsersFromGroup接口批量移除用户组内用户。

主机授权(仅支持V3.2.17及以上版本使用)

API 描述
AttachHostAccountsToUser 调用AttachHostAccountsToUser接口为用户授权主机和主机账户。
ListHostsForUser 调用ListHostsForUser接口查询指定堡垒机用户已授权或未授权的主机列表。
ListHostAccountsForUser 调用ListHostAccountsForUser接口查询指定用户在指定主机下已授权的主机账户列表。
DetachHostAccountsFromUser 调用DetachHostAccountsFromUser接口移除给用户授权的主机及主机账户。
AttachHostAccountsToUserGroup 调用AttachHostAccountsToUserGroup接口为用户组授权主机及主机账户。
ListHostsForUserGroup 调用ListHostsForUserGroup接口查询指定堡垒机用户组已授权或未授权的主机列表。
ListHostAccountsForUserGroup 调用ListHostAccountsForUserGroup接口查询指定用户组在指定主机下已授权的主机账户列表。
DetachHostAccountsFromUserGroup 调用DetachHostAccountsFromUserGroup接口移除给用户组授权的主机及主机账户。
AttachHostGroupAccountsToUser 调用AttachHostGroupAccountsToUser接口为用户授权主机组和主机账号。
ListHostGroupsForUser 调用ListHostGroupsForUser接口查询指定堡垒机用户已授权或未授权的主机组列表。
ListHostGroupAccountNamesForUser 调用ListHostGroupAccountNamesForUser接口查询指定用户在指定主机组中已授权的主机账户名称。
DetachHostGroupAccountsFromUser 调用DetachHostGroupAccountsFromUser接口移除用户已授权的主机组及主机账户。
AttachHostGroupAccountsToUserGroup 调用AttachHostGroupAccountsToUserGroup接口为用户组授权主机组和主机账号。
ListHostGroupsForUserGroup 调用ListHostGroupsForUserGroup接口查询指定堡垒机用户组已授权或未授权的主机组列表。
ListHostGroupAccountNamesForUserGroup 调用ListHostGroupAccountNamesForUserGroup接口查询指定用户组在指定主机组中已授权的主机账户名称。
DetachHostGroupAccountsFromUserGroup 调用DetachHostGroupAccountsFromUserGroup接口移除用户组已授权的主机组及主机账户。