データベースAPI

データベース作成

指定されたデータベース名でクラスタにデータベースを作成します。
データベース名と同名のバケットがストレージに存在しなければ、
本APIがストレージにバケットを自動作成します。

データベースについて詳しくは、データベース をご覧ください。

リクエスト情報

シンタックス

PUT /v1/{cluster name}/{database name}?database HTTP1.1
Host: analysis-dag.iijgio.com
Date: {date}
Authorization: {signature string}

リクエストパラメータ

この操作ではリクエストパラメータは使用しません。

リクエストボディ

この操作ではリクエストボディは使用しません。

レスポンス情報

レスポンスボディ

この操作はレスポンスボディを返しません。

エラー情報

この操作では以下のエラーを返します。

表. データベース作成 エラーコード一覧
コード 内容 ステータス
InvalidClusterState 操作出来ないクラスタのステータスです。 400 Bad Request
InvalidClusterName 指定されたクラスタ名が不正です。 400 Bad Request
InvalidDatabaseName 指定されたデータベース名が不正です。 400 Bad Request
InvalidDDLStatement 作成できないデータベースです。 400 Bad Request
DatabaseAlreadyExists 指定されたデータベースが既に存在します。 400 Bad Request
StorageAccessError ストレージへのアクセスに失敗しました。 400 Bad Request
ClusterNotFound 存在しないクラスタ名が指定されました。 404 Not Found

サンプル

sampleCluster1クラスタにsampledbデータベースを作成するサンプル
リクエスト
PUT /v1/sampleCluster1/sampledb?database HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 0
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
HTTP/1.1 204 No Content
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Content-Type: text/plain
Content-Length : 0
Connection: close

データベース一覧取得

データベースの一覧を取得します。

最大で100件のデータベース情報を返す事ができ、maxパラメータを変更することで一覧に含まれるデータベースの最大件数を変更することができます。

もし、データベース情報が最大件数を超える場合には、一覧が部分的なものであることを示すisTruncatedの値をtrueにしてレスポンスを返します。

部分的な一覧の場合にはmarkerを指定し、次の一覧を取得することができます。

リクエスト情報

シンタックス

GET /v1/{cluster name}?database HTTP1.1
Host: analysis-dag.iijgio.com
Date: {date}
Authorization: {signature string}

リクエストパラメータ

表. データベース一覧取得 リクエストパラメータ一覧
パラメータ名 説明 必須
max
レスポンスに含める最大データベース数

型: Integer
デフォルト値: 25
制約: 1以上100以下の数値
marker
一覧の取得開始位置を指定する文字列
データベース名を指定します。
データベース名のutf8コード順で後の情報を一覧にして返します。
また、marker値に指定されたデータベースの情報は返答に含みません。

型: String
デフォルト値: なし
制約: 半角英数字の小文字、3文字以上63文字以下

レスポンス情報

レスポンスボディ

この操作では以下のレスポンスボディを返します。

表. データベース一覧取得 レスポンスボディ一覧
名前 説明
nextMarker
次の一覧を取得するためのデータベース名
レスポンスに含まれる一覧が部分的なものだった場合に、次の一覧の開始位置を指定するデータベース名のマーカーです。

型: String
isTruncated
一覧が部分的なものかどうか
trueの場合一覧が部分的なものであり、 max 以上に存在することを意味します。

型: String
databases
取得したデータベース名の一覧
型: StringのArray

エラー情報

この操作では以下のエラーを返します。

表. データベース一覧取得 エラーコード一覧
コード 内容 ステータス
InvalidClusterState 操作出来ないクラスタのステータスです。 400 Bad Request
InvalidClusterName 指定されたクラスタ名が不正です。 400 Bad Request
InvalidDatabaseName markerに指定されたデータベース名が不正です。 400 Bad Request
InvalidMaxRange maxの値が範囲外です。 400 Bad Request
InvalidMax maxの値が不正です。 400 Bad Request
ClusterNotFound 存在しないクラスタ名が指定されました。 404 Not Found

サンプル

sampleCluster1クラスタのデータベースのうち、sampledbよりutf8コード順で後のものを最大10件取得するサンプル
リクエスト
GET /v1/sampleCluster1?database&max=10&marker=sampledb HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 0
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
HTTP/1.1 200 OK
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Content-Type: application/json
Content-Length: 202
Connection: close
{
  "nextMarker" : "testdb5",
  "isTrancated" : true,
  "databases" : [
    "samplefiles1",
    "samplefiles2",
    "samplefiles3",
    "samplefiles4",
    "samplefiles5",
    "testdb1",
    "testdb2",
    "testdb3",
    "testdb4",
    "testdb5"
  ]
}

データベース削除

指定されたデータベースを削除します。

本APIによってストレージ上のバケットは削除されません。

リクエスト情報

シンタックス

DELETE /v1/{cluster name}/{database name}?database HTTP1.1
Host: analysis-dag.iijgio.com
Date: {date}
Authorization: {signature string}

リクエストパラメータ

この操作ではリクエストパラメータは使用しません。

リクエストボディ

この操作ではリクエストボディは使用しません。

レスポンス情報

レスポンスボディ

この操作はレスポンスボディを返しません。

エラー情報

この操作では以下のエラーを返します。

表. データベース作成 エラーコード一覧
コード 内容 ステータス
InvalidClusterState 操作出来ないクラスタのステータスです。 400 Bad Request
InvalidClusterName 指定されたクラスタ名が不正です。 400 Bad Request
InvalidDatabaseName 指定されたデータベース名が不正です。 400 Bad Request
TableExists テーブルが存在するデータベースが指定されました。 400 Bad Request
DatabaseNotFound 存在しないデータベースが指定されました。 404 Not Found
ClusterNotFound 存在しないクラスタ名が指定されました。 404 Not Found

サンプル

sampleCluster1クラスタのsampledbデータベースを削除するサンプル
リクエスト
DELETE /v1/sampleCluster1/sampledb?database HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 0
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
HTTP/1.1 204 No Content
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Content-Type: text/plain
Content-Length: 0
Connection: close

ページ先頭へ