本產品（
云數據庫 OceanBase 版/2019-09-01）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
標簽管理
| 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 集群售賣頁可選配置。 |
| ModifyInstanceName | 修改集群名稱 | 修改 OceanBase 的集群名稱。 |
| ModifyInstanceSpec | 修改集群規格和存儲空間 | 修改集群規格和存儲空間。 |
| ModifyInstanceNodeNum | 修改集群節點個數 | 修改集群節點個數。 |
| ModifyInstanceTemporaryCapacity | 修改集群臨時容量 | 修改 OceanBase 集群臨時容量。 |
| SwitchoverInstance | 切換主備實例 | 切換 OceanBase 主備實例。 |
| RemoveStandbyInstance | 解耦備實例 | 備實例解耦 |
| DeleteInstances | 釋放 OceanBase 實例 | 調用接口釋放 OceanBase 實例。 |
| DescribeInstanceSummary | 獲取實例概覽信息 | 獲取 OceanBase 實例概覽信息。 |
租戶管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeTenantReadableScn | 查詢租戶的最大可讀位點 | 該接口用于查詢租戶的最大可讀位點。 |
| CreateTenant | 創建租戶 | 創建一個租戶。 |
| CreateTenantReadOnlyConnection | 創建只讀地址 | 為指定租戶創建一個只讀地址。 |
| CreateTenantSecurityIpGroup | 創建租戶安全白名單信息 | 創建租戶安全白名單信息。 |
| DescribeTenants | 查詢集群下的租戶列表信息 | 查詢指定 OceanBase 集群列表下的租戶列表信息。 |
| DescribeInstanceTenantModes | 查詢租戶模式列表信息 | 該接口用于查詢租戶模式列表信息。 |
| DescribeTenant | 查詢指定集群下的指定租戶信息 | 查看指定集群下的指定租戶信息。 |
| DescribeAvailableCpuResource | 查詢可查詢的 CPU 資源信息 | 查詢創建租戶允許的 CPU 資源信息。 |
| DescribeAvailableMemResource | 查詢內存資源信息 | 查詢 OceanBase 租戶的內存資源信息。 |
| DescribeCharset | 獲取字符集 | 查詢 OceanBase 租戶的字符集信息。 |
| DescribeInstanceCreatableZone | 查詢可用區信息 | 查詢集群可創建主可用區的可用區信息。 |
| 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 信息或限流信息。 |
| DescribeSQLTuningAdvices | 查詢 SQL 的優化建議 | 查詢 SQL 的優化建議包括兩種：索引創建的建議、執行計劃綁定的建議。 |
安全設置
| API | 標題 | API概述 |
|---|---|---|
| ModifyInstanceSSL | 修改 SSL 配置 | 該接口用于修改實例的 SSL 配置。 |
| DescribeInstanceSSL | 查詢集群 SSL | 該接口用于查詢 OceanBase 集群的 SSL 詳情。 |
| CreateSecurityIpGroup | 創建白名單組 | 創建一個 IP 白名單組。 |
| DescribeSecurityIpGroups | 查詢 IP 安全白名單分組列表 | 查看 IP 安全白名單分組列表。 |
| DescribeTenantSecurityConfigs | 租戶安全配置檢測 | 租戶安全配置檢測。 |
| DescribeTenantEncryption | 查詢租戶加密信息 | 該接口用于查詢租戶加密信息。 |
| DescribeInstanceSecurityConfigs | 集群安全配置檢測 | 集群安全配置檢測。 |
| ModifySecurityIps | 修改 IP 列表 | 修改分組內的 IP 列表。 |
| ModifyTenantEncryption | 租戶開啟透明加密 | 租戶開啟透明加密。 |
| DeleteSecurityIpGroup | 刪除白名單分組 | 刪除 Oceanbase 集群的某個 IP 白名單分組。 |
監控管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeMetricsData | 查詢監控指標數據 | 該接口用于查詢 OceanBase 集群的單維度或者多維度監控指標數據。 |
| DescribeNodeMetrics | 查詢節點指標信息 | 查詢一個 OceanBase 節點指標信息。 |
| DescribeTenantMetrics | 查詢租戶指標信息 | 查詢指定 OceanBase 租戶指標信息。 |
數據傳輸
| API | 標題 | API概述 |
|---|---|---|
| CreateProject | 創建項目 | 本接口用于創建數據遷移或數據同步項目。 |
| StartProject | 啟動項目 | 本接口用于啟動數據遷移或數據同步項目。 |
| StopProject | 暫停項目 | 本接口用于暫停數據遷移或數據同步項目。 |
| ResumeProject | 恢復項目 | 本接口用于恢復數據遷移或數據同步項目。 |
| ReleaseProject | 釋放項目 | 本接口用于釋放數據遷移或數據同步項目。 |
| DeleteProject | 刪除項目 | 本接口用于刪除數據遷移或數據同步項目。 |
| ListProjects | 分頁查詢項目列表 | 本接口用于數據遷移或數據同步項目列表頁面的分頁查詢。 |
| DescribeProject | 查詢項目的詳情 | 本接口用于查詢數據遷移或數據同步項目的項目詳情。 |
| DescribeProjectSteps | 查詢項目步驟的詳情 | 本接口用于查詢數據遷移或數據同步項目運行步驟的詳情。 |
| DescribeProjectStepMetric | 查詢項目步驟的指標 | 本接口用于查詢數據遷移或數據同步項目的運行步驟的指標。 |
| DescribeProjectProgress | 查詢項目的進度 | 本接口用于查詢數據遷移或數據同步項目的進度信息。 |
| DescribeProjectComponents | 查詢項目的組件信息 | 本接口用于查詢數據遷移或數據同步項目的組件信息。 |
| ListProjectFullVerifyResult | 查詢項目的全量校驗結果 | 本接口用于查詢數據遷移項目的全量校驗結果。 |
| StartProjectsByLabel | 啟動指定標簽下所有未啟動的項目 | 本接口用于啟動指定標簽下，所有處于未啟動狀態的數據遷移或數據同步項目。 |
| StopProjectsByLabel | 暫停指定標簽下所有運行中的項目 | 本接口用于暫停指定標簽下，所有處于運行中狀態的數據遷移或數據同步項目。 |
| GetUploadOssUrl | 獲取上傳 OSS URL | 本接口用于公有云上傳 OSS，獲取一個臨時上傳 URL。 |
| ListWorkerInstances | 查詢傳輸實例列表 | 本接口用于查詢傳輸實例列表。 |
| CreateMySqlDataSource | 創建 MySQL 數據源 | 本接口用于創建 MySQL 數據源。 |
| CreateOceanBaseDataSource | 創建 OceanBase 數據源 | 本接口用于創建 OceanBase 數據源。 |
| ListDataSource | 查詢數據源列表 | 本接口用于查詢已創建數據源的列表。 |
| CreateLabel | 創建標簽 | 本接口用于創建標簽。 |
| ListAllLabels | 查詢標簽列表 | 本接口用于查詢已創建標簽的列表。 |
| CreateOmsMysqlDataSource | 創建 OMS MySQL 數據源 | 創建 OMS MySQL 數據源。 |
| ReleaseWorkerInstance | 釋放傳輸實例 | 本接口用于釋放傳輸實例。 |
| CancelProjectModifyRecord | 取消修改操作 | 該接口用于根據修改記錄的 ID 取消修改操作。 |
| RetryProjectModifyRecords | 重試修改操作 | 該接口用于根據修改記錄的 ID 重試修改操作。 |
| StopProjectModifyRecords | 終止修改操作 | 該接口用于根據修改記錄的 ID 終止修改操作。 |
| ListProjectModifyRecords | 查詢項目的修改記錄 | 該接口用于根據數據遷移或數據同步項目的 ID 查詢項目的修改記錄。 |
| CreateProjectModifyRecords | 修改傳輸對象 | 修改傳輸對象（加減表）(僅支持處于 RUNNING/FAILED/SUSPEND 狀態的項目) |
| UpdateProjectConfig | 更新項目配置 | 更新項目配置 Action=UpdateProjectConfig |
| DeleteDataSource | 刪除數據源 | 該接口用于刪除數據源。 |
| CreateRdsPostgreSQLDataSource | 創建 RDS PostgreSQL 數據源 | 該接口用于創建 RDS PostgreSQL 數據源。 |
備份恢復
| API | 標題 | API概述 |
|---|---|---|
| DescribeBackupSetDownloadLink | 獲取備份設置的下載鏈接 | 該接口用于查詢 OceanBase 備份設置下載鏈接。 |
| DescribeDataBackupSet | 查詢備份集信息 | 查詢 OceanBase 備份集信息。 |
| CreateBackupSetDownloadLink | 創建備份任務下載鏈接 | 創建 OceanBase 備份任務下載鏈接。 |
| DescribeRestorableTenants | 查詢可恢復租戶 | 查詢可恢復 OceanBase 租戶。 |