SnapCenter Software 5 マニュアル ( CA08871-403 )
SnapCenter ServerとプラグインでサポートされているREST API
SnapCenter REST APIで使用できるリソースは、SnapCenter APIドキュメント ページに表示されるカテゴリー別に分類されています。ここでは、各リソースの簡単な説明と基本リソース パスを示し、使用に際しての追加の考慮事項がある場合はその情報も示します。
認証
このAPIを使用すると、SnapCenter Serverにログインできます。このAPIは、以降の要求を認証するために使用されるユーザー認証トークンを返します。
ドメイン
APIを使用して、次のようなさまざまな処理を実行できます。
-
SnapCenterのすべてのドメインを取得する
-
特定のドメインの詳細を取得する
-
ドメインの登録や登録解除を行う
-
ドメインを変更する
ジョブ
APIを使用して、次のようなさまざまな処理を実行できます。
-
SnapCenterのすべてのジョブを取得する
-
ジョブのステータスを取得する
-
ジョブをキャンセルまたは停止する
設定
APIを使用して、次のようなさまざまな処理を実行できます。
-
クレデンシャルを登録、変更、削除する
-
SnapCenter Serverに登録されているクレデンシャル情報を表示する
-
通知を設定する
-
現在Eメール通知を送信するように設定されているSMTPサーバーに関する情報を取得し、SMTPサーバー名、受信者名、送信者名を表示する
-
SnapCenter Serverへのログインの多要素認証(MFA)設定を表示する
-
SnapCenter ServerへのログインのMFAの有効 / 無効の切り替えや設定を行う
-
MFAのセットアップに必要な構成ファイルを作成する
ホスト
APIを使用して、次のようなさまざまな処理を実行できます。
-
すべてのSnapCenterホストを照会する
-
SnapCenterから1つ以上のホストを削除する
-
名前を指定してホストを取得する
-
ホスト上のすべてのリソースを取得する
-
リソースIDを使用してリソースを取得する
-
プラグイン設定の詳細を取得する
-
プラグイン ホストを設定する
-
Microsoft SQL Serverホスト用プラグインのすべてのリソースを取得する
-
Oracleデータベース ホスト用プラグインのすべてのリソースを取得する
-
カスタム アプリケーション ホスト用プラグインのすべてのリソースを取得する
-
SAP HANAホスト用プラグインのすべてのリソースを取得する
-
インストールされているプラグインを取得する
-
既存のホストにプラグインをインストールする
-
ホスト パッケージをアップグレードする
-
既存のホストからプラグインを削除する
-
ホストにプラグインを追加する
-
ホストを追加または変更する
-
Linuxホストのシグネチャを取得する
-
Linuxホストのシグネチャを登録する
-
ホストをメンテナンス モードまたは本番モードにする
-
ホストのプラグイン サービスを開始または再起動する
-
ホストの名前を変更する
リソース
APIを使用して、次のようなさまざまな処理を実行できます。
-
すべてのリソースを取得する
-
リソースIDを使用してリソースを取得する
-
Microsoft SQL Serverホスト用プラグインのすべてのリソースを取得する
-
Oracleデータベース ホスト用プラグインのすべてのリソースを取得する
-
カスタム アプリケーション ホスト用プラグインのすべてのリソースを取得する
-
SAP HANAホスト用プラグインのすべてのリソースを取得する
-
キーを使用してMicrosoft SQL Serverのリソースを取得する
-
キーを使用してカスタム リソースを取得する
-
カスタム アプリケーション ホスト用プラグインのリソースを変更する
-
キーを使用してカスタム アプリケーション ホスト用プラグインのリソースを削除する
-
キーを使用してSAP HANAのリソースを取得する
-
SAP HANAホスト用プラグインのリソースを変更する
-
キーを使用してSAP HANAホスト用プラグインのリソースを削除する
-
キーを使用してOracleのリソースを取得する
-
Oracleアプリケーション ボリュームのリソースを作成する
-
Oracleアプリケーション ボリュームのリソースを変更する
-
キーを使用してOracleアプリケーション ボリュームのリソースを削除する
-
Oracleのリソースに関するセカンダリーの詳細を取得する
-
Plug-in for Microsoft SQL Serverを使用してMicrosoft SQL Serverのリソースをバックアップする
-
Plug-in for Oracle Databaseを使用してOracleのリソースをバックアップする
-
カスタム アプリケーション用プラグインを使用してカスタム リソースをバックアップする
-
SAP HANAデータベースを設定する
-
Oracleデータベースを設定する
-
SQLデータベースのバックアップをリストアする
-
Oracleデータベースのバックアップをリストアする
-
カスタム アプリケーションのバックアップをリストアする
-
カスタム プラグインのリソースを作成する
-
SAP HANAのリソースを作成する
-
カスタム アプリケーション用プラグインを使用してカスタム リソースを保護する
-
Plug-in for Microsoft SQL Serverを使用してMicrosoft SQL Serverのリソースを保護する
-
保護対象のMicrosoft SQL Serverのリソースを変更する
-
Microsoft SQL Serverのリソースの保護を解除する
-
Plug-in for Oracle Databaseを使用してOracleのリソースを保護する
-
保護対象のOracleリソースを変更する
-
Oracleのリソースの保護を解除する
-
カスタム アプリケーション用プラグインを使用してバックアップからリソースをクローニングする
-
Plug-in for Oracle Databaseを使用してバックアップからOracleアプリケーション ボリュームをクローニングする
-
Plug-in for Microsoft SQL Serverを使用してバックアップからMicrosoft SQL Serverのリソースをクローニングする
-
Microsoft SQL Serverのリソースのクローン ライフサイクルを作成する
-
Microsoft SQL Serverのリソースのクローン ライフサイクルを変更する
-
Microsoft SQL Serverのリソースのクローン ライフサイクルを削除する
-
既存のMicrosoft SQL Serverデータベースをローカル ディスクからLUNに移動する
-
Oracleデータベースのクローン仕様ファイルを作成する
-
Oracleのリソースのクローン更新ジョブをオンデマンドで開始する
-
クローン仕様ファイルを使用してバックアップからOracleのリソースを作成する
-
データベースをセカンダリー レプリカにリストアし、データベースを可用性グループに再参加させる
-
Oracleアプリケーション ボリュームのリソースを作成する
バックアップ
APIを使用して、次のようなさまざまな処理を実行できます。
-
バックアップの名前、タイプ、プラグイン、リソース、日付を指定してバックアップの詳細を取得する
-
すべてのバックアップを取得する
-
バックアップの詳細を取得する
-
バックアップの名前変更または削除を行う
-
Oracleのバックアップをマウントする
-
Oracleのバックアップをアンマウントする
-
Oracleのバックアップをカタログに登録する
-
Oracleのバックアップをカタログから削除する
-
ポイントインタイム リカバリーを実行するためにマウントする必要があるバックアップをすべて取得する
クローン
APIを使用して、次のようなさまざまな処理を実行できます。
-
Oracleデータベースのクローン仕様ファイルを作成、表示、変更、削除する
-
Oracleデータベースのクローン階層を表示する
-
クローンの詳細を取得する
-
すべてのクローンを取得する
-
クローンを削除する
-
IDを指定してクローンの詳細を取得する
-
Oracleのリソースのクローン更新ジョブをオンデマンドで開始する
-
クローン仕様ファイルを使用してバックアップからOracleのリソースをクローニングする
クローン スプリット
APIを使用して、次のようなさまざまな処理を実行できます。
-
クローン リソースのクローン スプリット処理を概算する
-
クローン スプリット処理のステータスを取得する
-
クローン スプリット処理を開始または停止する
リソース グループ
APIを使用して、次のようなさまざまな処理を実行できます。
-
すべてのリソース グループの詳細を取得する
-
名前を指定してリソース グループを取得する
-
カスタム アプリケーション用プラグインのリソース グループを作成する
-
Plug-in for Microsoft SQL Serverのリソース グループを作成する
-
Plug-in for Oracle Databaseのリソース グループを作成する
-
カスタム アプリケーション用プラグインのリソース グループを変更する
-
Plug-in for Microsoft SQL Serverのリソース グループを変更する
-
Plug-in for Oracle Databaseのリソース グループを変更する
-
Plug-in for Microsoft SQL Serverのリソース グループのクローン ライフサイクルを作成、変更、削除する
-
リソース グループをバックアップする
-
リソース グループをメンテナンス モードまたは本番モードにする
-
リソース グループを削除する
ポリシー
APIを使用して、次のようなさまざまな処理を実行できます。
-
ポリシーの詳細を取得する
-
名前を指定してポリシーの詳細を取得する
-
ポリシーを削除する
-
既存のポリシーのコピーを作成する
-
カスタム アプリケーション用プラグインのポリシーを作成または変更する
-
Plug-in for Microsoft SQL Serverのポリシーを作成または変更する
-
Plug-in for Oracle Databaseのポリシーを作成または変更する
-
Plug-in for SAP HANA Databaseのポリシーを作成または変更する
ストレージ
APIを使用して、次のようなさまざまな処理を実行できます。
-
すべての共有を取得する
-
名前を指定して共有を取得する
-
共有を作成または削除する
-
ストレージの詳細を取得する
-
名前を指定してストレージの詳細を取得する
-
ストレージを作成、変更、削除する
-
ストレージ クラスタ上のリソースを検出する
-
ストレージ クラスタ上のリソースを取得する
共有
APIを使用して、次のようなさまざまな処理を実行できます。
-
共有の詳細を取得する
-
すべての共有の詳細を取得する
-
ストレージ上の共有を作成または削除する
-
名前を指定して共有を取得する
プラグイン
APIを使用して、次のようなさまざまな処理を実行できます。
-
ホストのすべてのプラグインを一覧表示する
-
キーを使用してMicrosoft SQL Serverのリソースを取得する
-
キーを使用してカスタム リソースを変更する
-
キーを使用してカスタム リソースを削除する
-
キーを使用してSAP HANAのリソースを取得する
-
キーを使用してSAP HANAのリソースを変更する
-
キーを使用してSAP HANAのリソースを削除する
-
キーを使用してOracleのリソースを取得する
-
キーを使用してOracleアプリケーション ボリュームのリソースを変更する
-
キーを使用してOracleアプリケーション ボリュームのリソースを削除する
-
Plug-in for Microsoft SQL Serverとキーを使用してMicrosoft SQL Serverのリソースをバックアップする
-
Plug-in for Oracle Databaseとキーを使用してOracleのリソースをバックアップする
-
カスタム アプリケーション用のプラグインとキーを使用してカスタム アプリケーションのリソースをバックアップする
-
キーを使用してSAP HANAデータベースを設定する
-
キーを使用してOracleデータベースを設定する
-
キーを使用してカスタム アプリケーションのバックアップをリストアする
-
カスタム プラグインのリソースを作成する
-
SAP HANAのリソースを作成する
-
Oracleアプリケーション ボリュームのリソースを作成する
-
カスタム アプリケーション用プラグインを使用してカスタム リソースを保護する
-
Plug-in for Microsoft SQL Serverを使用してMicrosoft SQL Serverのリソースを保護する
-
保護対象のMicrosoft SQL Serverのリソースを変更する
-
Microsoft SQL Serverのリソースの保護を解除する
-
Plug-in for Oracle Databaseを使用してOracleのリソースを保護する
-
保護対象のOracleリソースを変更する
-
Oracleのリソースの保護を解除する
-
カスタム アプリケーション用プラグインを使用してバックアップからリソースをクローニングする
-
Plug-in for Oracle Databaseを使用してバックアップからOracleアプリケーション ボリュームをクローニングする
-
Plug-in for Microsoft SQL Serverを使用してバックアップからMicrosoft SQL Serverのリソースをクローニングする
-
Microsoft SQL Serverのリソースのクローン ライフサイクルを作成する
-
Microsoft SQL Serverのリソースのクローン ライフサイクルを変更する
-
Microsoft SQL Serverのリソースのクローン ライフサイクルを削除する
-
Oracleデータベースのクローン仕様ファイルを作成する
-
Oracleリソースのクローン ライフサイクルをオンデマンドで開始する
-
クローン仕様ファイルを使用してバックアップからOracleのリソースをクローニングする
レポート
APIを使用して、次のようなさまざまな処理を実行できます。
-
各プラグインのバックアップ、リストア、クローニング処理のレポートを取得する
-
スケジュールを追加、実行、削除、変更する
-
スケジュール済みレポートのデータを取得する
アラート
APIを使用して、次のようなさまざまな処理を実行できます。
-
すべてのアラートを取得する
-
IDを指定してアラートを取得する
-
複数のアラートを削除する、またはIDを指定してアラートを削除する
RBAC
APIを使用して、次のようなさまざまな処理を実行できます。
-
ユーザー、グループ、ロールの詳細を取得する
-
ユーザーを追加または削除する
-
ロールにユーザーを割り当てる
-
ロールへのユーザーの割り当てを解除する
-
ロールを作成、変更、削除する
-
グループをロールに割り当てる
-
ロールへのグループの割り当てを解除する
-
グループを追加または削除する
-
既存のロールのコピーを作成する
-
ユーザーまたはグループへのリソースの割り当てや割り当ての解除を行う
構成
APIを使用して、次のようなさまざまな処理を実行できます。
-
構成設定を表示する
-
構成設定を変更する
証明書設定
APIを使用して、次のようなさまざまな処理を実行できます。
-
SnapCenter Serverまたはプラグインホストの証明書ステータスを表示する
-
SnapCenter Serverまたはプラグインホストの証明書設定を変更する
リポジトリ
APIを使用して、次のようなさまざまな処理を実行できます。
-
リポジトリ バックアップを取得する
-
リポジトリに関する設定情報を表示する
-
SnapCenterリポジトリを保護、リストアする
-
SnapCenterリポジトリの保護を解除する
-
リポジトリを再構築したりフェイルオーバーしたりする
バージョン
このAPIを使用すると、SnapCenterのバージョンを表示できます。