はじめに

Verticaにはデータベースを管理するためのREST APIが用意されています。
このAPIを利用することで、スクリプトやアプリケーションからデータベースの管理操作を行えます。
本記事ではデータベースの作成削除および起動停止のAPI実行例をご紹介します。

実施内容

サーバAから、Verticaがインストール済みのサーバBに対して以下のAPIリクエストを送信します。
・データベースの作成
・データベースの停止
・データベースの起動
・データベースの削除

前提事項

・APIリクエスト送信元と送信先がネットワーク的に疎通可能である必要があります。
・APIからの操作のため、サーバAにVerticaクライアントはインストール不要です。
・本記事ではcurlコマンドを使用してAPIリクエストを送信します。
・以下はサンプル手順のため「-k」オプションを使用しSSL証明書関連のエラーを無視しています。
本番利用の際は別途証明書の利用を検討ください。

APIリクエストの基本構文(curlを使用する場合)

※リクエスト には以下いずれかを指定します。指定しない場合デフォルトでGETが指定されます。
GET
PUT
POST
DELETE


事前準備

APIキーの生成

Verticaがインストールされたサーバにて、APIキーを作成します。
ここで作成したAPIキーを、APIを実行したいサーバから指定します。

データベースが存在しないことを確認


データベースの作成

APIを実行したいサーバから、データベースを作成するAPIをcurlコマンドを利用して実行します。

データベースの停止


データベースの起動


データベースの削除

※データベースを削除する場合は、データベースが停止している必要があります。

参考情報

cURL
https://www.vertica.com/docs/10.1.x/HTML/Content/Authoring/ConnectingToVertica/ManagementAPI/cURL.htm

Rest APIs for the Agent
https://www.vertica.com/docs/10.1.x/HTML/Content/Authoring/ConnectingToVertica/ManagementAPI/RestAPIsForTheAgent.htm

VerticaAPIKey
https://www.vertica.com/docs/10.1.x/HTML/Content/Authoring/ConnectingToVertica/ManagementAPI/VerticaAPIKey.htm

検証バージョンについて

この記事の内容はVertica 10.1で確認しています。

更新履歴

2021/04/27 本記事を公開