本產(chǎn)品（
云數(shù)據(jù)庫(kù) OceanBase 版/2019-09-01）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見(jiàn)簽名機(jī)制說(shuō)明。我們已經(jīng)為開(kāi)發(fā)者封裝了常見(jiàn)編程語(yǔ)言的SDK，開(kāi)發(fā)者可通過(guò)下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無(wú)需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過(guò)簽名機(jī)制進(jìn)行自簽名對(duì)接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費(fèi) 5個(gè)工作日左右。因此建議加入我們的服務(wù)釘釘群（78410016550），在專家指導(dǎo)下進(jìn)行簽名對(duì)接。在使用API前，您需要準(zhǔn)備好身份賬號(hào)及訪問(wèn)密鑰（AccessKey），才能有效通過(guò)客戶端工具（SDK、CLI等）訪問(wèn)API。細(xì)節(jié)請(qǐng)參見(jiàn)獲取AccessKey。
標(biāo)簽管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifyTagValueName | 修改標(biāo)簽名 | 該接口用于修改標(biāo)簽名稱。 |
| ModifyTagName | 修改標(biāo)簽組名 | 該接口用于修改標(biāo)簽組的名稱。 |
| DescribeTagValues | 查詢標(biāo)簽 | 該接口用于查詢標(biāo)簽。 |
| DeleteTagValue | 刪除標(biāo)簽 | 該接口用于刪除標(biāo)簽。 |
| DeleteTag | 刪除標(biāo)簽組 | 該接口用于刪除標(biāo)簽組。 |
| CreateTagValue | 創(chuàng)建標(biāo)簽 | 該接口用于新建標(biāo)簽。 |
| CreateTag | 創(chuàng)建標(biāo)簽組 | 該接口用于新建標(biāo)簽組。 |
| ModifyInstanceTags | 修改集群標(biāo)簽值 | 該接口用于修改集群的標(biāo)簽值。 |
| DescribeTenantTags | 查詢租戶標(biāo)簽值 | 該接口用于查詢租戶的標(biāo)簽值。 |
| ModifyTenantTags | 修改租戶標(biāo)簽值 | 該接口用于修改租戶的標(biāo)簽值。 |
| DescribeInstanceTags | 查詢集群標(biāo)簽值 | 查詢集群的標(biāo)簽值。 |
集群管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateInstance | 創(chuàng)建集群 | 創(chuàng)建一個(gè) OceanBase 數(shù)據(jù)庫(kù)集群。 |
| DescribeInstance | 查詢集群信息 | 查詢一個(gè) OceanBase 集群的詳細(xì)信息。 |
| DescribeInstances | 查詢集群列表 | 查詢 OceanBase 集群列表信息。 |
| DescribeInstanceTopology | 查詢集群拓?fù)湫畔?/span> | 查詢某個(gè) OceanBase 集群的拓?fù)湫畔ⅰ?/span> |
| DescribeAvailableSpec | 查詢集群變配可選配置 | 查詢 OceanBase 集群變配頁(yè)可選配置。 |
| DescribeAvailableZone | 查詢創(chuàng)建集群可選配置 | 查詢 OceanBase 集群售賣頁(yè)可選配置。 |
| ModifyInstanceName | 修改集群名稱 | 修改 OceanBase 的集群名稱。 |
| ModifyInstanceSpec | 修改集群規(guī)格和存儲(chǔ)空間 | 修改集群規(guī)格和存儲(chǔ)空間。 |
| ModifyInstanceNodeNum | 修改集群節(jié)點(diǎn)個(gè)數(shù) | 修改集群節(jié)點(diǎn)個(gè)數(shù)。 |
| ModifyInstanceTemporaryCapacity | 修改集群臨時(shí)容量 | 修改 OceanBase 集群臨時(shí)容量。 |
| SwitchoverInstance | 切換主備實(shí)例 | 切換 OceanBase 主備實(shí)例。 |
| RemoveStandbyInstance | 解耦備實(shí)例 | 備實(shí)例解耦 |
| DeleteInstances | 釋放 OceanBase 實(shí)例 | 調(diào)用接口釋放 OceanBase 實(shí)例。 |
| DescribeInstanceSummary | 獲取實(shí)例概覽信息 | 獲取 OceanBase 實(shí)例概覽信息。 |
租戶管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeTenantReadableScn | 查詢租戶的最大可讀位點(diǎn) | 該接口用于查詢租戶的最大可讀位點(diǎn)。 |
| CreateTenant | 創(chuàng)建租戶 | 創(chuàng)建一個(gè)租戶。 |
| CreateTenantReadOnlyConnection | 創(chuàng)建只讀地址 | 為指定租戶創(chuàng)建一個(gè)只讀地址。 |
| CreateTenantSecurityIpGroup | 創(chuàng)建租戶安全白名單信息 | 創(chuàng)建租戶安全白名單信息。 |
| DescribeTenants | 查詢集群下的租戶列表信息 | 查詢指定 OceanBase 集群列表下的租戶列表信息。 |
| DescribeInstanceTenantModes | 查詢租戶模式列表信息 | 該接口用于查詢租戶模式列表信息。 |
| DescribeTenant | 查詢指定集群下的指定租戶信息 | 查看指定集群下的指定租戶信息。 |
| DescribeAvailableCpuResource | 查詢可查詢的 CPU 資源信息 | 查詢創(chuàng)建租戶允許的 CPU 資源信息。 |
| DescribeAvailableMemResource | 查詢內(nèi)存資源信息 | 查詢 OceanBase 租戶的內(nèi)存資源信息。 |
| DescribeCharset | 獲取字符集 | 查詢 OceanBase 租戶的字符集信息。 |
| DescribeInstanceCreatableZone | 查詢可用區(qū)信息 | 查詢集群可創(chuàng)建主可用區(qū)的可用區(qū)信息。 |
| DescribeTenantZonesRead | 查詢租戶只讀可用區(qū)信息 | 查詢租戶的只讀可用區(qū)信息。 |
| DescribeTimeZones | 獲取時(shí)區(qū)列表 | 查詢 OceanBase 租戶的時(shí)區(qū)信息。 |
| DescribeTenantSecurityIpGroups | 查看租戶白名單分組列表 | 查看租戶白名單分組列表。 |
| DescribeZones | 獲取可用區(qū)信息 | 獲取一個(gè)阿里云地域下可創(chuàng)建集群的可用區(qū)信息。 |
| ModifyTenantPrimaryZone | 切換租戶主可用區(qū) | 切換租戶的主可用區(qū)。 |
| ModifyTenantResource | 修改租戶資源 | 修改指定 OceanBase 集群的一個(gè)租戶的規(guī)格。 |
| ModifyTenantSecurityIpGroup | 修改租戶白名單分組信息 | 修改租戶白名單分組信息。 |
| DeleteTenants | 刪除租戶 | 刪除指定 OceanBase 集群下的一個(gè)或多個(gè)租戶。 |
| DeleteTenantSecurityIpGroup | 刪除租戶白名單分組信息 | 刪除租戶白名單分組信息。 |
租戶賬號(hào)管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateTenantUser | 創(chuàng)建租戶用戶 | 在指定租戶下創(chuàng)建一個(gè)訪問(wèn)數(shù)據(jù)庫(kù)的賬號(hào)。 |
| DescribeTenantUsers | 查詢租戶賬號(hào)列表 | 查詢一個(gè)租戶下所有數(shù)據(jù)庫(kù)訪問(wèn)的賬號(hào)列表。 |
| DescribeTenantUserRoles | 獲取普通用戶的權(quán)限配置信息 | 獲取普通用戶的權(quán)限配置信息。 |
| ModifyTenantUserDescription | 修改租戶賬號(hào)備注信息 | 修改租戶下指定的數(shù)據(jù)庫(kù)賬號(hào)的備注信息。 |
| ModifyTenantUserPassword | 修改租戶用戶密碼 | 修改租戶下指定的數(shù)據(jù)庫(kù)賬號(hào)的登錄密碼。 |
| ModifyTenantUserRoles | 修改租戶用戶角色 | 修改租戶下指定賬號(hào)可訪問(wèn)的數(shù)據(jù)庫(kù)權(quán)限信息。 |
| DeleteTenantUsers | 刪除租戶用戶 | 刪除一個(gè)或多個(gè)數(shù)據(jù)庫(kù)賬號(hào)列表。 |
數(shù)據(jù)庫(kù)管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateDatabase | 創(chuàng)建數(shù)據(jù)庫(kù) | 在指定租戶下創(chuàng)建一個(gè)新的數(shù)據(jù)庫(kù)。 |
| DescribeDatabases | 查詢數(shù)據(jù)庫(kù)列表 | 查詢租戶下的數(shù)據(jù)庫(kù)列表。 |
| ModifyDatabaseDescription | 修改數(shù)據(jù)庫(kù)描述 | 修改數(shù)據(jù)庫(kù)的描述信息。 |
| ModifyTenantUserStatus | 鎖定或解鎖指定的數(shù)據(jù)庫(kù)賬號(hào) | 該接口用于鎖定或解鎖指定的數(shù)據(jù)庫(kù)賬號(hào)。 |
| ModifyDatabaseUserRoles | 修改數(shù)據(jù)庫(kù)用戶角色 | 修改某一數(shù)據(jù)庫(kù)的賬號(hào)權(quán)限信息。 |
| DeleteDatabases | 刪除數(shù)據(jù)庫(kù) | 刪除一個(gè)或多個(gè)已創(chuàng)建的數(shù)據(jù)庫(kù)。 |
參數(shù)管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeParameters | 查看參數(shù)信息列表 | 查看參數(shù)信息列表。 |
| DescribeParametersHistory | 查看參數(shù)修改歷史 | 查看集群或租戶的參數(shù)修改歷史。 |
| ModifyParameters | 修改參數(shù) | 修改集群或租戶的參數(shù)。 |
會(huì)話連接
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeSessionList | 查詢會(huì)話列表 | 該接口用于展示 OceanBase 云服務(wù)和業(yè)務(wù)之間的會(huì)話信息。 |
| BatchKillSessionList | 批量關(guān)閉會(huì)話列表 | 該接口用于批量關(guān)閉 OceanBase 云服務(wù)和業(yè)務(wù)之間的會(huì)話信息。該接口為異步執(zhí)行，需要用戶通過(guò) DescribeSessionList 驗(yàn)證會(huì)話是否關(guān)閉成功。 |
| BatchKillProcessList | 批量關(guān)閉會(huì)話 | 該接口為異步執(zhí)行，用于批量關(guān)閉會(huì)話，需要用戶通過(guò)接口 DescribeProcessStatsComposition 二次確認(rèn)。 |
| DescribeProcessStatsComposition | 查詢會(huì)話信息 | 該接口用于查詢會(huì)話信息。 |
| KillProcessList | 關(guān)閉指定的會(huì)話 | 關(guān)閉指定的會(huì)話。 |
診斷管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeOasAnomalySQLList | 查詢可疑 SQL 列表 | 該接口用于查詢?cè)\斷系統(tǒng)判定可能存在性能問(wèn)題的 SQL 列表。 |
| DescribeSampleSqlRawTexts | 查詢采樣SQL的原始文本 | 該接口用于查詢采樣 SQL 的原始文本。 |
| DescribeOasSQLDetails | 查詢 SQL 詳細(xì)信息 | 查詢 SQL 詳細(xì)信息，包括 SQL 文本、涉及的表名等信息。 |
| DescribeOasSQLPlans | 查詢 SQL 執(zhí)行計(jì)劃 | 根據(jù) SQLID 查詢?cè)\斷系統(tǒng)存儲(chǔ)的 SQL 執(zhí)行計(jì)劃信息。 |
| DescribeSQLSamples | 查詢慢 SQL 執(zhí)行明細(xì)的采樣數(shù)據(jù) | 查詢慢 SQL 執(zhí)行明細(xì)的采樣數(shù)據(jù)。 |
| DescribeOasSQLHistoryList | 查詢 SQL 執(zhí)行歷史 | 查詢 SQL 執(zhí)行歷史信息。 |
| DescribeOasTopSQLList | 查詢 TopSQL 列表 | 查詢?cè)\斷系統(tǒng)采集到的 SQL 執(zhí)行性能數(shù)據(jù)列表。 |
| DescribeOasSlowSQLList | 查詢慢 SQL 列表 | 該接口用于查詢慢 SQL 列表。 |
| DescribeOutlineBinding | 查詢 Outline 綁定信息 | 根據(jù) SQLID 查詢一條 SQL 在數(shù)據(jù)庫(kù)中被綁定的 Outline 信息或限流信息。 |
| DescribeSQLTuningAdvices | 查詢 SQL 的優(yōu)化建議 | 查詢 SQL 的優(yōu)化建議包括兩種：索引創(chuàng)建的建議、執(zhí)行計(jì)劃綁定的建議。 |
安全設(shè)置
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifyInstanceSSL | 修改 SSL 配置 | 該接口用于修改實(shí)例的 SSL 配置。 |
| DescribeInstanceSSL | 查詢集群 SSL | 該接口用于查詢 OceanBase 集群的 SSL 詳情。 |
| CreateSecurityIpGroup | 創(chuàng)建白名單組 | 創(chuàng)建一個(gè) IP 白名單組。 |
| DescribeSecurityIpGroups | 查詢 IP 安全白名單分組列表 | 查看 IP 安全白名單分組列表。 |
| DescribeTenantSecurityConfigs | 租戶安全配置檢測(cè) | 租戶安全配置檢測(cè)。 |
| DescribeTenantEncryption | 查詢租戶加密信息 | 該接口用于查詢租戶加密信息。 |
| DescribeInstanceSecurityConfigs | 集群安全配置檢測(cè) | 集群安全配置檢測(cè)。 |
| ModifySecurityIps | 修改 IP 列表 | 修改分組內(nèi)的 IP 列表。 |
| ModifyTenantEncryption | 租戶開(kāi)啟透明加密 | 租戶開(kāi)啟透明加密。 |
| DeleteSecurityIpGroup | 刪除白名單分組 | 刪除 Oceanbase 集群的某個(gè) IP 白名單分組。 |
監(jiān)控管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeMetricsData | 查詢監(jiān)控指標(biāo)數(shù)據(jù) | 該接口用于查詢 OceanBase 集群的單維度或者多維度監(jiān)控指標(biāo)數(shù)據(jù)。 |
| DescribeNodeMetrics | 查詢節(jié)點(diǎn)指標(biāo)信息 | 查詢一個(gè) OceanBase 節(jié)點(diǎn)指標(biāo)信息。 |
| DescribeTenantMetrics | 查詢租戶指標(biāo)信息 | 查詢指定 OceanBase 租戶指標(biāo)信息。 |
數(shù)據(jù)傳輸
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateProject | 創(chuàng)建任務(wù) | 本接口用于創(chuàng)建數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)。 |
| StartProject | 啟動(dòng)任務(wù) | 本接口用于啟動(dòng)數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)。 |
| StopProject | 暫停任務(wù) | 本接口用于暫停數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)。 |
| ResumeProject | 恢復(fù)任務(wù) | 本接口用于恢復(fù)數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)。 |
| ReleaseProject | 釋放任務(wù) | 本接口用于釋放數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)。 |
| DeleteProject | 刪除任務(wù) | 本接口用于刪除數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)。 |
| ListProjects | 分頁(yè)查詢?nèi)蝿?wù)列表 | 本接口用于數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)列表頁(yè)面的分頁(yè)查詢。 |
| DescribeProject | 查詢?nèi)蝿?wù)的詳情 | 本接口用于查詢數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)的任務(wù)詳情。 |
| DescribeProjectSteps | 查詢?nèi)蝿?wù)步驟的詳情 | 本接口用于查詢數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)運(yùn)行步驟的詳情。 |
| DescribeProjectStepMetric | 查詢?nèi)蝿?wù)步驟的指標(biāo) | 本接口用于查詢數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)的運(yùn)行步驟的指標(biāo)。 |
| DescribeProjectProgress | 查詢?nèi)蝿?wù)的進(jìn)度 | 本接口用于查詢數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)的進(jìn)度信息。 |
| DescribeProjectComponents | 查詢?nèi)蝿?wù)的組件信息 | 本接口用于查詢數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)的組件信息。 |
| ListProjectFullVerifyResult | 查詢?nèi)蝿?wù)的全量校驗(yàn)結(jié)果 | 本接口用于查詢數(shù)據(jù)遷移任務(wù)的全量校驗(yàn)結(jié)果。 |
| StartProjectsByLabel | 啟動(dòng)指定標(biāo)簽下所有未啟動(dòng)的任務(wù) | 本接口用于啟動(dòng)指定標(biāo)簽下，所有處于未啟動(dòng)狀態(tài)的數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)。 |
| StopProjectsByLabel | 暫停指定標(biāo)簽下所有運(yùn)行中的任務(wù) | 本接口用于暫停指定標(biāo)簽下，所有處于運(yùn)行中狀態(tài)的數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)。 |
| GetUploadOssUrl | 獲取上傳 OSS URL | 本接口用于公有云上傳 OSS，獲取一個(gè)臨時(shí)上傳 URL。 |
| ListWorkerInstances | 查詢傳輸實(shí)例列表 | 本接口用于查詢傳輸實(shí)例列表。 |
| CreateMySqlDataSource | 創(chuàng)建 MySQL 數(shù)據(jù)源 | 本接口用于創(chuàng)建 MySQL 數(shù)據(jù)源。 |
| CreateOceanBaseDataSource | 創(chuàng)建 OceanBase 數(shù)據(jù)源 | 本接口用于創(chuàng)建 OceanBase 數(shù)據(jù)源。 |
| ListDataSource | 查詢數(shù)據(jù)源列表 | 本接口用于查詢已創(chuàng)建數(shù)據(jù)源的列表。 |
| CreateLabel | 創(chuàng)建標(biāo)簽 | 本接口用于創(chuàng)建標(biāo)簽。 |
| ListAllLabels | 查詢標(biāo)簽列表 | 本接口用于查詢已創(chuàng)建標(biāo)簽的列表。 |
| CreateOmsMysqlDataSource | 創(chuàng)建 OMS MySQL 數(shù)據(jù)源 | 創(chuàng)建 OMS MySQL 數(shù)據(jù)源。 |
| ReleaseWorkerInstance | 釋放傳輸實(shí)例 | 本接口用于釋放傳輸實(shí)例。 |
| CancelProjectModifyRecord | 取消修改操作 | 該接口用于根據(jù)修改記錄的 ID 取消修改操作。 |
| RetryProjectModifyRecords | 重試修改操作 | 該接口用于根據(jù)修改記錄的 ID 重試修改操作。 |
| StopProjectModifyRecords | 終止修改操作 | 該接口用于根據(jù)修改記錄的 ID 終止修改操作。 |
| ListProjectModifyRecords | 查詢?nèi)蝿?wù)的修改記錄 | 該接口用于根據(jù)數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)的 ID 查詢?nèi)蝿?wù)的修改記錄。 |
| CreateProjectModifyRecords | 修改傳輸對(duì)象 | 本接口用于修改處于運(yùn)行中、失敗或已暫停狀態(tài)的數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)的遷移/同步對(duì)象。 |
| UpdateProjectConfig | 更新任務(wù)配置 | 本接口用于更新數(shù)據(jù)遷移或數(shù)據(jù)同步任務(wù)的配置。 |
| DeleteDataSource | 刪除數(shù)據(jù)源 | 該接口用于刪除數(shù)據(jù)源。 |
| CreateRdsPostgreSQLDataSource | 創(chuàng)建 RDS PostgreSQL 數(shù)據(jù)源 | 該接口用于創(chuàng)建 RDS PostgreSQL 數(shù)據(jù)源。 |
備份恢復(fù)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeBackupSetDownloadLink | 獲取備份設(shè)置的下載鏈接 | 該接口用于查詢 OceanBase 備份設(shè)置下載鏈接。 |
| DescribeDataBackupSet | 查詢備份集信息 | 查詢 OceanBase 備份集信息。 |
| CreateBackupSetDownloadLink | 創(chuàng)建備份任務(wù)下載鏈接 | 創(chuàng)建 OceanBase 備份任務(wù)下載鏈接。 |
| DescribeRestorableTenants | 查詢可恢復(fù)租戶 | 查詢可恢復(fù) OceanBase 租戶。 |