API 列表--云堡垒机-火山引擎

文档中心

云堡垒机

API 参考

API 列表

API 列表

云堡垒机服务 OpenAPI 采用 RPC 签名风格，目前提供以下 API 接口。

实例管理

API	说明
ListInstances	获取云堡垒机实例列表，可根据分页及实例 ID、运行状态、名称等条件条件筛选符合要求的云堡垒机实例列表。

主机

API	说明
ListHosts	获取主机列表，可根据分页及主机来源、操作系统等条件筛选云堡垒机实例所管理的主机列表，并且能够按字段进行排序。
CreateHost	新建单个主机，手动填写主机名、主机 IP、操作系统和协议端口信息，单个导入本地主机。
ImportHostsFromEcs	导入火山引擎 ECS 主机，自动获取主机名、主机 IP、操作系统和协议端口信息，将火山引擎中的 ECS 主机一键导入云堡垒机。
ImportHostsFromFile	批量导入主机，手动填写主机名、主机 IP、操作系统和协议端口信息，批量导入本地主机。
DeleteHosts	删除主机，解除云堡垒机与主机的管理关系。
UpdateHost	更新主机信息，修改已导入云堡垒机主机的配置信息。

主机组

API	说明
CreateHostGroup	创建主机组，可通过主机组批量管理主机。
ListHostGroups	获取云堡垒机的主机组列表，可根据分页及主机组 ID、名称关键字等筛选条件查询云堡垒机中已存在的主机组列表，并且能够按字段进行排序。
UpdateHostGroup	更新主机组信息，修改已创建主机组的配置信息。
DeleteHostGroups	删除主机组，将彻底删除主机组并自动解除关联关系。
ListHostsFromGroup	获取主机组中的主机列表，可根据分页及主机来源、操作系统等筛选条件查询主机组中的主机列表，并且能够按字段进行排序。
AddHostsToGroup	将主机添加到主机组。
RemoveHostsFromGroup	将主机从主机组中移除。

主机账号

API	说明
CreateHostAccount	新建主机账号，云堡垒机新建主机账号与主机中已经创建的操作系统账号一致，即可通过该账号访问主机。
ListHostAccounts	获取主机账号列表，可根据分页及账户名、主机账号 ID 列表、主机 ID 列表等筛选条件查询云堡垒机中的主机账号列表，并且能够按字段进行排序。
DeleteHostAccounts	删除主机账号，将云堡垒机中新建的主机账号删除，并不会删除主机中的原始账号。
UpdateHostAccount	更新主机账号，修改已经新建主机账号的配置信息。

用户

API	说明
ListUsers	查询用户列表，可根据分页及用户来源、用户状态等筛选条件查询符合要求的云堡垒机用户列表，并且能够按字段进行排序。
ImportUsersFromIam	导入火山引擎 IAM 用户，将火山引擎中的 IAM 用户导入云堡垒机，并随机生成云堡垒机登录密码，可直接作为云堡垒机用户使用。
UpdateUser	更新用户信息，修改已导入云堡垒机用户的配置信息。
DeleteUsers	删除用户，将彻底删除云堡垒机中的用户，但不会删除认证源（例如：IAM 用户）中的原始用户。

用户组

API	说明
ListUserGroups	获取用户组列表，可根据分页及名称关键字筛选符合要求的云堡垒机用户组列表，并且能够按字段进行排序。
CreateUserGroup	创建用户组，可通过用户组批量管理用户。
UpdateUserGroup	更新用户组信息，修改已创建用户组的配置信息。
DeleteUserGroups	删除用户组，可根据用户组 ID 批量删除用户组。
ListUsersFromUserGroup	获取用户组中的用户列表，可根据用户状态、用户来源等筛选条件查询用户组中符合要求的用户列表，并且能够按字段进行排序。
AddUsersToGroup	将用户添加到用户组。
RemoveUsersFromGroup	将用户从用户组中移除。

会话管理

API	说明
ListSessions	获取会话列表，可根据会话开始时间、结束时间、用户名、来源 IP 等筛选条件查询云堡垒机中的会话列表，并且能够按字段进行排序。

策略管理

API	说明
ListAccessControlPolicies	获取指定实例的访问控制策略列表，可根据策略名称关键字查询云堡垒机的访问控制策略列表，并且能够按字段进行排序。
ListCommandControlPolicies	获取指定实例的命令控制策略列表，可根据策略名称关键字查询云堡垒机的命令控制策略列表，并且能够按字段进行排序。

最近更新时间：2025.05.23 17:57:30

这个页面对您有帮助吗？

有用

有用

无用

无用