API 標準および多言語対応の SDK
本製品 (OceanBasePro/2019-09-01) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
タグ管理
|
API |
タイトル |
説明 |
| ModifyTagValueName | ModifyTagValueName | この操作を呼び出して、タグの値を変更できます。 |
| ModifyTagName | タググループ名の変更 | この API は、タググループの名前を変更します。 |
| DescribeTagValues | DescribeTagValues | この API を呼び出してタグを照会できます。 |
| DeleteTagValue | DeleteTagValue | この操作を呼び出して、タグキーからタグ値を削除します。 |
| DeleteTag | DeleteTag | このオペレーションでは、タググループを削除できます。 |
| CreateTagValue | CreateTagValue | この操作を呼び出すと、タグを作成できます。 |
| CreateTag | CreateTag | この API を呼び出して、タググループを作成できます。 |
| ModifyInstanceTags | ModifyInstanceTags | このオペレーションを呼び出すと、クラスターのタグを変更できます。 |
| DescribeTenantTags | DescribeTenantTags | この操作では、クラスター内のテナントのタグを照会できます。 |
| ModifyTenantTags | ModifyTenantTags | このオペレーションを呼び出すと、テナントのタグを変更できます。 |
| DescribeInstanceTags | DescribeInstanceTags | この API を呼び出して、クラスターのタグを照会できます。 |
クラスター管理
|
API |
タイトル |
説明 |
| CreateInstance | クラスターの作成 | OceanBase データベースクラスターを作成します。 |
| DescribeInstance | DescribeInstance | OceanBase クラスターの詳細を照会します。 |
| DescribeInstances | クラスターリストの照会 | ApsaraDB for OceanBase クラスターのリストを取得します。 |
| DescribeInstanceTopology | クラスタートポロジー情報を照会する | OceanBase クラスターのトポロジー情報を取得します。 |
| DescribeAvailableSpec | クラスターのスペック変更に使用可能な構成を照会します | OceanBase クラスターのスペック変更に使用可能な構成を照会します。 |
| DescribeAvailableZone | クラスター作成の利用可能な設定を照会します | OceanBase クラスターの購入ページで利用可能な設定を照会します。 |
| DescribeInstanceCreatableZone | ゾーン情報の照会 | インスタンスを作成できるゾーンを照会します。 |
| ModifyInstanceName | ModifyInstanceName | この操作を呼び出して、OceanBase クラスターの名前を変更できます。 |
| ModifyInstanceSpec | クラスターのスペックおよびストレージ容量の変更 | クラスターの仕様とストレージ領域を変更します。 |
| ModifyInstanceNodeNum | ModifyInstanceNodeNum | このオペレーションの呼び出しにより、クラスター内のノード数を変更できます。 |
| ModifyInstanceTemporaryCapacity | クラスターの仮容量を変更 | OceanBase クラスターの一時的な容量を変更します。 |
| SwitchoverInstance | SwitchoverInstance | この API を呼び出して、OceanBase のプライマリインスタンスとスタンバイインスタンスのスイッチオーバーを実行できます。 |
| RemoveStandbyInstance | RemoveStandbyInstance | このオペレーションを呼び出すと、スタンバイインスタンスをプライマリインスタンスから切り離せます。 |
| DeleteInstances | DeleteInstances | この API を呼び出して、OceanBase クラスターを削除できます。 |
| DescribeInstanceSummary | DescribeInstanceSummary | OceanBase インスタンスの概要情報を取得します。 |
| DescribeStandbyCreateMode | スタンバイクラスター作成モードの取得 | スタンバイクラスターの作成モードを照会します。 |
テナント管理
|
API |
タイトル |
説明 |
| DescribeTenantReadableScn | DescribeTenantReadableScn | このオペレーションを呼び出して、テナントの最大読み取り可能 SCN を照会します。 |
| CreateTenant | CreateTenant | この操作を呼び出してテナントを作成できます。 |
| CreateTenantReadOnlyConnection | 読み取り専用エンドポイントの作成 | 指定されたテナントの読み取り専用アドレスを作成します。 |
| CreateTenantSecurityIpGroup | CreateTenantSecurityIpGroup | この API を呼び出すと、テナントのセキュリティ IP グループを作成できます。 |
| DescribeTenants | DescribeTenants | 指定された OceanBase クラスターのテナント情報を一覧表示します。 |
| DescribeInstanceTenantModes | テナントモードリスト情報のクエリ | リクエストの戻り結果です。 |
| DescribeTenant | 指定されたクラスター内の指定されたテナント情報を照会します。 | 指定されたクラスター内の指定されたテナントに関する情報を表示します。 |
| DescribeAvailableCpuResource | アクティブな CPU リソース情報をクエリします。 | テナントで利用可能な CPU リソースをクエリします。 |
| DescribeAvailableMemResource | DescribeAvailableMemResource | この API を呼び出して、OceanBase Database テナントの使用可能なメモリリソースを照会します。 |
| DescribeCharset | 文字セットを取得します | OceanBase テナントの文字セット情報を照会します。 |
| DescribeInstanceAvailableZones | DescribeInstanceAvailableZones | この API を呼び出すことで、プライマリゾーンとして設定できるクラスターのゾーンを照会できます。 |
| DescribeTenantZonesRead | テナントの読み取り専用ゾーン情報を照会する | API を迅速に取得し、デバッグできるオンライン CLI ツールです。実行可能な SDK コードサンプルを動的に生成できます。 |
| DescribeTimeZones | タイムゾーンリストの取得 | API を迅速に取得し、デバッグできるオンライン CLI ツールです。実行可能な SDK コードサンプルを動的に生成できます。 |
| DescribeTenantSecurityIpGroups | DescribeTenantSecurityIpGroups | このオペレーションを呼び出すと、テナントのホワイトリストグループのリストを取得できます。 |
| DescribeZones | ゾーン情報を取得する | 使用可能なゾーンを照会します。 |
| ModifyTenantPrimaryZone | テナントのプライマリゾーンの切り替え | Alibaba Cloud CLI |
| ModifyTenantResource | ModifyTenantResource | この API は、OceanBase クラスター内のテナントの仕様を変更します。 |
| ModifyTenantSecurityIpGroup | ModifyTenantSecurityIpGroup | この API は、テナントのセキュリティ IP グループの情報を変更します。 |
| DeleteTenants | テナントの削除 | この API を呼び出して、OceanBase クラスターから 1 つ以上のテナントを削除できます。 |
| DeleteTenantSecurityIpGroup | DeleteTenantSecurityIpGroup | このオペレーションを呼び出して、テナントのセキュリティ IP グループの情報を削除できます。 |
テナントアカウント管理
|
API |
タイトル |
説明 |
| CreateTenantUser | テナントユーザーを作成します | 指定されたテナントの下にデータベースアカウントを作成します。 |
| DescribeTenantUsers | テナントアカウントリストのクエリ | テナント配下のデータベースアクセスアカウントのリストを照会します。 |
| DescribeTenantUserRoles | DescribeTenantUserRoles | このオペレーションを呼び出して、テナントアカウントの認可情報を取得できます。 |
| ModifyTenantUserDescription | ModifyTenantUserDescription | この API を呼び出して、テナント内の指定されたアカウントの説明を変更できます。 |
| ModifyTenantUserPassword | テナントユーザーパスワードを変更します | テナント配下の指定されたデータベースアカウントのログインパスワードを変更します。 |
| ModifyTenantUserRoles | テナントユーザーのロールを変更する | テナント内の指定したアカウントのデータベース権限を変更します。 |
| DeleteTenantUsers | DeleteTenantUsers | このオペレーションを呼び出すと、1 つ以上のデータベースアカウントを削除できます。 |
データベース管理
|
API |
タイトル |
説明 |
| CreateDatabase | データベースの作成 | Alibaba Cloud は、さまざまな言語の SDK を提供しており、API を使用して Alibaba Cloud の製品やサービスを迅速に統合するのに役立ちます。API の呼び出しには SDK の使用を推奨します。この方法では、署名検証は不要です。 |
| DescribeDatabases | DescribeDatabases | このオペレーションを呼び出すと、テナント内のデータベースをクエリできます。 |
| ModifyDatabaseDescription | データベースの説明を変更 | データベースの説明を変更します。 |
| ModifyTenantUserStatus | 指定されたデータベースアカウントをロックまたはロック解除する | データベースアカウントの状態を変更します。有効な値： \- LOCKED：アカウントはロック済みです。 \- ONLINE：アカウントはロック解除済みです。 |
| ModifyDatabaseUserRoles | データベースユーザーのロールを変更する | Alibaba Cloud CLI |
| DeleteDatabases | データベースの削除 | 作成済みの 1 つ以上のデータベースを削除します。 |
パラメーター管理
|
API |
タイトル |
説明 |
| DescribeParameters | パラメーター情報リストの照会 | パラメーター情報のリストを照会します。 |
| DescribeParametersHistory | DescribeParametersHistory | この オペレーション を呼び出すと、クラスター または テナント の パラメーター の変更履歴を クエリできます。 |
| ModifyParameters | パラメーターの変更 | Alibaba Cloud は、API を使用して Alibaba Cloud の製品とサービスを迅速に統合できるように、さまざまな言語の SDK を提供しています。SDK を使用して API を呼び出すことを推奨します。この方法では、検証のための署名は不要です。 |
セッション接続
|
API |
タイトル |
説明 |
| DescribeSessionList | DescribeSessionList | この API を呼び出すと、ApsaraDB for OceanBase とアプリケーション間のセッションをクエリできます。 |
| BatchKillSessionList | BatchKillSessionList | この API を呼び出して、ApsaraDB for OceanBase とアプリケーション間のセッションを一括で閉じることができます。この API は非同期に実行される点にご注意ください。この API の呼び出し後、DescribeSessionList を呼び出して確認する必要があります。 |
| BatchKillProcessList | セッションの一括停止 | セッションを一括で強制終了します。 |
| DescribeProcessStatsComposition | セッション情報の照会 | DescribeProcessStatsComposition |
| KillProcessList | KillProcessList | この API を呼び出して、セッションを終了できます。 |
診断管理
|
API |
タイトル |
説明 |
| DescribeOasAnomalySQLList | 疑わしい SQL リストの照会 | この API は、パフォーマンスの問題の可能性があるとして診断システムによってフラグ付けされた SQL ステートメントのリストを返します。 |
| DescribeSampleSqlRawTexts | DescribeSampleSqlRawTexts | この API を呼び出すと、サンプリングされた SQL ステートメントの原文を照会できます。 |
| DescribeOasSQLDetails | SQL詳細情報の照会 | SQL テキストや関連するテーブル名など、詳細な SQL 情報を照会します。 |
| DescribeOasSQLPlans | SQL 実行計画のクエリ | SQLID を指定して、診断システムから SQL 実行計画を取得します。 |
| DescribeSQLSamples | DescribeSQLSamples | スロー SQL 実行の詳細のため、サンプルデータをクエリします。 |
| DescribeOasSQLHistoryList | DescribeOasSQLHistoryList | この API を呼び出すと、SQL 実行履歴を参照できます。 |
| DescribeOasTopSQLList | TopSQL リストのクエリ | 診断システムによって収集された SQL 実行パフォーマンスデータのリストをクエリします。 |
| DescribeOasSlowSQLList | 低速 SQL クエリリストのクエリ | この操作は、スロー SQL ステートメントのリストを取得します。 |
| DescribeOutlineBinding | アウトラインバインディング情報の照会 | SQL ID に基づいて、SQL ステートメントにバインドされたアウトラインまたはスロットリング情報を照会します。 |
| DescribeRecommendIndex | SQLインデックスの推奨情報をクエリします | APIを迅速に取得およびデバッグできるオンラインCLIツールです。実行可能なSDKコードサンプルを動的に生成できます。 |
| DescribeSQLTuningAdvices | DescribeSQLTuningAdvices | この オペレーション を呼び出すと、インデックス作成と実行計画のバインドのための SQL 最適化の提案をクエリできます。 |
| DescribeSqlAuditStat | DescribeSqlAuditStat | このオペレーションを呼び出して、クライアント IP アドレス、ユーザー、SQL ステートメント ID 別に SQL ステートメントの実行統計を収集できます。 |
| CreateOasOutlineTask | CreateOasOutlineTask | この API を呼び出して、アウトラインバインドタスクを開始できます。 |
セキュリティ設定
|
API |
タイトル |
説明 |
| ModifyInstanceSSL | ModifyInstanceSSL | インスタンスの SSL 設定を変更します。 |
| DescribeInstanceSSL | クラスターSSLのクエリ | OceanBase クラスターの SSL 詳細を照会します。 |
| CreateSecurityIpGroup | ホワイトリストグループの作成 | API を迅速に取得してデバッグできるオンライン CLI ツールです。実行可能な SDK コードサンプルを動的に生成できます。 |
| DescribeSecurityIpGroups | IP アドレスホワイトリストグループのリストを照会 | Alibaba Cloud CLI |
| DescribeTenantSecurityConfigs | DescribeTenantSecurityConfigs | この操作を呼び出すと、OceanBase データベーステナントのセキュリティチェック項目をクエリできます。 |
| DescribeTenantEncryption | DescribeTenantEncryption | この操作を呼び出すと、テナントの暗号化情報を照会できます。 |
| DescribeInstanceSecurityConfigs | DescribeInstanceSecurityConfigs | このオペレーションを呼び出して、ApsaraDB for OceanBase クラスターのセキュリティチェック項目を照会できます。 |
| ModifySecurityIps | IP リストの変更 | Alibaba Cloud のアセット管理および設定ツールです。コマンドを使用して複数の Alibaba Cloud 製品およびサービスを管理できます。使いやすく、クラウドへの移行をサポートする優れたツールです。 |
| ModifyTenantEncryption | ModifyTenantEncryption | この API を呼び出して、テナントの透過的な暗号化を有効にできます。 |
| DeleteSecurityIpGroup | ホワイトリストグループの削除 | OceanBase クラスターの IP アドレスホワイトリストグループを削除します。 |
| DescribeBackupEncryptedString | 全体暗号化されたバックアップ情報を取得する | バックアップ用の暗号化された文字列を取得します。 |
モニタリング管理
|
API |
タイトル |
説明 |
| DescribeMetricsDataV2 | DescribeMetricsDataV2 | このオペレーションを呼び出して、メトリクスデータを取得します。 |
| DescribeMetricsData | DescribeMetricsData | この API は、OceanBase クラスターの単一または多次元の監視メトリクスを取得します。 |
| DescribeNodeMetrics | エッジゾーンのメトリクス情報をクエリする | このオペレーションを呼び出して、OceanBase クラスターノードの詳細なメトリクス情報を照会します。 |
| DescribeTenantMetrics | テナントメトリック情報の照会 | テナントの監視メトリクスを照会します。\ サポートされているメトリクスの詳細については、「[テナント統計の表示](~~212125~~)」をご参照ください。\ |
データ転送
|
API |
タイトル |
説明 |
| DescribeBackupSetDownloadLink | DescribeBackupSetDownloadLink | このオペレーションを呼び出して、OceanBase データベースのバックアップセットをダウンロードするためのリンクを取得します。 |
| DescribeDataBackupSet | DescribeDataBackupSet | このオペレーションを呼び出すと、OceanBase クラスターのバックアップ セットの情報をクエリできます。 |
| CreateBackupSetDownloadLink | The return result of the request. | この操作では、OceanBase Database でバックアップセットのダウンロードリンクを作成できます。 |
| DescribeRestorableTenants | DescribeRestorableTenants | 復元可能な OceanBase データベーステナントの情報を照会します。 |
バックアップとリカバリ
|
API |
タイトル |
説明 |
| DescribeProxyService | DescribeProxyService | この API を呼び出すと、OceanBase Database のプロキシサービス情報を照会できます。 |
| DescribeTenantAddressProxyInfo | DescribeTenantAddressProxyInfo | このオペレーションを呼び出して、テナントのアドレスプロキシサービスに関する情報を照会できます。 |
未翻訳 (その他)
|
API |
タイトル |
説明 |