本产品(
运维安全中心(堡垒机)/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 | 查询实例的列表信息 | 查询实例的列表信息。 |
ConfigInstanceSecurityGroups | 为指定的堡垒机实例配置安全组 | 为指定的堡垒机实例配置安全组。 |
ConfigInstanceWhiteList | 为堡垒机实例配置公网IP地址白名单 | 堡垒机实例开启公网访问后,可以将指定公网IP地址加入白名单,允许公网流量访问堡垒机实例。 |
StartInstance | 启动指定堡垒机实例 | 启动指定堡垒机实例。 |
EnableInstancePublicAccess | 打开指定堡垒机实例公网访问开关 | 打开指定堡垒机实例公网访问开关。 |
DisableInstancePublicAccess | 关闭实例的公网访问开关 | 关闭实例的公网访问开关。 |
ModifyInstanceAttribute | 修改指定堡垒机实例的信息 | 修改指定堡垒机实例的信息。 |
MoveResourceGroup | 移动堡垒机实例至指定资源组 | 移动堡垒机实例至指定资源组。 |
标签(仅支持V3.2.X版本使用)
API | 标题 | API概述 |
---|---|---|
ListTagKeys | 查询堡垒机资源已绑定的标签列表 | 查询一个资源已经绑定的标签列表。 |
ListTagResources | 查询堡垒机实例已绑定的标签列表 | 查询一个或多个堡垒机实例已经绑定的标签列表。 |
UntagResources | 为指定堡垒机实例批量解绑并删除标签 | 为指定堡垒机实例批量解绑并删除标签。 |
TagResources | 为堡垒机实例统一创建并绑定标签 | 为指定的堡垒机实例统一创建并绑定标签。 |
地域(仅支持V3.2.X版本使用)
API | 标题 | API概述 |
---|---|---|
DescribeRegions | 查询堡垒机实例支持的阿里云地域 | 查询堡垒机实例支持的阿里云地域。 |
主机(仅支持V3.2.17及以上版本使用)
API | 标题 | API概述 |
---|---|---|
CreateHost | 在堡垒机中创建需要运维的主机 | 在堡垒机中创建需要运维的主机。 |
GetHost | 获取指定主机的详细信息 | 包括主机名称、来源、主机地址、协议端口等信息。 |
ListHosts | 查询指定堡垒机实例下的主机列表 | 查询指定堡垒机实例下的主机列表。 |
DeleteHost | 删除单个主机 | 删除单个主机。 |
ModifyHostsPort | 批量修改主机指定协议的端口 | 批量修改主机运维协议的端口。 |
ModifyHostsActiveAddressType | 修改运维主机时使用的连接地址类型 | 修改运维主机时使用的连接地址类型。 |
ModifyHost | 修改主机基本信息 | 支持修改主机的地址、名称、操作系统类型和备注信息。 |
数据库(仅支持V3.2.40及以上版本使用)
API | 标题 | API概述 |
---|---|---|
CreateDatabase | 在堡垒机中创建需要运维的数据库 | 在堡垒机中创建需要运维的数据库。 |
ModifyDatabase | 修改数据库基本信息 | 修改数据库基本信息。 |
GetDatabase | 获取指定数据库的详细信息 | 获取指定数据库的详细信息。 |
ListDatabases | 查询指定堡垒机实例下的数据库列表 | 查询指定堡垒机实例下的数据库列表。 |
DeleteDatabase | 删除单个数据库实例 | 删除单个数据库实例。 |
网络域(仅支持V3.2.40及以上版本使用)
API | 标题 | API概述 |
---|---|---|
CreateNetworkDomain | 创建网络域 | 创建网络域。 |
GetNetworkDomain | 获取指定网络域详情 | 获取指定网络域详情。 |
ListNetworkDomains | 获取指定堡垒机下网络域列表 | 获取指定堡垒机下的网络域列表。 |
DeleteNetworkDomain | 删除单个网络域 | 删除单个网络域。 |
ModifyNetworkDomain | 修改网络域基本信息 | 修改网络域基本信息。 |
MoveHostsToNetworkDomain | 批量将主机移入指定网络域 | 批量将主机移入指定网络域。 |
MoveDatabasesToNetworkDomain | 批量将数据库移入指定网络域 | 批量将数据库移入指定网络域。 |
主机账户(仅支持V3.2.17及以上版本使用)
API | 标题 | API概述 |
---|---|---|
CreateHostAccount | 为指定主机创建主机账户 | 为指定主机创建主机账户。 |
GetHostAccount | 获取指定主机账户详情 | 获取指定主机账户详情。 |
ListHostAccounts | 获取主机账户列表 | 获取主机账户列表。 |
ModifyHostAccount | 修改主机账户信息 | 修改主机账户信息,支持修改主机账户的名称、密码和私钥信息。 |
DeleteHostAccount | 删除单个主机账户 | 删除单个主机账户。 |
ResetHostAccountCredential | 清除指定主机账户登录凭据 | 清除指定主机账户登录凭据(密码或SSH私钥)。 |
数据库账户(仅支持V3.2.40及以上版本使用)
API | 标题 | API概述 |
---|---|---|
CreateDatabaseAccount | 为指定数据库实例创建数据库账户 | 为指定数据库实例创建数据库账户。 |
ModifyDatabaseAccount | 修改数据库账户基本信息 | 修改数据库账户基本信息。 |
GetDatabaseAccount | 获取指定数据库账户详情 | 获取指定数据库账户详情。 |
ListDatabaseAccounts | 获取数据库账户列表 | 获取数据库账户列表。 |
ListDatabaseAccountsForUserGroup | 查询已授权和未授权的数据库账户列表 | 查询用户组已授权和未授权的数据库账户列表。 |
DeleteDatabaseAccount | 删除单个数据库账户 | 删除单个数据库账户。 |
用户(仅支持V3.2.17及以上版本使用)
API | 标题 | API概述 |
---|---|---|
CreateUser | 创建用户 | 创建用户。 |
GetUser | 获取用户信息 | 获取指定堡垒机用户的详细信息。 |
ListUsers | 获取用户详情列表 | 获取指定堡垒机的用户列表。 |
ModifyUser | 修改用户 | 修改堡垒机用户信息。 |
DeleteUser | 删除用户 | 删除单个堡垒机用户。 |
CreateUserPublicKey | 创建用户公钥 | 创建用户公钥。 |
ListUserPublicKeys | 获取用户公钥列表 | 查询用户名下所有的公钥列表。 |
ModifyUserPublicKey | 修改用户公钥 | 修改用户公钥信息。 |
DeleteUserPublicKey | 删除用户公钥 | 删除用户公钥。 |
LockUsers | 批量锁定堡垒机用户 | 批量锁定堡垒机用户。 |
UnlockUsers | 批量解锁堡垒机用户 | 批量解锁堡垒机用户。 |
用户组(仅支持V3.2.17及以上版本使用)
API | 标题 | API概述 |
---|---|---|
CreateUserGroup | 创建用户组 | 创建堡垒机用户组。 |
GetUserGroup | 获取指定堡垒机用户组的详细信息 | 获取指定堡垒机用户组的详细信息。 |
ListUserGroups | 获取用户组列表 | 获取指定堡垒机下的用户组列表。 |
ModifyUserGroup | 修改用户组信息 | 修改用户组信息。 |
DeleteUserGroup | 删除用户组 | 删除单个堡垒机用户组。 |
AddUsersToGroup | 批量为用户组添加用户 | 将用户批量添加到用户组。 |
RemoveUsersFromGroup | 批量移除用户组内用户 | 批量移除用户组内用户。 |
资产组(仅支持V3.2.17及以上的版本使用)
API | 标题 | API概述 |
---|---|---|
CreateHostGroup | 创建资产组 | 创建资产组。 |
AddDatabasesToGroup | 批量将数据库实例加入指定资产组 | 批量将数据库实例加入指定资产组。 |
AddHostsToGroup | 批量将主机加入指定资产组 | 批量将主机加入指定资产组。 |
RemoveDatabasesFromGroup | 从指定资产组中批量移除数据库 | 从指定资产组中批量移除数据库。 |
DeleteHostGroup | 删除单个资产组 | 删除单个资产组。 |
RemoveHostsFromGroup | 从指定资产组中批量移除主机 | 从指定资产组中批量移除主机。 |
ModifyHostGroup | 修改资产组名称或备注信息 | 修改资产组名称或备注信息。 |
GetHostGroup | 获取指定资产组详情 | 获取指定资产组详情。 |
ListHostGroups | 获取指定堡垒机下的资产组列表 | 获取指定堡垒机下的资产组列表。 |
主机授权(仅支持V3.2.17及以上版本使用)
API | 标题 | API概述 |
---|---|---|
AttachHostAccountsToUser | 为用户授权主机和主机账户 | 为用户授权主机和主机账户。 |
ListHostsForUser | 查询已授权或未授权的主机列表 | 查询指定堡垒机用户已授权或未授权的主机列表。 |
ListHostAccountsForUser | 查询已授权和未授权的主机账户列表 | 查询指定用户在指定主机下已授权和未授权的主机账户列表。 |
DetachHostAccountsFromUser | 移除给用户授权的主机及主机账户 | 移除给用户授权的主机及主机账户。 |
DetachHostAccountsFromUserGroup | 移除给用户组授权的主机及主机账户 | 移除给用户组授权的主机及主机账户。 |
DetachHostGroupAccountsFromUser | 移除用户已授权的主机组及主机账户 | 移除用户已授权的主机组及主机账户。 |
AttachHostAccountsToUserGroup | 为用户组授权主机及主机账户 | 为用户组授权主机及主机账户。 |
DetachHostGroupAccountsFromUserGroup | 移除用户组已授权的主机组及主机账户 | 移除用户组已授权的主机组及主机账户。 |
AttachHostGroupAccountsToUser | 为用户授权主机组和主机账号 | 为用户授权主机组和主机账号。 |
AttachHostGroupAccountsToUserGroup | 为用户组授权主机组和主机账号 | 为用户组授权主机组和主机账号。 |
ListHostAccountsForUserGroup | 查询已授权和未授权的主机账户列表 | 查询指定用户组在指定主机下已授权和未授权的主机账户列表。 |
ListHostGroupAccountNamesForUser | 查询主机组中已授权的主机账户名称 | 查询指定用户在指定主机组中已授权的主机账户名称。 |
ListHostGroupAccountNamesForUserGroup | 查询已授权的主机账户名称 | 查询指定用户组在指定主机组中已授权的主机账户名称。 |
ListHostGroupsForUser | 查询已授权或未授权的主机组列表 | 查询指定堡垒机用户已授权或未授权的主机组列表。 |
ListHostGroupsForUserGroup | 查询已授权或未授权的主机组列表 | 查询指定堡垒机用户组已授权或未授权的主机组列表。 |
ListHostsForUserGroup | 查询已授权或未授权的主机列表 | 查询指定堡垒机用户组已授权或未授权的主机列表。 |
数据库授权(仅支持V3.2.40及以上版本使用)
API | 标题 | API概述 |
---|---|---|
AttachDatabaseAccountsToUser | 为用户授权数据库及数据库账户 | 为用户授权数据库及数据库账户。 |
ListDatabasesForUser | 查询用户已授权的数据库列表 | 查询用户已授权的数据库列表。 |
DetachDatabaseAccountsFromUserGroup | 移除给用户组授权的数据库及数据库账户 | 移除给用户组授权的数据库及数据库账户。 |
ListDatabaseAccountsForUser | 查询已授权和未授权的数据库账户列表 | 查询用户已授权和未授权的数据库账户列表。 |
DetachDatabaseAccountsFromUser | 移除给用户授权的数据库及数据库账户 | 移除给用户授权的数据库及数据库账户。 |
AttachDatabaseAccountsToUserGroup | 为用户组授权数据库及数据库账户 | 为用户组授权数据库及数据库账户。 |
ListDatabasesForUserGroup | 查询用户组已授权的数据库列表 | 查询用户组已授权的数据库列表。 |
运维令牌(仅支持V3.2.40及以上版本使用)
API | 标题 | API概述 |
---|---|---|
ListOperationDatabases | 获取已授权的数据库列表 | 获取已授权的数据库列表。 |
ListOperationHosts | 获取已授权的主机列表 | 获取已授权的主机列表。 |
ListOperationHostAccounts | 获取已授权的主机账户列表 | 获取已授权的主机账户列表。 |
ListOperationDatabaseAccounts | 获取已授权的数据库账户列表 | 获取已授权的数据库账户列表。 |
GenerateAssetOperationToken | 申请运维令牌 | 申请运维令牌。 |
RenewAssetOperationToken | 续期运维令牌 | 续期运维令牌。 |
授权规则(仅支持V3.2.40及以上版本使用)
API | 标题 | API概述 |
---|---|---|
CreateRule | 创建授权规则 | 创建授权规则。 |
ModifyRule | 修改授权规则基本信息 | 修改授权规则基本信息。 |
GetRule | 获取指定授权规则详情 | 获取指定授权规则详情。 |
ListRules | 获取指定堡垒机下授权规则列表 | 获取指定堡垒机下授权规则列表。 |
EnableRule | 启用授权规则 | 启用授权规则。 |
DisableRule | 禁用授权规则 | 禁用授权规则。 |
DeleteRule | 删除单个授权规则 | 删除单个授权规则。 |
控制策略(仅支持V3.2.40及以上版本使用)
API | 标题 | API概述 |
---|---|---|
CreatePolicy | 创建控制策略 | 创建控制策略。 |
ModifyPolicy | 修改控制策略基本信息 | 修改控制策略基本信息。 |
GetPolicy | 获取指定控制策略详情 | 获取指定控制策略详情。 |
ListPolicies | 获取控制策略列表 | 获取控制策略列表。 |
GetPolicyAssetScope | 获取指定控制策略生效资产范围 | 获取指定控制策略生效资产范围。 |
SetPolicyProtocolConfig | 设置指定控制策略的协议控制配置 | 设置指定控制策略的协议控制配置。 |
SetPolicyCommandConfig | 设置指定控制策略的命令控制配置 | 设置指定控制策略的命令控制配置。 |
SetPolicyIPAclConfig | 设置指定控制策略的访问控制配置 | 设置指定控制策略的访问控制配置。 |
GetPolicyUserScope | 获取指定控制策略生效用户范围 | 获取指定控制策略生效用户范围。 |
SetPolicyAccessTimeRangeConfig | 设置指定控制策略的登录时段限制配置 | 设置指定控制策略的登录时段限制配置。 |
SetPolicyAssetScope | 设置指定控制策略的资产生效范围 | 设置指定控制策略的资产生效范围。 |
SetPolicyUserScope | 设置指定控制策略的用户生效范围 | 设置指定控制策略的用户生效范围。 |
SetPolicyApprovalConfig | 设置指定控制策略的运维审批配置 | 设置指定控制策略的运维审批配置。 |
DeletePolicy | 删除单个控制策略 | 删除单个控制策略。 |
审批(仅支持V3.2.37及以上版本使用)
API | 标题 | API概述 |
---|---|---|
ListApproveCommands | 获取需要审批的命令列表 | 获取需要审批的命令列表。 |
AcceptApproveCommand | 允许单个命令 | 单个允许命令执行。 |
RejectApproveCommand | 拒绝单个命令 | 单个拒绝命令执行。 |
ListOperationTickets | 获取需要审批的运维申请列表 | 获取需要审批的运维申请列表。 |
AcceptOperationTicket | 允许运维申请 | 允许运维申请。 |
RejectOperationTicket | 拒绝运维申请 | 拒绝运维申请。 |
共享密钥(仅支持V3.2.X版本使用)
API | 标题 | API概述 |
---|---|---|
CreateHostShareKey | 新增主机共享密钥 | 新增主机共享密钥。 |
GetHostShareKey | 查询主机共享密钥的详情 | 查询主机共享密钥的详情。 |
ListHostShareKeys | 查询主机共享密钥的列表 | 查询主机共享密钥的列表。 |
ListHostAccountsForHostShareKey | 获取主机共享密钥关联的主机账号 | 获取主机共享密钥关联的主机账号。 |
ModifyHostShareKey | 修改主机共享密钥 | 修改主机共享密钥。 |
AttachHostAccountsToHostShareKey | 关联主机账号到主机共享密钥 | 关联主机账号到主机共享密钥。 |
DetachHostAccountsFromHostShareKey | 移除主机账号和主机共享密钥的关联 | 移除主机账号和主机共享密钥的关联。 |
DeleteHostShareKey | 删除主机共享密钥 | 删除主机共享密钥。 |
系统设置(仅支持V3.2.X版本使用)
API | 标题 | API概述 |
---|---|---|
GetInstanceADAuthServer | 查询堡垒机实例上AD认证的配置信息 | 查询堡垒机实例上AD认证的配置信息。 |
ModifyInstanceADAuthServer | 修改堡垒机实例的AD认证服务器的配置 | 修改堡垒机实例的AD认证服务器的配置。 |
GetInstanceTwoFactor | 查询堡垒机实例的双因子认证的配置信息 | 查询堡垒机实例的双因子认证的配置信息。 |
ModifyInstanceTwoFactor | 修改堡垒机实例的双因子配置 | 修改堡垒机实例的双因子配置。 |
ModifyInstanceLDAPAuthServer | 修改堡垒机实例LDAP认证服务器的配置 | 修改堡垒机实例LDAP认证服务器的配置。 |
GetInstanceLDAPAuthServer | 获取堡垒机实例LDAP认证的配置 | 获取堡垒机实例LDAP认证的配置。 |
其他
API | 标题 | API概述 |
---|---|---|
VerifyInstanceLDAPAuthServer | 验证实例LDAP服务配置。 | |
VerifyInstanceADAuthServer | 验证实例AD服务配置。 |