アカウント

オブジェクト

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36
    },
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "hostname": {
      "type": "string",
      "format": "hostname"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "ipv4_address": {
      "type": "string",
      "format": "ipv4"
    },
    "ssh_port": {
      "type": "integer"
    },
    "snapshot_interval_in_minute": {
      "type": "integer",
      "minimum": 60
    },
    "snapshot_archive_interval": {
      "type": "integer",
      "minimum": 0
    },
    "snapshot_archive_generation": {
      "type": "integer",
      "minimum": 0
    },
    "plan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "cpu_count": {
          "type": "integer"
        },
        "memory_in_bytes": {
          "type": "integer"
        },
        "disk_size_in_gb": {
          "type": "integer"
        },
        "max_snapshot_count": {
          "type": "integer"
        }
      }
    },
    "hostserver": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "hostname": {
          "type": "string",
          "format": "hostname"
        }
      }
    }
  }
}

プロパティ

プロパティ

型

編集可否

説明

.id

string

不可

アカウントを一意に特定する ID

.label

string

可

アカウントを識別する任意のラベル

.hostname

string

不可

アカウントのホストネーム

.created_at

string

不可

アカウントの作成日時

.ipv4_address

string

不可

アカウントのプライベート IPv4 アドレス

アカウント内で公開するウェブサーバーはこの IPv4 アドレスまたは 0.0.0.0 をリッスンします。

.ssh_port

integer

不可

アカウントに SSH 接続する際のポート番号

  • 接続先ホストネームは .hostserver.hostname を利用します

  • ssh -p {.ssh_port} {username}@{.hostserver.hostname}

.snapshot_interval_in_minute

integer

可

自動スナップショットを撮る間隔（分単位）

60 の倍数かつ 1440 の約数、または 1440 の倍数

.snapshot_archive_interval

integer

可

未使用

.snapshot_archive_generation

integer

可

未使用

.plan.id

string

不可

プランを特定する ID

.plan.name

string

不可

プラン名

.plan.cpu_count

integer

不可

利用できる vCPU の数

.plan.memory_in_bytes

integer

不可

利用できるメモリの量（ B 単位）

.plan.disk_size_in_gb

integer

不可

利用できるストレージの量（ GiB 単位）

.plan.max_snapshot_count

integer

不可

保存できるスナップショットの最大数

.hostserver.id

string

不可

ホストサーバーを特定する ID

.hostserver.hostname

string

不可

ホストサーバーのホストネーム

サンプルオブジェクト

{
  "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "label": "はじめての Gehirn RS2 Plus アカウント",
  "hostname": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.gehirn.ne.jp",
  "created_at": "2015-04-01T09:00:00Z",
  "ipv4_address": "10.0.3.10",
  "ssh_port": 22310,
  "snapshot_interval_in_minute": 480,
  "snapshot_archive_interval": 0,
  "snapshot_archive_generation": 0,
  "plan": {
    "id": "7fd8de64-452d-4861-a4ef-d34562c9cdec",
    "name": "Gehirn RS2 Plus スタンダード",
    "cpu_count": 1,
    "memory_in_bytes": 2147483648,
    "disk_size_in_gb": 50,
    "max_snapshot_count": 12
  },
  "hostserver": {
    "id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
    "hostname": "sX.rs2plus.gehirn.ne.jp"
  }
}

作成

新しいアカウントを作成します。

新しいアカウントが作成された時点からご利用料金が発生します。

HTTP リクエスト

POST /rs2p/v1/containers HTTP/1.1
Host: api.gis.gehirn.jp
Content-Type: application/json

リクエストボディ

{
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string"
    },
    "label": {
      "type": "string",
      "maxLength": 255
    }
  },
  "required": [ "plan_id", "label" ]
}

HTTP レスポンス

作成されたアカウントオブジェクトが返ります。

一覧

Gehirn RS2 Plus に存在するすべてのアカウントを取得します。

HTTP リクエスト

GET /rs2p/v1/containers HTTP/1.1
Host: api.gis.gehirn.jp

リクエストボディ

リクエストボディは必要ありません。

HTTP レスポンス

空の JSON array またはひとつ以上のアカウントオブジェクトを含む JSON array がレスポンスされます。

取得

Gehirn RS2 Plus に存在する個別のアカウントを取得します。

HTTP リクエスト

GET /rs2p/v1/containers/{container_id} HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター

値

container_id

取得するアカウントの ID

リクエストボディ

リクエストボディは必要ありません。

HTTP レスポンス

指定したアカウントオブジェクトが返ります。

設定

個別のアカウントを設定します。

HTTP リクエスト

PUT /rs2p/v1/containers/{container_id} HTTP/1.1
Host: api.gis.gehirn.jp
Content-Type: application/json

パラメーター

パラメーター

値

container_id

編集するアカウントの ID

リクエストボディ

編集を行ったアカウントオブジェクトをリクエストしてください。

HTTP レスポンス

更新されたアカウントオブジェクトが返ります。

削除

アカウントを削除します。

いかなる場合もアカウントの削除は取り消せず、削除されたデータも復元できないのでご注意ください。

HTTP リクエスト

DELETE /rs2p/v1/containers/{container_id} HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター

値

container_id

削除するアカウントの ID

リクエストボディ

リクエストボディは必要ありません。

HTTP レスポンス

削除されたアカウントオブジェクトが返ります。