API一覧

API一覧

DO-APIでは以下のAPIが利用できます。

■契約・解約
 ・DNSアウトソースサービスの契約・解約
管理権限HTTPメソッドAPI名目的
必要POSTcontractDNSアウトソースサービスの新規契約
必要POSTzoneDNSアウトソースサービスへのゾーン追加
必要

DELETE

zone

DNSアウトソースサービスへのゾーン削除


 ・サイトフェイルオーバーオプションの契約・解約  


管理権限HTTPメソッドAPI名目的
必要POSTdow_optionサイトフェイルオーバーオプションの新規契約
必要DELETE

dow_option

サイトフェイルオーバーオプションの解約


■DNSアウトソースサービス
・DNSレコードの編集
管理権限HTTPメソッドAPI名目的
不要GETrecordレコード取得
不要POSTrecordレコード追加
不要PUTrecordレコード更新
不要DELETErecordレコード削除
・DNSレコード一括編集
管理権限HTTPメソッドAPI名目的
不要GETrecordsレコード一覧取得
不要PUTrecordsレコード一覧更新
不要GETdiff編集中レコード一覧取得
不要PUTtransferゾーン転送(一括更新)
・レコード変更履歴
管理権限HTTPメソッドAPI名目的
不要GEThistory

変更履歴取得

・DNSへ反映/リセット
管理権限HTTPメソッドAPI名目的
不要PUTcommit

DNSへ反映(コミット)

不要PUTreset編集リセット(編集中の内容をすべて破棄)
・APEXレコードのアドレス再取得/更新
管理権限HTTPメソッドAPI名目的
不要GETre_resolveAPEXレコードのアドレスを再取得
不要PUTre_resolveAPEXレコードのアドレスを再取得して更新
・システム履歴の取得

 

管理権限HTTPメソッドAPI名目的
不要GETsystem_historyシステム履歴の取得
・その他
管理権限HTTPメソッドAPI名目的
不要GETzonesゾーン一覧取得(ゾーン名のみ)
不要GETzoneゾーン情報取得
不要PUTttl標準TTL値の設定
不要GETechoAPI疎通テスト
■DNSアウトソースサービス サイトフェイルオーバーオプション
・グループの設定
管理権限HTTPメソッドAPI名目的
不要GETgroupsグループ情報の取得
不要GETcommitted_group反映中グループの取得
不要PUTrestore切り戻しの設定
不要PUTrelease切り離しの設定
・監視の設定
管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要GETtargets監視対象一覧の取得
不要GETtarget監視対象の取得
不要POSTtarget監視対象の作成
不要PUTtarget監視対象の更新
不要DELETEtarget監視対象の削除
不要PUTtarget/(enable)監視対象の監視有効化
不要PUTtarget/(disable)監視対象の監視無効化
不要POSTtarget/(manual)監視対象レコードを手動登録
不要DELETEtarget/(manual)監視対象レコードを手動削除
不要GETtarget/(re_resolve)監視対象のホスト名のアドレスを再取得
不要PUTtarget/(re_resolve)監視対象のホスト名のアドレスを再取得して更新
不要GETtarget/(monitorings)監視対象に紐付く監視一覧取得
不要GETtarget/(monitoring)監視の取得
不要POSTtarget/(monitoring)監視の作成
不要PUTtarget/(monitoring)監視の更新
不要DELETEtarget/(monitoring)監視の削除

 

・SorryServerの設定
管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要GETsorrySorryServer情報の取得
不要PUTsorry/(enable)SorryServerの有効化
不要PUTsorry/(disable)SorryServerの無効化

 

・通知先メール/通知先電話の設定
管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要GETrecipient/(mails)通知先メール情報一覧の取得
不要GETrecipient/(mail)通知先メール情報の取得
不要POSTrecipient/(mail)通知先メール情報の追加
不要PUTrecipient/(mail)通知先メール情報の更新
不要DELETErecipient/(mail)通知先メール情報の削除
不要GETrecipient/(phones)通知先電話情報一覧の取得
不要GETrecipient/(phone)通知先電話情報の取得
不要POSTrecipient/(phone)通知先電話情報の追加
不要PUTrecipient/(phone)通知先電話情報の更新
不要DELETErecipient/(phone)

通知先電話情報の削除

 

 ・契約状態の取得
管理権限HTTPメソッドAPI名目的
不要GET

dow_option

サイトフェイルオーバーオプションの契約状態の取得

 

 

 

 

APIバージョン

DO-APIで提供するAPI群にはバージョンが設定されています。バージョンによって一部のパラメータや、挙動が変化する場合があります

APIをリクエストする際に、APIVersionパラメータを指定することで、どのバージョンのAPIを実行するかを指定できます。

現在指定可能なAPIVersionは以下のとおりです。

APIVersion利用開始日利用終了日備考
201406012014年7月3日未定初期リリース版

API詳細における凡例 (レスポンス)

各API一覧ページでは、レスポンスの説明に以下のような表記を使用します。

JSON表記

JSON
{
    "SampleApiResponse": {
        "Param1": "abcdefg",
        "Param2": {
            "ParamA": "pqr",
            "ParamB": "xyz"
        },
        "Param3": [
            {
                "ParamC": "123"
            },
            {
                "ParamC": "987"
            }
        ]
    }
}
フィールドタイプ意味
SampleApiResponse.Param1String単純な値
SampleApiResponse.Param2Object内部に複数の値を含む連想配列
SampleApiResponse.Param2.ParamAString構造体に含まれる単純な値
SampleApiResponse.Param2.ParamBString構造体に含まれる単純な値
SampleApiResponse.Param3Array内部に複数の値を含む単純配列
SampleApiResponse.Param3.ParamCString配列に含まれる単純な値
  • 構造化されたフィールドのキーは、表中ではそれぞれのキーを"."(ドット)で連結して現します
  • DO-APIでは値に型はありません。すべて文字列として取り扱います。