Open APIの概要|OceanBase Cloud|ドキュメント|分散データベース

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	クラスタのスローSQLリストの照会	指定したインスタンスで、指定した時間範囲内のスローSQLリストを照会します。

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バックアップセットを取得します。

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監視統合の作成	指定したOB CloudデータベースインスタンスにPrometheus監視統合を作成し、Prometheusスナップショット対象の設定ファイルを生成します。
DeletePrometheusIntegration	Prometheus監視統合の削除	既に設定されているPrometheus監視統合を削除し、対応するインスタンスのモニタリングメトリクス収集を停止します。
ListPrometheusIntegration	Prometheus監視統合リストの取得	現在のプロジェクトで設定されているPrometheus監視統合のリストを取得します。

Open API	タイトル	Open APIの概要
DescribeOasTopSQLList	TopSQLリストのクエリ	診断システムが収集したSQL実行パフォーマンスデータのリストを照会します。
DescribeOasAnomalySQLList	疑わしいSQLリストのクエリ	診断システムがパフォーマンス問題が存在する可能性があると判断したSQLのリストを照会します。
DescribeOasSlowSQLList	SlowSQLリストのクエリ	Slow SQLリストを照会します。
DescribeSqlAudits	SQL監査情報のクエリ	OceanBaseのSQL監査情報を1件照会します。
DescribeOasSQLText	SQLテキストのクエリ	OceanBaseのSQLテキスト情報を1件照会します。
DescribeOutlineBinding	SQL Outlineバインディング情報のクエリ	SQL Outlineバインディング情報を照会します。
DescribeSampleSqlRawTexts	SQL原始テキストサンプルのクエリ	SQL原始テキストのサンプルを照会します。
DescribeSQLTuningAdvices	SQLチューニングの推奨事項のクエリ	SQLチューニングの推奨事項を照会します。
DescribeOasSlowSQLSamples	Slow SQL実行明細のサンプリングデータのクエリ	Slow SQL実行明細のサンプリングデータを照会します。
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キーを作成します。
ListAIServiceAPIKeys	APIキーの一覧表示	指定された組織およびプロジェクトの下で、APIキーのリストをページネーションで照会します。

OceanBase

顧客事例

Open APIの概要

クラスタ管理

テナント管理

テナントアカウント管理

データベース管理

バックアップとリカバリ

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

モニタリング管理

診断管理

セキュリティ管理

タグ管理

過去のイベント管理

AIサービス

関連情報