本產品(
運維安全中心(堡壘機)/2019-12-09
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(78410016550),在專家指導下進行簽名對接。在使用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 | 在堡壘機中創建需要運維的主機 | 堡壘機支持運維阿里云ECS服務器、線下IDC服務器以及其他云上服務器等不同來源的主機。在通過堡壘機運維主機之前,首先需要在堡壘機中導入主機。您可以參考本接口在堡壘機中創建需要運維的主機。 |
GetHost | 獲取指定主機的詳細信息 | 包括主機名稱、來源、主機地址、協議端口等信息。 |
ListHosts | 查詢指定堡壘機實例下的主機列表 | 查詢指定堡壘機實例下的主機列表。 |
DeleteHost | 刪除單個主機 | 刪除單個主機。 |
ModifyHostsPort | 批量修改主機指定協議的端口 | 堡壘機對于服務器的RDP和SSH協議使用的是默認端口(RDP協議默認使用3389端口,SSH協議默認使用22端口),如果您在主機中自定義了端口,可通過本接口進行修改。 |
ModifyHostsActiveAddressType | 修改運維主機時使用的連接地址類型 | 堡壘機支持公網運維和私網運維,您可以通過本接口修改運維主機時使用的連接地址類型。 |
ModifyHost | 修改主機基本信息 | 支持修改主機的地址、名稱、操作系統類型和備注信息。 |
數據庫(僅支持V3.2.40及以上版本使用)
API | 標題 | API概述 |
---|---|---|
CreateDatabase | 在堡壘機中創建需要運維的數據庫 | 您可以通過本接口,將MySQL、SQL Server、PostgreSQL類型的RDS和MySQL、PostgreSQL、PostgreSQL(兼容Oracle)的PolarDB以及MySQL、SQL Server、PostgreSQL、Oracle類型的自建數據庫資產導入至堡壘機。 |
ModifyDatabase | 修改數據庫基本信息 | 修改數據庫基本信息。 |
GetDatabase | 獲取指定數據庫的詳細信息 | 獲取指定數據庫的詳細信息。 |
ListDatabases | 查詢指定堡壘機實例下的數據庫列表 | 查詢指定堡壘機實例下的數據庫列表。 |
DeleteDatabase | 刪除單個數據庫實例 | 刪除單個數據庫實例。 |
網絡域(僅支持V3.2.40及以上版本使用)
API | 標題 | API概述 |
---|---|---|
CreateNetworkDomain | 創建網絡域 | 如果您想統一運維分布在不同網絡環境中或與堡壘機所在專有網絡(VPC)網絡不互通的資產,推薦使用堡壘機的網絡域功能。您可以為這些資產配置一臺代理服務器,然后在堡壘機中創建網絡域并添加代理服務器,將資產加入該網絡域后即可通過堡壘機運維資產。 |
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 | 獲取當前RAM用戶已授權的數據庫列表 | 獲取當前RAM用戶已授權的數據庫列表。 |
ListOperationHosts | 獲取當前RAM用戶已授權的主機列表 | 獲取當前RAM用戶已授權的主機列表。 |
ListOperationHostAccounts | 獲取當前RAM用戶已授權的主機賬戶列表 | 獲取當前RAM用戶已授權的主機賬戶列表。 |
ListOperationDatabaseAccounts | 獲取當前RAM用戶已授權的數據庫賬戶列表 | 獲取當前RAM用戶已授權的數據庫賬戶列表。 |
GenerateAssetOperationToken | 申請運維令牌 | 您可以通過該接口申請主機或數據庫運維令牌,并通過運維令牌運維資產。 |
RenewAssetOperationToken | 續期運維令牌 | 您可以通過該接口續期運維令牌,單次可將運維令牌續期1小時。 |
CreateOperationTicket | 創建運維申請(僅支持V3.2.44及以上版本使用) | 管理員配置控制策略時開啟了運維審批時,運維人員需要先創建運維申請且管理員審批通過后才能進行運維。 |
授權規則(僅支持V3.2.40及以上版本使用)
API | 標題 | API概述 |
---|---|---|
CreateRule | 創建授權規則 | 通過創建授權規則,按需求為多個用戶批量授權資產,以及設置這些用戶訪問資產的有效期。授權規則功能不僅可以提升管理用戶和資產的效率,還可以對用戶訪問資產的時間加以控制。 |
ModifyRule | 修改授權規則基本信息 | 修改授權規則基本信息。 |
GetRule | 獲取指定授權規則詳情 | 獲取指定授權規則詳情。 |
ListRules | 獲取指定堡壘機下授權規則列表 | 獲取指定堡壘機下授權規則列表。 |
EnableRule | 啟用授權規則 | 啟用授權規則。 |
DisableRule | 禁用授權規則 | 禁用授權規則。 |
DeleteRule | 刪除單個授權規則 | 刪除單個授權規則。 |
控制策略(僅支持V3.2.40及以上版本使用)
API | 標題 | API概述 |
---|---|---|
CreatePolicy | 創建控制策略 | 通過設置命令控制、命令審批、協議控制、訪問控制策略等,對運維行為進行管控,有效防止用戶進行高危命令操作或誤操作,以保障運維安全。 |
ModifyPolicy | 修改控制策略基本信息 | 修改控制策略基本信息。 |
GetPolicy | 獲取指定控制策略詳情 | 獲取指定控制策略詳情。 |
ListPolicies | 獲取控制策略列表 | 獲取控制策略列表。 |
GetPolicyAssetScope | 獲取指定控制策略生效資產范圍 | 獲取指定控制策略生效資產范圍。 |
SetPolicyProtocolConfig | 設置指定控制策略的協議控制配置 | 配置控制策略的RDP選項、SSH選項以及SFTP選項。 |
SetPolicyCommandConfig | 設置指定控制策略的命令控制配置 | 配置在指定策略生效用戶和主機中,允許或禁止執行的命令,以及需要審批的命令。 |
SetPolicyIPAclConfig | 設置指定控制策略的訪問控制配置 | 配置來源IP是否可以訪問當前策略生效的主機。 |
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認證的配置。 |
GetInstanceStoreInfo | 查詢實例存儲狀態信息(僅支持V3.2.44及以上版本使用) | 查詢堡壘機實例存儲空間的使用情況。 |
CreateExportConfigJob | 創建配置備份導出任務(僅支持V3.2.44及以上版本使用) | 創建配置備份導出任務。一個堡壘機實例只能同時存在一個正在運行的配置備份導出任務。 |
GetExportConfigJob | 獲取配置備份導出任務詳情(僅支持V3.2.44及以上版本使用) | null |