レコード

オブジェクト

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 5
    },
    "enable_alias": {
      "type": "boolean"
    },
    "alias_to": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "ttl": {
      "type": "integer",
      "minimum": 30,
      "maximum": 2147483647
    },
    "records": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "prio": {
            "type": "integer",
            "minimum": 0,
            "maximum": 32767
          },

          "address": {
            "type": "string",
            "minLength": 3,
            "maxLength": 39
          },

          "cname": {
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },

          "exchange": {
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },

          "nsdname": {
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },

          "target": {
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          },
          "port": {
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
          },
          "weight": {
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
          },

          "data": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64000
          }
        }
      }
    }
  }
}

プロパティ

プロパティ

説明

id

string

レコードを一意に特定する ID

name

string

ホストネーム

type

string

A 、 AAAA 、 CNAME 、 MX 、 NS 、 SRV 、 TXT いずれかのリソースタイプ

enable_alias

boolean

エイリアス機能状況

alias_to

string

エイリアス先

ttl

integer

TTL

records

array

リソースタイプに応じたレコードのリスト

A リソースレコード

プロパティ

説明

records.address

string

IPv4 アドレス

AAAA リソースレコード

プロパティ

説明

records.address

string

IPv6 アドレス

CNAME リソースレコード

プロパティ

説明

records.cname

string

CNAME

MX リソースレコード

プロパティ

説明

records.prio

integer

プライオリティ

records.exchange

string

メールエクスチェンジのドメインネーム

NS リソースレコード

プロパティ

説明

records.nsdname

string

ネームサーバーのドメインネーム

SRV リソースレコード

プロパティ

説明

records.target

string

ターゲットのドメインネーム

records.port

integer

ポート番号

records.weight

integer

ウェイト

TXT リソースレコード

プロパティ

説明

records.data

string

データ

作成

指定したバージョンに新しいレコードを追加します。

HTTP リクエスト

POST /dns/v1/zones/:zone_id/versions/:version_id/records HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター

zone_id

レコードを追加するゾーンの ID

version_id

レコードを追加するバージョンの ID

リクエストボディ

追加したい レコードオブジェクト をリクエストしてください。

HTTP レスポンス

追加された レコードオブジェクト が返ります。

一覧

指定したバージョンに存在するすべてのレコードを取得します。

HTTP リクエスト

GET /dns/v1/zones/:zone_id/versions/:version_id/records HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター

zone_id

取得するレコードを含むゾーンの ID

version_id

取得するレコードを含むバージョンの ID

リクエストボディ

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

HTTP レスポンス

ひとつ以上のレコードオブジェクトを含む JSON array が返ります。

取得

指定したバージョンに存在する個別のレコードを取得します。

HTTP リクエスト

GET /dns/v1/zones/:zone_id/versions/:version_id/records/:record_id HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター

zone_id

取得するレコードを含むゾーンの ID

version_id

取得するレコードを含むバージョンの ID

record_id

取得するレコードの ID

リクエストボディ

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

HTTP レスポンス

指定したレコードオブジェクトが返ります。

編集

指定したバージョンに存在する個別のレコードを編集します。

HTTP リクエスト

PUT /dns/v1/zones/:zone_id/versions/:version_id/records/:record_id HTTP/1.1
Host: api.gis.gehirn.jp

リクエストパラメータ

パラメーター

zone_id

編集するレコードを含むゾーンの ID

version_id

編集するレコードを含むバージョンの ID

record_id

編集するレコードの ID

リクエストボディ

編集したレコードオブジェクトをリクエストしてください。

HTTP レスポンス

編集されたレコードオブジェクトが返ります。

削除

指定したバージョンから個別のレコードを削除します。

HTTP リクエスト

DELETE /dns/v1/zones/:zone_id/versions/:version_id/records/:record_id HTTP/1.1
Host: api.gis.gehirn.jp

パラメーター

パラメーター

zone_id

削除するレコードを含むゾーンの ID

version_id

削除するレコードを含むバージョンの ID

record_id

削除するレコードの ID

リクエストボディ

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

HTTP レスポンス

削除されたレコードオブジェクトが返ります。