备案控制台
文档
产品文档
输入文档关键字查找
首页 运维安全中心（堡垒机） 基础版、企业双擎版 开发参考 API参考 API概览

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查询实例的列表信息查询实例的列表信息。
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服务配置。
文档推荐
  • 本页导读 （1）
文档反馈