API docs by Redocly

NoSQL β APIドキュメント (1.4.0)

Download OpenAPI specification:Download

License: Copyright(C) SAKURA internet Inc. all rights reserved.

「NoSQL」が提供するAPIの利用方法とサンプルを公開しております。

基本的な使い方

APIキーの発行

APIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。
APIキーは「ユーザID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。

項目名 APIキー発行時の項目名 このドキュメント内での例
ユーザID アクセストークン(UUID) 01234567-89ab-cdef-0123-456789abcdef
パスワード アクセストークンシークレット SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM
操作マニュアル

APIエンドポイント

https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1

用語

  • プライマリノード (PrimaryNodes)
    新規作成時に作成されるノード群を指します。
    本マニュアルではこれを「プライマリノード」と呼びます。
    新規作成では 3 ノード構成で提供されます。

NoSQL

NoSQLの作成・ノード追加・更新・削除

NoSQL一覧取得API

NoSQLの一覧取得を行います。

query Parameters
Filter.Class
required
string
Example: Filter.Class=nosql

Class固定

Responses

Response samples

Content type
application/json
{
  • "From": 0,
  • "Count": 1,
  • "Total": 1,
  • "Appliances": [
    ],
  • "is_ok": true
}

NoSQL作成API

NoSQLの新規作成および既存NoSQLへのノード追加を行います。
新規作成では3台構成で作成されます。
ノード追加では、2台ずつ追加され、NoSQL全体で最大9台まで構成可能です。
新規作成時とノード追加時では、必要となる項目が異なります。
各操作ごとの必須項目は、スキーマ定義内の各プロパティの説明欄に明記していますので、詳細はそちらをご参照ください。

  • 新規作成時必須: 新規作成の際に必須の項目
  • ノード追加時必須: ノード追加の際に必須の項目
  • 新規作成時・ノード追加時必須: 新規作成・ノード追加時に必須の項目

※ノード追加では、既存NoSQLの設定情報（ノード追加時必須以外の項目）と一致させるか未指定である必要があります。

Request Body schema: application/json

NoSQLの作成を行うためのリクエストボディ

required
object

Responses

Request samples

Content type
application/json
{
  • "Appliance": {
    }
}

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "Class": "nosql",
  • "Name": "CassandraName",
  • "Description": "説明",
  • "Plan": {
    },
  • "Settings": {
    },
  • "Remark": {
    },
  • "ID": "113600097295",
  • "Account": {
    },
  • "Tags": [
    ],
  • "Availability": "available",
  • "ServerCount": 1,
  • "HiddenRemark": {
    },
  • "Success": true,
  • "is_ok": true
}

NoSQL取得API

対象のNoSQLの取得を行います。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "is_ok": true
}

NoSQL更新API

対象のNoSQLに対しての更新を行います。
追加ノードのアプライアンスIDを指定して更新を行うことはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対しても更新が適用されます。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Request Body schema: application/json

NoSQLの更新を行うためのリクエストボディ

required
object

Responses

Request samples

Content type
application/json
{
  • "Appliance": {
    }
}

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "Success": true,
  • "is_ok": true
}

NoSQL削除API

対象のNoSQLを削除します。
プライマリノードのアプライアンスIDを指定しての削除ではノード追加したデータは削除されません。
ノード追加している場合は、追加ノードのアプライアンスIDを指定して、個別に削除する必要があります。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "Success": true,
  • "is_ok": true
}

NoSQL反映API

対象のNoSQLに対しての更新を反映します。
追加ノードのアプライアンスIDを指定して反映処理をすることはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対しても更新が反映されます。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "Nosql": {
    },
  • "is_ok": true
}

NoSQL状態確認API

対象のNoSQLの情報を取得します。
追加ノードのアプライアンスIDを指定して呼び出した場合、返却される情報はプライマリノードを指定した場合と同一の内容となります。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "is_ok": true
}

電源

NoSQLの起動・停止

NoSQL起動

対象のNoSQLを起動します。
プライマリノードのアプライアンスIDを指定しての起動では、ノード追加したデータは起動しません。
ノード追加している場合は、追加ノードのアプライアンスIDを指定して、個別に起動する必要があります。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "is_ok": true
}

NoSQL停止

対象のNoSQLを停止します。
プライマリノードのアプライアンスIDを指定しての停止では、ノード追加したデータは停止しません。
ノード追加している場合は、追加ノードのアプライアンスIDを指定して、個別に停止する必要があります。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "is_ok": true
}

NoSQLの起動状態確認API

対象のNoSQL全体の起動状態を確認します。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "is_ok": true,
  • "Nosql": {
    }
}

NoSQL状態復旧API

対象のNoSQLのノードを復旧します。 起動状態を確認し、停止している場合は、再起動を試みます。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "is_ok": true
}

バックアップ

NoSQLのバックアップ

NoSQLバックアップ取得API

対象NoSQLのバックアップ情報を取得します。
追加ノードのアプライアンスIDを指定して呼び出した場合、返却される情報はプライマリノードを指定した場合と同一の内容となります。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "nosql": {
    },
  • "is_ok": true
}

NoSQLバックアップ作成API

対象のNoSQLに対してバックアップ作成を行います。
追加ノードのアプライアンスIDを指定してバックアップを作成することはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対してもバックアップが作成されます。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "nosql": {
    },
  • "is_ok": true
}

NoSQLバックアップ復元API

対象のNoSQLに対してバックアップ復元を開始します。
バックアップデータの確認はNoSQLバックアップ一覧取得APIにて行ってください。
追加ノードのアプライアンスIDを指定してバックアップを復元することはできません。
プライマリノードのアプライアンスIDとバックアップIDを指定することで、追加ノードに対してもバックアップの復元が適用されます。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

backupID
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

バックアップID

Responses

Response samples

Content type
application/json
{
  • "nosql": {
    },
  • "is_ok": true
}

NoSQLバックアップ削除API

対象のNoSQLのバックアップ削除を開始します。
バックアップデータの確認はNoSQLバックアップ一覧取得APIにて行ってください。
追加ノードのアプライアンスIDを指定してバックアップを削除することはできません。
プライマリノードのアプライアンスIDとバックアップIDを指定することで、追加ノードに対してもバックアップの削除が適用されます。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

backupID
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

バックアップID

Responses

Response samples

Content type
application/json
{
  • "nosql": {
    },
  • "is_ok": true
}

パラメーター設定

NoSQLのパラメーター設定

NoSQLパラメータ取得API

対象のNoSQLのパラメータ設定情報を取得します。
追加ノードのアプライアンスIDを指定して呼び出した場合、返却される情報はプライマリノードを指定した場合と同一の内容となります。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "nosql": {
    },
  • "is_ok": true
}

NoSQLパラメータ反映API

対象のNoSQLに対してのパラメータ設定を行います。
追加ノードのアプライアンスIDを指定してパラメータ設定を行うことはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対してもパラメータ設定を行うことができます。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "nosql": {
    }
}

Response samples

Content type
application/json
{
  • "nosql": {
    },
  • "is_ok": true
}

バージョンアップ

NoSQLのバージョンアップ

NoSQLバージョン取得API

対象のNoSQLの更新可能なバージョンを取得します。
追加ノードのアプライアンスIDを指定して呼び出した場合、返却される情報はプライマリノードを指定した場合と同一の内容となります。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "nosql": {
    },
  • "is_ok": true
}

NoSQLバージョン更新API

対象のNoSQLに対してのバージョン更新を行います。
追加ノードのアプライアンスIDを指定してバージョン更新を行うことはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対してもバージョン更新を行うことができます。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Request Body schema: application/json
required
object (NosqlVersion)

Responses

Request samples

Content type
application/json
{
  • "nosql": {
    }
}

Response samples

Content type
application/json
{
  • "nosql": {
    },
  • "is_ok": true
}

リペア

NoSQLのリペア

NoSQLリペア実行API

プライマリノードを対象にNoSQLのリペアを開始します。 「増分リペア」または「完全リペア」を実行します。
リペアとはデータの整合性（一貫性）を維持するために、複数のノード間で発生したデータのずれを検出・修復するメンテナンス作業です。
増分リペアは、前回のリペア実行以降に更新されたデータのみを対象に修復を行います。
完全リペアは、クラスタ内のすべてのデータを対象に修復を行います。
追加ノードのアプライアンスIDを指定してリペアを実行することはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対してもリペアが実行されます。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Request Body schema: application/json

リペアAPIのリクエストボディ

object

Responses

Request samples

Content type
application/json
{
  • "nosql": {
    }
}

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "nosql": {
    }
}