API 概覽

API標準及多語言預置SDK

本產品（OceanBasePro/2019-09-01）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

標籤管理

API	標題	API概述
ModifyTagValueName	修改標籤名	該介面用於修改標籤名稱。
ModifyTagName	修改標籤組名	該介面用於修改標籤組的名稱。
DescribeTagValues	查詢標籤	該介面用於查詢標籤。
DeleteTagValue	刪除標籤	該介面用於刪除標籤。
DeleteTag	刪除標籤組	該介面用於刪除標籤組。
CreateTagValue	建立標籤	該介面用於建立標籤。
CreateTag	建立標籤組	該介面用於建立標籤組。
ModifyInstanceTags	修改叢集標籤值	該介面用於修改叢集的標籤值。
DescribeTenantTags	查詢租戶標籤值	該介面用於查詢租戶的標籤值。
ModifyTenantTags	修改租戶標籤值	該介面用於修改租戶的標籤值。
DescribeInstanceTags	查詢叢集標籤值	查詢叢集的標籤值。

叢集管理

API	標題	API概述
CreateInstance	建立叢集	建立一個 OceanBase 資料庫叢集。
DescribeInstance	查詢叢集資訊	查詢一個 OceanBase 叢集的詳細資料。
DescribeInstances	查詢叢集列表	查詢 OceanBase 叢集列表資訊。
DescribeInstanceTopology	查詢叢集拓撲資訊	查詢某個 OceanBase 叢集的拓撲資訊。
DescribeAvailableSpec	查詢叢集變配可選配置	查詢 OceanBase 叢集變配頁可選配置。
DescribeAvailableZone	查詢建立叢集可選配置	查詢 OceanBase 叢集售賣頁可選配置。
DescribeInstanceCreatableZone	查詢可用性區域資訊	查詢叢集可建立主可用性區域的可用性區域資訊。
ModifyInstanceName	修改叢集名稱	修改 OceanBase 的叢集名稱。
ModifyInstanceSpec	修改叢集規格和儲存空間	修改叢集規格和儲存空間。
ModifyInstanceNodeNum	修改叢集節點個數	修改叢集節點個數。
ModifyInstanceTemporaryCapacity	修改叢集臨時容量	修改 OceanBase 叢集臨時容量。
SwitchoverInstance	切換主備執行個體	切換 OceanBase 主備執行個體。
RemoveStandbyInstance	解耦備執行個體	備執行個體解耦
DeleteInstances	釋放 OceanBase 執行個體	調用介面釋放 OceanBase 執行個體。
DescribeInstanceSummary	擷取執行個體概覽資訊	擷取 OceanBase 執行個體概覽資訊。
DescribeStandbyCreateMode	擷取建立備叢集模式	擷取 OceanBase 建立備叢集模式

租戶管理

API	標題	API概述
DescribeTenantReadableScn	查詢租戶的最大可讀位點	該介面用於查詢租戶的最大可讀位點。
CreateTenant	建立租戶	建立一個租戶。
CreateTenantReadOnlyConnection	建立唯讀地址	為指定租戶建立一個唯讀地址。
CreateTenantSecurityIpGroup	建立租戶安全白名單資訊	建立租戶安全白名單資訊。
DescribeTenants	查詢叢集下的租戶列表資訊	查詢指定 OceanBase 叢集列表下的租戶列表資訊。
DescribeInstanceTenantModes	查詢租戶模式列表資訊	該介面用於查詢租戶模式列表資訊。
DescribeTenant	查詢指定叢集下的指定租戶資訊	查看指定叢集下的指定租戶資訊。
DescribeAvailableCpuResource	查詢可用的 CPU 資源資訊	查詢建立租戶允許的 CPU 資源資訊。
DescribeAvailableMemResource	查詢記憶體資源資訊	查詢 OceanBase 租戶的記憶體資源資訊。
DescribeCharset	取得字元集	查詢 OceanBase 租戶的字元集資訊。
DescribeInstanceAvailableZones	查詢可用性區域資訊	查詢叢集可建立主可用性區域的可用性區域資訊。
DescribeTenantZonesRead	查詢租戶唯讀可用性區域資訊	查詢租戶的唯讀可用性區域資訊。
DescribeTimeZones	擷取時區列表	查詢 OceanBase 租戶的時區資訊。
DescribeTenantSecurityIpGroups	查看租戶白名單分組列表	查看租戶白名單分組列表。
DescribeZones	擷取可用性區域資訊	擷取一個阿里雲地區下可建立叢集的可用性區域資訊。
ModifyTenantPrimaryZone	切換租戶主可用性區域	切換租戶的主可用性區域。
ModifyTenantResource	修改租戶資源	修改指定 OceanBase 叢集的一個租戶的規格。
ModifyTenantSecurityIpGroup	修改租戶白名單分組資訊	修改租戶白名單分組資訊。
DeleteTenants	刪除租戶	刪除指定 OceanBase 叢集下的一個或多個租戶。
DeleteTenantSecurityIpGroup	刪除租戶白名單分組資訊	刪除租戶白名單分組資訊。

租戶帳號管理

API	標題	API概述
CreateTenantUser	建立租戶使用者	在指定租戶下建立一個存取資料庫的帳號。
DescribeTenantUsers	查詢租戶帳號列表	查詢一個租戶下所有資料庫存取的帳號列表。
DescribeTenantUserRoles	擷取普通使用者的許可權配置資訊	擷取普通使用者的許可權配置資訊。
ModifyTenantUserDescription	修改租戶帳號備忘資訊	修改租戶下指定的資料庫帳號的備忘資訊。
ModifyTenantUserPassword	修改租戶使用者密碼	修改租戶下指定的資料庫帳號的登入密碼。
ModifyTenantUserRoles	修改租戶使用者角色	修改租戶下指定帳號可訪問的資料庫許可權資訊。
DeleteTenantUsers	刪除租戶使用者	刪除一個或多個資料庫帳號列表。

資料庫管理

API	標題	API概述
CreateDatabase	建立資料庫	在指定租戶下建立一個新的資料庫。
DescribeDatabases	查詢資料庫列表	查詢租戶下的資料庫列表。
ModifyDatabaseDescription	修改資料庫描述	修改資料庫的描述資訊。
ModifyTenantUserStatus	鎖定或解鎖指定的資料庫帳號	該介面用於鎖定或解鎖指定的資料庫帳號。
ModifyDatabaseUserRoles	修改資料庫使用者角色	修改某一資料庫的帳號許可權資訊。
DeleteDatabases	刪除資料庫	刪除一個或多個已建立的資料庫。

參數管理

API	標題	API概述
DescribeParameters	查看參數資訊列表	查看參數資訊列表。
DescribeParametersHistory	查看參數修改歷史	查看叢集或租戶的參數修改歷史。
ModifyParameters	修改參數	修改叢集或租戶的參數。

工作階段連線

API	標題	API概述
DescribeSessionList	查詢會話列表	該介面用於展示 OceanBase 雲端服務和業務之間的會話資訊。
BatchKillSessionList	批量關閉會話列表	該介面用於批量關閉 OceanBase 雲端服務和業務之間的會話資訊。該介面為非同步執行，需要使用者通過 DescribeSessionList 驗證會話是否關閉成功。
BatchKillProcessList	批量關閉會話	該介面為非同步執行，用於批量關閉會話，需要使用者通過介面 DescribeProcessStatsComposition 二次確認。
DescribeProcessStatsComposition	查詢會話資訊	該介面用於查詢會話資訊。
KillProcessList	關閉指定的會話	關閉指定的會話。

診斷管理

API	標題	API概述
DescribeOasAnomalySQLList	查詢可疑 SQL 列表	該介面用於查詢診斷系統判定可能存在效能問題的 SQL 列表。
DescribeSampleSqlRawTexts	查詢採樣SQL的原始文本	該介面用於查詢採樣 SQL 的原始文本。
DescribeOasSQLDetails	查詢 SQL 詳細資料	查詢 SQL 詳細資料，包括 SQL 文本、涉及的表名等資訊。
DescribeOasSQLPlans	查詢 SQL 執行計畫	根據 SQLID 查詢診斷系統儲存的 SQL 執行計畫資訊。
DescribeSQLSamples	查詢慢 SQL 執行明細的採樣資料	查詢慢 SQL 執行明細的採樣資料。
DescribeOasSQLHistoryList	查詢 SQL 執行歷史	查詢 SQL 執行歷史資訊。
DescribeOasTopSQLList	查詢 TopSQL 列表	查詢診斷系統採集到的 SQL 執行效能資料列表。
DescribeOasSlowSQLList	查詢慢 SQL 列表	該介面用於查詢慢 SQL 列表。
DescribeOutlineBinding	查詢 Outline 綁定資訊	根據 SQLID 查詢一條 SQL 在資料庫中被綁定的 Outline 資訊或限流資訊。
DescribeRecommendIndex	查詢 SQL 索引推薦資訊	根據 SQLID 查詢診斷系統對 SQL 的索引推薦資訊。
DescribeSQLTuningAdvices	查詢 SQL 的最佳化建議	查詢 SQL 的最佳化建議包括兩種：索引建立的建議、執行計畫綁定的建議。
DescribeSqlAuditStat	統計 SQL 執行情況	按照用戶端IP、使用者、SQLID的維度統計SQL資料執行情況
CreateOasOutlineTask	發起 Outline 綁定任務	發起 Outline 綁定任務。

安全設定

API	標題	API概述
ModifyInstanceSSL	修改 SSL 配置	該介面用於修改執行個體的 SSL 配置。
DescribeInstanceSSL	查詢叢集 SSL	該介面用於查詢 OceanBase 叢集的 SSL 詳情。
CreateSecurityIpGroup	建立白名單組	建立一個 IP 白名單組。
DescribeSecurityIpGroups	查詢 IP 安全白名單分組列表	查看 IP 安全白名單分組列表。
DescribeTenantSecurityConfigs	租戶安全配置檢測	租戶安全配置檢測。
DescribeTenantEncryption	查詢租戶加密資訊	該介面用於查詢租戶加密資訊。
DescribeInstanceSecurityConfigs	叢集安全配置檢測	叢集安全配置檢測。
ModifySecurityIps	修改 IP 列表	修改分組內的 IP 列表。
ModifyTenantEncryption	租戶開啟透明加密	租戶開啟透明加密。
DeleteSecurityIpGroup	刪除白名單分組	刪除 Oceanbase 叢集的某個 IP 白名單分組。
DescribeBackupEncryptedString	擷取整體加密的備份資訊	擷取 OceanBase 整體加密的備份資訊。

監控管理

API	標題	API概述
DescribeMetricsDataV2	查詢監控指標資料	返回使用者監控資料
DescribeMetricsData	查詢監控指標資料	該介面用於查詢 OceanBase 叢集的單維度或者多維度監控指標資料。
DescribeNodeMetrics	查詢節點指標資訊	查詢一個 OceanBase 節點指標資訊。
DescribeTenantMetrics	查詢租戶指標資訊	查詢指定 OceanBase 租戶指標資訊。

資料傳輸

API	標題	API概述
DescribeBackupSetDownloadLink	擷取備份設定的下載連結	該介面用於查詢 OceanBase 備份設定下載連結。
DescribeDataBackupSet	查詢備份組資訊	查詢 OceanBase 備份組資訊。
CreateBackupSetDownloadLink	建立備份任務下載連結	建立 OceanBase 備份任務下載連結。
DescribeRestorableTenants	查詢可恢複租戶	查詢可恢複 OceanBase 租戶。

備份復原

API	標題	API概述
DescribeProxyService	查詢代理服務資訊	查詢 OceanBase 代理服務資訊。
DescribeTenantAddressProxyInfo	查詢租戶地址代理服務資訊	本介面使用者調用擷取租戶地址代理服務資訊。

未翻譯(其他)

API

標題

API概述