API docs by Redocly

NoSQL β APIドキュメント (1.3.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
操作マニュアル

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の作成を行います。

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を更新します。

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を削除します。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

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

NoSQL反映API

対象のNoSQLを反映します。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

Content type
application/json
{
  • "Nosql": {
    },
  • "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の起動・停止

NoSQL起動

NoSQLを起動する。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

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

NoSQL停止

対象のNoSQLを停止する。

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のバックアップを取得します。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

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

NoSQLバックアップ作成API

対象NoSQLのバックアップ作成を開始します。 バックアップデータの確認はNoSQLバックアップ一覧取得APIにて行ってください。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

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

NoSQLバックアップ復元API

対象NoSQLのバックアップ復元を開始します。

バックアップデータの確認はNoSQLバックアップ一覧取得APIにて行ってください。

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のバックアップ削除を開始します。

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のパラメータを取得します。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

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

NoSQLパラメータ反映API

対象のNoSQLのパラメータを反映します。

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の更新可能なバージョンを取得します。

path Parameters
applianceID
required
string
Example: 113600102549

アプライアンスID

Responses

Response samples

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

NoSQLバージョン更新API

対象のNoSQLのバージョンを更新します。

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

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

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": {
    }
}