Open APIの概要|OceanBase Cloud|ドキュメント|OceanBaseマニュアル

Open API	タイトル	Open APIの概要
DescribeInstances	クラスタリストの取得	OceanBaseクラスタのリスト情報を照会します。
DescribeInstance	クラスタ情報の取得	OceanBaseクラスタの詳細情報を照会します。
CreateInstance	クラスタの作成	OceanBaseクラスタインスタンスを作成します。
DeleteInstance	クラスタの削除	OceanBaseクラスタインスタンスを削除します。
ModifyInstanceName	クラスタ名の変更	OceanBaseのクラスタ名を変更します。
DescribeNodeOptions	クラスタノード情報の照会	OceanBaseのクラスタノード情報を照会します。
StopCluster	クラスタインスタンスの一時停止	OceanBaseクラスタインスタンスを一時停止します。
StartCluster	クラスタインスタンスの起動	OceanBaseクラスタインスタンスを起動します。
ModifyInstanceSpec	クラスタ仕様の変更	OceanBaseのクラスタ仕様を変更します。
DescribeInstanceTopology	インスタンスのトポロジー構造情報の照会	インスタンスのトポロジー構造情報を照会します。
DescribeReadonlyInstances	読み取り専用レプリカ情報の取得	読み取り専用レプリカインスタンスの基本情報を照会します。
CreateReadonlyInstance	読み取り専用レプリカインスタンスの作成	読み取り専用レプリカインスタンスを作成します。
ModifyReadonlyInstanceSpec	読み取り専用レプリカインスタンス仕様の変更	読み取り専用レプリカインスタンス仕様を変更します。
ModifyReadonlyInstanceDiskSize	読み取り専用レプリカディスクサイズの変更	読み取り専用レプリカインスタンス仕様を変更します。
ModifyReadonlyInstanceNodeNum	読み取り専用レプリカノード数の変更	読み取り専用レプリカのノード数を変更します。
DeleteReadonlyInstance	読み取り専用レプリカインスタンスの削除	読み取り専用レプリカインスタンスを削除します。
DescribeInstanceAvailableRoZones	読み取り専用レプリカのゾーンの照会	読み取り専用レプリカのゾーンを照会します。
DescribeInstanceparameters	クラスタレベルパラメータの照会	クラスタレベルパラメータを照会します。
UpdateInstanceParameters	クラスタレベルパラメータの変更	クラスタレベルパラメータを変更します。
DescribeInstanceparametersHistory	クラスタレベルパラメータの変更履歴の照会	クラスタレベルパラメータの変更履歴を照会します。
ModifyInstanceTagList	インスタンスタグの変更	インスタンスタグを変更します。
ModifyInstanceNodeNum	クラスタノード数の変更	クラスタノード数を変更します。
DescribeInstanceAnomalyEvents	インスタンス異常イベントの照会	指定されたインスタンスで指定された期間に発生した異常イベント情報を照会します。
DescribeOasClusterAnomalySqlList	クラスタの疑わしいSQLリストの照会	指定されたインスタンスで指定された期間内の疑わしいSQLリストを照会します。
DescribeOasClusterSlowSQLList	クラスタのスロークエリリストの照会	指定されたインスタンスで指定された時間範囲内のスロークエリリストを照会します。

Open API	タイトル	Open APIの概要
DescribeTenants	クラスタ内のテナント一覧情報の取得	クラスタ内のテナント一覧情報を取得します。
DescribeTenant	指定クラスタ内の指定テナント情報の取得	指定クラスタ内の指定テナント情報を取得します。
CreateTenants	テナントの作成	テナントを作成します。
DeleteTenants	テナントの削除	指定されたOceanBaseクラスタ内の1つまたは複数のテナントを削除します。
ModifyTenantName	テナント名の変更	指定されたOceanBaseクラスタ内のテナント名を変更します。
ModifyTenant	テナントの変更	指定されたOceanBaseクラスタ内のテナント情報を変更します。
ModifyTenantUserDescription	テナントユーザー説明の変更	テナントユーザー説明を変更します。
ModifyTenantUserStatus	テナントユーザー状態の変更	テナントユーザー状態を変更します。
GetTenantCreateConstraints	テナント作成時の制約の取得	指定されたOceanBaseクラスタでテナント作成時の制約を取得します。
ModifyTenantPrimaryZone	テナントのプライマリゾーンの変更	テナントのプライマリゾーンを変更します。
GetTenantCreateCpuConstraints	テナント作成時のCPU制約の取得	指定されたOceanBaseクラスタでテナント作成時のCPU制約を取得します。
GetTenantCreateMemConstraints	テナント作成時のメモリ制約の取得	指定されたOceanBaseクラスタでテナント作成時のメモリ制約を取得します。
GetTenantModifyCpuConstraints	テナント変更時のCPU制約の取得	指定されたOceanBaseクラスタでテナント変更時のCPU制約を取得します。
GetTenantModifyMemConstraints	テナント変更時のメモリ制約の取得	指定されたOceanBaseクラスタでテナント変更時のメモリ制約を取得します。
CreateTenantSecurityIpGroup	テナントセキュリティ許可リスト情報の作成	テナントセキュリティ許可リスト情報を作成します。
DescribeTenantSecurityIpGroups	テナント許可リストグループ一覧の取得	テナント許可リストグループ一覧を取得します。
ModifyTenantSecurityIpGroup	テナント許可リストグループ情報の変更	テナント許可リストグループ情報を変更します。
DeleteTenantSecurityIpGroup	テナント許可リストグループ情報の削除	テナント許可リストグループ情報を削除します。
DescribeTenantPrivateLink	テナント接続情報の取得	テナントの接続情報を取得します。
DeletePrivatelinkConnection	テナント接続アドレスの削除	テナント接続アドレスを削除します。
CreatePrivatelinkService	テナント接続の有効化	テナントにPrivateLink接続を有効化します。
ConnectPrivatelinkService	PrivateLinkエンドポイントを介したデータベースへの接続	PrivateLinkエンドポイントを介してデータベースに接続します。
AddPrivatelinkServiceUser	ユーザー許可リストの追加	ユーザー許可リストを追加します。
BatchKillProcessList	指定テナントのセッションプロセスの一括終了	指定テナントのセッションプロセスを一括終了します。
DescribeProcessStatsComposition	セッションプロセス統計情報の取得	セッションプロセス統計情報を取得します。
DescribeTenantAddressInfo	テナントアドレス情報の取得	指定クラスタ内のテナントアドレス情報を取得します。
DescribeTenantAvailableRoZones	テナント読み取り専用レプリカの取得	テナント読み取り専用レプリカの基本情報を取得します。
ModifyTenantReadonlyReplica	テナント読み取り専用レプリカの変更	テナント読み取り専用レプリカを変更します。
DescribeTenantParameters	テナントレベルパラメータの取得	テナントレベルパラメータを取得します。
UpdateTenantParameters	テナントレベルパラメータの変更	テナントレベルパラメータを変更します。
DescribeTenantParametersHistory	テナントレベルパラメータ変更履歴の取得	テナントレベルパラメータ変更履歴を取得します。
ModifyTenantTagList	テナントタグの変更	テナントタグを変更します。
CreateReadonlyPrivatelink	テナントのプライベートネットワーク読み取り専用アドレスの作成	指定インスタンスのテナントにプライベートネットワーク読み取り専用アドレスを作成します。読み取りトラフィックと書き込みトラフィックを分離するシナリオに適しています。
CreateReadwritePrivatelink	テナントのプライベートネットワーク読み書き分離アドレスの作成	指定インスタンスのテナントにプライベートネットワーク読み書き分離アドレスを作成します。読み取りリクエストと書き込みリクエストを異なるノードに分散して処理し、同時実行処理能力を向上させます。

Open API	タイトル	Open APIの概要
CreateTenantUser	テナントユーザーの作成	指定テナント配下にデータベースへのアクセスアカウントを作成します。
DescribeTenantUsers	テナントアカウント一覧の取得	テナント配下のすべてのデータベースアクセスアカウント一覧を取得します。
DeleteTenantUsers	テナントユーザーの削除	1つまたは複数のデータベースアカウントを削除します。
ModifyTenantUserPassword	テナントユーザーパスワードの変更	テナント配下の指定データベースアカウントのログインパスワードを変更します。
ModifyTenantUserRoles	テナントユーザーロールの変更	テナント配下の指定データベースアカウントのロールを変更します。

Open API	タイトル	Open APIの概要
CreateDatabase	データベースの作成	指定したテナント配下に新しいデータベースを作成します。
DescribeDatabases	データベース一覧の取得	データベースの一覧を取得します。
DeleteDatabases	データベースの削除	作成された1つまたは複数のデータベースを削除します。
ModifyDatabaseUserRoles	データベースユーザーロールの変更	データベースユーザーロールを変更します。
DescribeTableSchema	テーブルスキーマの取得	指定したインスタンス内の特定テナント配下にある指定データテーブルのスキーマ情報を取得します。

Open API	タイトル	Open APIの概要
DescribeDataBackupSet	データバックアップセット情報の取得	データバックアップセット情報を取得します。
DescribeRestorableTenants	復元可能なテナントの取得	復元可能なテナントを取得します。
ModifyBackupStrategy	バックアップ戦略の変更	バックアップ戦略を変更します。
CreateTenantRestoreTask	テナント復元タスクの作成	テナント復元タスクを作成します。
CreateDataBackupTask	バックアップタスクの作成	バックアップタスクを作成します。
DescribeOneDataBackupSet	タスクIDを指定したバックアップセットの取得	タスクIDを指定してバックアップセットを取得します。
DescribeBackupStrategy	バックアップ戦略の取得	指定したOceanBase Cloudデータベースインスタンスのバックアップ戦略設定の詳細を取得します。
CreateBackupSetDownloadLink	バックアップセットダウンロードリンクの作成	指定したOceanBase Cloudデータベースインスタンスのバックアップセットのダウンロードリンクを作成します。
DescribeBackupSetDownloadLink	バックアップセットダウンロードリンクの取得	指定したOceanBase Cloudデータベースインスタンスのバックアップセットダウンロードタスクの詳細を取得します。

Open API	タイトル	Open APIの概要
CreateTenantAddress	テナントアドレスの作成	このAPIは、テナントアドレスを新規作成するために使用します。
CreateTenantSingleTunnelSLBAddres	テナントsingleTunnelSLBアドレスの作成	このAPIは、テナントsingleTunnelSLBアドレスを新規作成するために使用します。
DeleteTenantAddress	テナントアドレスの削除	このAPIは、テナントアドレスを削除するために使用します。
DescribeTenantAddress	テナントアドレスの取得	このAPIは、テナントアドレスを取得するために使用します。
ModifyOdpClusterSpec	データベースプロキシクラスタ仕様の変更	このAPIは、データベースプロキシクラスタの仕様を変更するために使用します。
ModifyTenantAddressPort	テナントアドレスポートの変更	このAPIは、テナントアドレスのポートを変更するために使用します。
ModifyTenantAddressDomainPrefix	テナントアドレスドメインプレフィックスの変更	このAPIは、テナントアドレスのドメインプレフィックスを変更するために使用します。
ConfirmPrivatelinkConnection	Private Link接続の確認	このAPIは、Private Link接続が完了したことを確認するために使用します。
DescribeTenantAddressInfo	すべてのテナントアドレス情報の取得	すべてのテナントアドレス情報を取得します。

Open API	タイトル	Open APIの概要
DescribeTenantMetrics	テナントメトリクス情報の取得	指定したOceanBaseテナントのメトリクス情報を取得します。
DescribeMetricsData	モニタリングメトリクスデータの取得	OceanBaseクラスタの単一次元または多次元のモニタリングメトリクスデータを取得します。
DescribeNodeMetrics	ノードメトリクス情報の取得	OceanBaseノードのメトリクス情報を取得します。
CreatePrometheusIntegration	Prometheus監視連携の作成	指定したOceanBase CloudデータベースインスタンスにPrometheus監視連携を作成し、Prometheusスクレイプ対象の設定ファイルを生成します。
DeletePrometheusIntegration	Prometheus監視連携の削除	設定済みのPrometheus監視連携を削除し、対応するインスタンスのモニタリングメトリクス収集を停止します。
ListPrometheusIntegration	Prometheus監視連携リストの取得	現在のプロジェクトで設定されているPrometheus監視連携のリストを取得します。

Open API	タイトル	Open APIの概要
DescribeOasTopSQLList	TopSQLリストのクエリ	診断システムが収集したSQL実行パフォーマンスデータのリストを照会します。
DescribeOasAnomalySQLList	疑わしいSQLリストのクエリ	診断システムがパフォーマンス問題が存在する可能性があると判断したSQLのリストを照会します。
DescribeOasSlowSQLList	スロークエリリストのクエリ	スロークエリリストを照会します。
DescribeSqlAudits	SQL監査情報のクエリ	OceanBase SQL監査情報を1件照会します。
DescribeOasSQLText	SQLテキストのクエリ	OceanBase SQLテキスト情報を1件照会します。
DescribeOutlineBinding	SQL Outlineバインディング情報のクエリ	SQL Outlineバインディング情報を照会します。
DescribeSampleSqlRawTexts	SQLの元のテキストサンプルのクエリ	SQLの元のテキストサンプルを照会します。
DescribeSQLTuningAdvices	SQLチューニングの推奨事項のクエリ	SQLチューニングの推奨事項を照会します。
DescribeOasSlowSQLSamples	スロークエリ実行詳細のサンプリングデータのクエリ	スロークエリ実行詳細のサンプリングデータを照会します。
DescribeOasSQLTrends	SQL実行履歴のクエリ	SQL実行履歴データを照会します。
DescribeOasSQLPlanGroup	SQL実行計画のクエリ	SQL実行計画を照会します。
DescribeRcaRecord	根本原因分析レコードのクエリ	指定インスタンス上の特定異常イベントの根本原因分析結果を照会します。
DescribeTopSQLComparision	SQL実行比較	指定期間内とベースライン期間内のTop SQLのパフォーマンスデータを比較します。
DescribeSessionStatsGroupBySqlId	SQL ID別にセッション統計情報を集計	指定インスタンスとテナントの全セッションの統計情報をSQL IDでグループ化して集計します。
DescribeIndexes	インデックス情報のクエリ	指定インスタンスとテナントの特定データベースとテーブルのインデックス情報を照会します。
DescribeOasHighRiskSQL	高リスクSQLのクエリ	指定インスタンスとテナントの特定期間内の高リスクSQLステートメントを照会します。

Open API	タイトル	Open APIの概要
CreateSecurityIpGroup	インスタンス許可リストグループの作成	インスタンス許可リストグループを作成します。
DescribeInstanceSSL	インスタンスのSSL設定情報のクエリ	インスタンスのSSL設定情報を照会します。
ModifyInstanceSSL	インスタンスのSSL設定の変更	インスタンスのSSL設定を変更します。
DescribeTenantEncryption	テナント暗号化情報のクエリ	テナント暗号化情報を照会します。
ModifyTenantEncryption	テナントで透過的データ暗号化を有効にする	テナントで透過的データ暗号化を有効にします。
ModifySecurityIps	インスタンス許可リスト内のIPリストの変更	インスタンス許可リスト内のIPリストを変更します。
DeleteSecurityIpGroup	インスタンス許可リストグループの削除	インスタンス許可リストグループを削除します。
DescribeTenantSecurityConfigs	テナントセキュリティ設定のチェック	テナントのセキュリティ設定をチェックし、各テナントのチェック結果とリスク項目を返します。
DescribeInstanceSecurityConfigs	クラスタセキュリティ設定のチェック	クラスタのセキュリティ設定をチェックし、クラスタレベルのチェック結果とリスク項目を返します。

Open API	タイトル	Open APIの概要
DescribeTags	タグリストのクエリ	現在の組織のタグリストを照会し、タグkeyと対応するvalueの集合を返します。
CreateTags	タグの一括作成	現在の組織でタグを一括作成します。
UpdateTag	タグの更新	指定されたタグのkeyとvalueを更新します。
DeleteTag	タグの削除	指定されたタグを削除します。

Open API	タイトル	Open APIの概要
DescribeOperationEvents	過去のイベントの取得	過去のイベント情報を照会します。

Open API	タイトル	Open APIの概要
CreateAIServiceAPIKey	AI APIキーの作成	新しいAI APIキーを作成します。
DeleteAIServiceAPIKey	AI APIキーの削除	APIキーの一意の識別子（UUID）に基づいて、指定されたプロジェクトの下のAPIキーを削除します。
ListAIServiceAPIKeys	APIキーの一覧の取得	指定された組織とプロジェクトの下のAPIキーのリストをページネーションで取得します。

Open API	タイトル	Open APIの概要
ListDataSources	データソースリストの取得	現在のプロジェクトの下のデータソースリストを取得します。
CreateDataSource	データソースの作成	新しいデータソース設定を作成します。
DeleteDataSource	データソースの削除	指定されたデータソースを削除します。

Open API	タイトル	Open APIの概要
CreateProject	プロジェクトの作成	データ移行または同期プロジェクトを作成します。
DeleteProject	プロジェクトの削除	指定したOMSプロジェクトを削除します。
DescribeProject	プロジェクトの詳細の確認	OMSプロジェクトの詳細情報を照会します。
DescribeProjectSteps	プロジェクトのステップの確認	プロジェクトの実行ステップリストを照会します。
StartProject	プロジェクトの開始	指定したOMSプロジェクトを開始します。
StopProject	プロジェクトの停止	実行中のOMSプロジェクトを停止します。
ResumeProject	プロジェクトの再開	一時停止されたOMSプロジェクトを再開します。
ReleaseProject	プロジェクトの解放	データ移行/同期プロジェクトのリソースを解放します。
UpdateProjectConfig	プロジェクト設定の更新	OMSプロジェクトの構成パラメータを更新します。
ListProjectModifyRecords	プロジェクト変更履歴の確認	OMSプロジェクトの変更履歴リストを照会します。
CreateProjectModifyRecords	変更履歴の一括作成	OMSプロジェクトの変更履歴を一括作成します。
CancelProjectModifyRecord	変更履歴の取り消し	指定したプロジェクト変更履歴を取り消します。
RetryProjectModifyRecords	変更履歴の再試行	変更履歴IDに基づいて、変更操作を再試行します。
StopProjectModifyRecords	変更履歴の終了	実行中の変更履歴を終了します。
GetModifyRecord	変更履歴の詳細の確認	変更履歴IDに基づいて詳細を照会します。
DescribeTransferMapping	転送オブジェクトマッピングの確認	プロジェクトの転送オブジェクトマッピング設定を照会します。

Open APIの概要

クラスタ管理

テナント管理

テナントアカウント管理

データベース管理

バックアップ・リストア

データベースプロキシ管理

モニタリング管理

診断管理

セキュリティ管理

タグ管理

過去のイベント管理

AIサービス

データソース管理

OMSプロジェクト管理

関連リンク