マイグレーション

オブジェクト

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 36
    },
    "prev_version_id": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36
    },
    "next_version_id": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36
    },
    "applied_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "completed_at": {
      "type": "string"
    },
    "is_completed": {
      "type": "boolean"
    }
  }
}

プロパティ

プロパティ	型	説明
id	string	マイグレーションを一意に識別する ID
name	string	マイグレーションを説明する任意の名前
prev_version_id	string	マイグレーション前のバージョンの ID
next_version_id	string	マイグレーション後のバージョンの ID
applied_at	string	ISO8601 で表現されるマイグレーションの実行日時
created_at	string	ISO8601 で表現されるマイグレーションの作成日時
completed_at	string	ISO8601 で表現されるマイグレーションの完了日時
is_completed	boolean	マイグレーションの完了状況

作成

指定したゾーンに新しいマイグレーションを作成します。

HTTP リクエスト

POST /dns/v1/zones/:zone_id/presets HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター	値
zone_id	マイグレーションを作成するゾーンの ID

リクエストボディ

作成したいマイグレーションオブジェクトをリクエストしてください。

HTTP レスポンス

作成されたマイグレーションオブジェクトが返ります。

一覧

指定したゾーンに存在するすべてのマイグレーションを取得します。

HTTP リクエスト

GET /dns/v1/zones/:zone_id/presets HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター	値
zone_id	取得するマイグレーションを含むゾーンの ID

リクエストボディ

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

HTTP レスポンス

ひとつ以上のマイグレーションオブジェクトを要素とする JSON array が返ります。

取得

指定したゾーンに存在する個別のマイグレーションを取得します。

HTTP リクエスト

GET /dns/v1/zones/:zone_id/presets/:preset_id HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター	値
zone_id	取得するマイグレーションを含むゾーンの ID
preset_id	取得するマイグレーションの ID

リクエストボディ

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

HTTP レスポンス

指定したマイグレーションオブジェクトが返ります。

削除

指定したゾーンから個別のマイグレーションを削除します。

HTTP リクエスト

DELETE /dns/v1/zones/:zone_id/presets/:preset_id HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター	値
zone_id	削除するマイグレーションを含むゾーンの ID
preset_id	削除するマイグレーションの ID

リクエストボディ

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

HTTP レスポンス

削除されたマイグレーションオブジェクトが返ります。