API概览_运维安全中心（堡垒机）-阿里云帮助中心

本产品（堡垒机/2019-12-09）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

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

API	标题	API概述
DescribeInstanceAttribute	查询实例属性信息	查询实例所有的属性信息，例如：实例ID、实例的备注信息。
DescribeInstances	查询实例的列表信息	调用DescribeInstances查询实例的列表信息。
ConfigInstanceSecurityGroups	为指定的堡垒机实例配置安全组	调用ConfigInstanceSecurityGroups为指定的堡垒机实例配置安全组。
ConfigInstanceWhiteList	为堡垒机实例配置公网IP地址白名单	堡垒机实例开启公网访问后，可以将指定公网IP地址加入白名单，允许公网流量访问堡垒机实例。
StartInstance	启动指定堡垒机实例	调用StartInstance启动指定堡垒机实例。
EnableInstancePublicAccess	打开指定堡垒机实例公网访问开关	调用EnableInstancePublicAccess打开指定堡垒机实例公网访问开关。
DisableInstancePublicAccess	关闭实例的公网访问开关	调用DisableInstancePublicAccess关闭实例的公网访问开关。
ModifyInstanceAttribute	修改指定堡垒机实例的信息	调用ModifyInstanceAttribute修改指定堡垒机实例的信息。
MoveResourceGroup	移动堡垒机实例至指定资源组	调用MoveResourceGroup移动堡垒机实例至指定资源组。

标签（仅支持V3.2.X版本使用）

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

地域（仅支持V3.2.X版本使用）

API	标题	API概述
DescribeRegions	查询堡垒机实例支持的阿里云地域	查询堡垒机实例支持的阿里云地域。

主机（仅支持V3.2.17及以上版本使用）

API	标题	API概述
CreateHost	在堡垒机中创建需要运维的主机	在堡垒机中创建需要运维的主机。
GetHost	获取指定主机的详细信息	包括主机名称、来源、主机地址、协议端口等信息。
ListHosts	查询指定堡垒机实例下的主机列表	调用ListHosts接口查询指定堡垒机实例下的主机列表。
DeleteHost	删除单个主机	调用DeleteHost接口删除单个主机。
ModifyHostsPort	批量修改主机指定协议的端口	调用ModifyHostsPort接口批量修改主机运维协议的端口。
ModifyHostsActiveAddressType	修改运维主机时使用的连接地址类型	调用ModifyHostsActiveAddressType接口修改运维主机时使用的连接地址类型。
ModifyHost	修改主机基本信息	支持修改主机的地址、名称、操作系统类型和备注信息。

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

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

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

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

用户（仅支持V3.2.17及以上版本使用）

API	标题	API概述
CreateUser	创建用户	调用CreateUser接口创建用户。
GetUser	获取用户信息	获取指定堡垒机用户的详细信息。
ListUsers	获取用户详情列表	调用ListUsers接口获取指定堡垒机的用户列表。
ModifyUser	修改用户	调用ModifyUser接口修改堡垒机用户信息。
DeleteUser	删除用户	调用DeleteUser接口删除单个堡垒机用户。
CreateUserPublicKey	创建用户公钥	创建用户公钥。
ListUserPublicKeys	获取用户公钥列表	查询用户名下所有的公钥列表。
DeleteUserPublicKey	删除用户公钥	删除用户公钥。
LockUsers	批量锁定堡垒机用户	调用LockUsers接口批量锁定堡垒机用户。
UnlockUsers	批量解锁堡垒机用户	调用UnlockUsers接口批量解锁堡垒机用户。

用户组（仅支持V3.2.17及以上版本使用）

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

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

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

资产管理（仅支持V3.2.X版本使用）

API	标题	API概述
CreateHostShareKey	新增主机共享密钥	调用CreateHostShareKey接口新增主机共享密钥。
GetHostShareKey	查询主机共享密钥的详情	调用GetHostShareKey接口查询主机共享密钥的详情。
ListHostShareKeys	查询主机共享密钥的列表	调用ListHostShareKeys接口查询主机共享密钥的列表。
ListHostAccountsForHostShareKey	获取主机共享密钥关联的主机账号	调用ListHostAccountsForHostShareKey接口获取主机共享密钥关联的主机账号。
ModifyHostShareKey	修改主机共享密钥	调用ModifyHostShareKey接口修改主机共享密钥。
AttachHostAccountsToHostShareKey	关联主机账号到主机共享密钥	调用AttachHostAccountsToHostShareKey接口关联主机账号到主机共享密钥。
DetachHostAccountsFromHostShareKey	移除主机账号和主机共享密钥的关联	调用DetachHostAccountsFromHostShareKey接口移除主机账号和主机共享密钥的关联。
DeleteHostShareKey	删除主机共享密钥	调用DeleteHostShareKey接口删除主机共享密钥。

系统设置（仅支持V3.2.X版本使用）

API	标题	API概述
GetInstanceADAuthServer	查询堡垒机实例上AD认证的配置信息	调用GetInstanceADAuthServer接口查询堡垒机实例上AD认证的配置信息。
ModifyInstanceADAuthServer	修改堡垒机实例的AD认证服务器的配置	调用ModifyInstanceADAuthServer接口修改堡垒机实例的AD认证服务器的配置。
GetInstanceTwoFactor	查询堡垒机实例的双因子认证的配置信息	调用GetInstanceTwoFactor接口查询堡垒机实例的双因子认证的配置信息。
ModifyInstanceTwoFactor	修改堡垒机实例的双因子配置	调用ModifyInstanceTwoFactor接口修改堡垒机实例的双因子配置。
ModifyInstanceLDAPAuthServer	修改堡垒机实例LDAP认证服务器的配置	调用ModifyInstanceLDAPAuthServer接口修改堡垒机实例LDAP认证服务器的配置。
GetInstanceLDAPAuthServer	获取堡垒机实例LDAP认证的配置	调用GetInstanceLDAPAuthServer接口获取堡垒机实例LDAP认证的配置。