非WebAPI接続ユーザガイド

Revision: 2.1.0-12973-a96d5d04

1 はじめに

1.1 本書の構成

本書では、GridDB Cloudの非WebAPIオプションの使い方を説明します。各章の内容は次のとおりです。

はじめに
本書の構成、用語、および、前提条件について説明します。
非WebAPIオプションについて
非WebAPIオプションについて説明します。
接続元IPアドレスの制限について
非WebAPIを使用して接続することを許可するIPアドレスを指定する方法について説明します。
非WebAPIオプションを使用した接続に必要な設定について
非WebAPIオプションを使用してGridDBに接続するために必要な設定について説明します。
非WebAPIオプションを使用した接続の実行について
非WebAPIオプションを使用してGridDBに接続する方法について説明します。

1.2 用語

本書で用いられる用語の説明です。

用語	意味
運用管理GUI	GridDB Cloudを管理するWebアプリケーションです。

1.3 前提条件

本機能を使用するには、お客様のネットワーク環境で以下の必要なポートを利用できるようになっている必要があります。

利用するポート
10001
20001

2 非WebAPIオプションについて

2.1 概要

GridDBに接続する方法には大きく分けて「WebAPI」と「非WebAPI」の２つがあります。このうち、非WebAPIと呼ばれる接続方法には以下のような接続方法があります。

接続方法	内容
Java API	NoSQLインタフェースをJavaで扱うためのAPI
C API	NoSQLインタフェースをC言語で扱うためのAPI
JDBC/ODBC	NewSQLインタフェースをJava/C言語で扱うためのライブラリ
Python API	NoSQLインタフェースをPythonで扱うためのAPI
Node.js API	NoSQLインタフェースをNode.jsで扱うためのAPI
Go API	NoSQLインタフェースをGO言語で扱うためのAPI
クラスタ運用管理コマンド・インタプリタ(gs_sh)	GridDBクラスタの運用管理、およびデータ操作を行うCUIツール
運用コマンド	GridDBクラスタの運用管理を行うコマンド群です。機能ごとに様々なコマンドがあります。
エクスポートツール/インポートツール	データをエクスポート/インポートするツール

もともと、これらの接続方法は接続元がAzure内のネットワーク環境である場合、VNetピアリング機能によりそれぞれのネットワークを接続することで使用することができました。 GridDB Cloudでは、V1.6において、この接続方法の一部をAzure外部からも使用できるようになりました。

2.2 接続可能な非WebAPI

GridDB Cloudでは、V1.6から以下の接続方法によりAzure外部から接続可能になりました。

接続方法
Java API
C API
JDBC/ODBC

これらの接続方法を用いるために必要な準備については各マニュアルを参照してください。

3 接続元IPアドレスの制限について

3.1 概要

セキュリティ上の理由で、非WebAPI接続ではすべてのIPアドレスからのアクセスが拒否されるデフォルト設定となっています。接続するには、接続可能なIPアドレスを設定する必要があります。

3.2 IPアドレスの設定方法

接続可能なIPアドレスは、運用管理GUIから設定することができます。詳細についてはGridDB Cloud 運用管理GUIリファレンスを参照してください。

4 非WebAPIオプションを使用した接続に必要な設定について

4.1 概要

GridDB Cloudで非WebAPI接続を利用するためには、接続先や接続方法などをプログラムの中で設定する必要があります。以下は、設定の例です。

Properties prop = new Properties();
prop.setProperty("notificationAddress", "239.0.0.1");
prop.setProperty("notificationPort", "31999");
prop.setProperty("clusterName", "myCluster");
prop.setProperty("database", "public");
prop.setProperty("user", "admin");
prop.setProperty("password", "admin");
prop.setProperty("applicationName", "SampleJava");

これらの設定の中で、特に非WebAPI接続を利用する場合には必要な設定を紹介します。なお、設定する項目の詳細については『GridDB Java APIリファレンス』をご参照ください。

4.2 必要となる設定

GridDB Cloudで非WebAPI接続を利用するためには、プロパティの以下の値を設定する必要があります。

プロパティのキー	説明	指定する値
notificationProvider	プロバイダ方式を使用して構成されたクラスタに接続する場合に指定するアドレスプロバイダのURL	運用管理GUIの「クラスタ」→「概要」→「外部接続用アドレスプロバイダのURL」より取得可能
sslMode	クラスタへの接続においてSSLの使用有無の判断に用いられるモード	以下のいずれかを指定・PREFERRED(クラスタ設定に従う) ・VERIFY(SSL有効、サーバ証明書検証実施) ・DISABLED(無効)
connectionRoute	クラスタ接続時の通信経路。	"PUBLIC"

なお、sslModeで『VERIFY』を指定する場合にはCA証明書、および、CA証明書へのパスの指定が必要になります。 CA証明書を作成するために必要なルート証明書、および、中間証明書は『GlobalSign』のサイトより入手してください。

5 非WebAPIオプションを使用した接続の実行について

5.1 概要

GridDB Cloudで非WebAPIオプションを利用した接続の実行を紹介します。

5.2 接続の実行

今までの説明をすべて実行した後に、お客様で用意しているプログラムやアプリケーションを実行し、GridDBに接続できることを確認します。もし、用意しているプログラムやアプリケーションが無い場合には以下のマニュアルで紹介しているサンプルプログラムを実行して確認してください。

非WebAPI接続 ユーザガイド