This project is read-only.

以下は、C# の構文での、Doznes API Client ライブラリのリファレンスです。

このページの最後のほうには、F#、Windows PowerShell、VBScript、そのほかCOMクライアントから利用する際の留意点を掲載してあります。

 

 


名前空間 DozensAPI

 

Dozens クラス

概要

Dozens の REST API を呼び出して、ゾーンやレコードの追加・取得・変更・削除を行います。

 

コンストラクタ

public Dozens(string dozensUserId, string apiKey )

Dozens アカウントの ID と API KEY を指定して、Dozens クラスの新しいインスタンスを初期化します。

ゾーンやレコードの追加/取得/変更/削除を行う前の、明示的な Auth メソッド呼び出しは不要です。
引数に渡された ID と API KEY で必要に応じて自動的に認証を行います。

 

public Dozens()

Dozens クラスの新しいインスタンスを初期化します。

ゾーンやレコードの追加/取得/変更/削除を行う前に、Auth メソッドによる認証が必要です。

引数付きのコンストラクタを使うことのできない COM クライアントは、必然的にこの引数無しバージョンのコンストラクタでオブジェクト生成することになります。

 

認証

public void Auth(string dozensUserId, string apiKey)

Dozens アカウントの ID と API KEY を指定して、認証を行います。

成功すると、Token プロパティに認証結果のトークンが格納され、以後の操作(ゾーンやレコードの追加/取得/変更/削除) で使われます。

なお、引数付きのコンストラクタで Dozens オブジェクトを生成した場合は、明示的にこの Auth メソッドを呼び出す必要はありません。

引数付きのコンストラクタを使うことのできない COM クライアントで、必然的に引数無しバージョンのコンストラクタでオブジェクト生成したのちに、この Auth メソッドで認証を済ませることになります。

 

ゾーンの操作

public DozensZone[] GetZones()

ゾーン(ドメイン)リストを取得します。

 

public DozensZone[] CreateZone(string zoneName, bool addGoogleApps = false, string googleAuthorize = null)

ゾーンを新規登録します。

zoneName
ゾーンの名前です。(ex."dozens.jp")

addGoogleApps
GoogleApps のレコードを追加する場合は true を指定します。省略時は false です。

googleAuthorize
CNAME によって GoogleApps の確認をする場合に設定します。省略時は null です。

戻り値
登録されているすべてのゾーンの配列

 

public DozensZone[] DeleteZone(int zoneId)

引数に指定したゾーンIDのゾーンを削除します。

戻り値
登録されているすべてのゾーンの配列

 

public DozensZone[] DeleteZone(string zoneName)

引数に指定したゾーン名のゾーンを削除します。

zoneName
削除する対象のゾーンの、ゾーン名 (ex."dozens.jp")

戻り値
登録されているすべてのゾーンの配列

 

レコードの操作

public DozensRecord[] GetRecords(string zoneName)

引数に指定したゾーン名のゾーンに登録されているレコードリストを取得します。

zoneName
ゾーンの名前 (ex."dozens.jp") 

戻り値
指定のゾーンに登録されているすべてのレコードの配列 

 

public DozensRecord[] CreateRecord(string zoneName, string name, string type, int prio, string content, int ttl = 7200)
public DozensRecord[] CreateRecord(string zoneName, string name, string type, object prio, string content, int ttl = 7200)

指定のゾーンにレコードを新規登録します。

zoneName
レコードを新規登録する対象のゾーン名 (ex."dozens.jp")。

name
新規登録するレコードの名前 (ex."www", "www.dozens.jp")。

type
新規登録するレコードのタイプ (ex."A","CNAME","MX","TXT")。

prio
新規登録するレコードのプライオリティ。整数値か、null を指定します。

content
新規登録するレコードの値。

ttl
新規登録するレコードの TTL。省略時は 7200 です。
指定できる TTL は、Dozens の料金プランにもよりますので、Doznes API のドキュメントでご確認下さい。 

戻り値
指定のレコードと同じゾーンに登録されているすべてのレコードの配列

 

public DozensRecord[] UpdateRecord(int recordId, int prio, string content, int ttl = 7200)
public DozensRecord[] UpdateRecord(int recordId, object prio, string content, int ttl = 7200)

レコードIDで指定したレコードの登録内容を変更(更新)します。

recordId
変更(更新)する対象のレコードを一意に識別するレコードID。

prio
変更後のプライオリティ。整数値か、null を指定します。

content
変更後の値。

ttl
変更後のTTL。省略時は 7200 です。
指定できる TTL は、Dozens の料金プランにもよりますので、Doznes API のドキュメントでご確認下さい。 

戻り値
指定のレコードと同じゾーンに登録されているすべてのレコードの配列

 

public DozensRecord[] UpdateRecord(string zoneName, string name, int prio, string content, int ttl = 7200)
public DozensRecord[] UpdateRecord(string zoneName, string name, object prio, string content, int ttl = 7200)

ゾーン名とホスト名で指定したレコードの登録内容を変更(更新)します。

zoneName
変更(更新)対象のレコードを含んでいるゾーンの名前 (ex."dozens.jp")。

name
変更(更新)対象のレコードの名前 (ex."www", "www.dozens.jp")。

prio
変更後のプライオリティ。整数値か、null を指定します。

content
変更後の値。

ttl
変更後のTTL。省略時は 7200 です。
指定できる TTL は、Dozens の料金プランにもよりますので、Doznes API のドキュメントでご確認下さい。 

戻り値
指定のレコードと同じゾーンに登録されているすべてのレコードの配列

 

public DozensRecord[] UpdateRecord(string fqdn, int prio, string content, int ttl = 7200)
public DozensRecord[] UpdateRecord(string fqdn, object prio, string content, int ttl = 7200)

ゾーン名とホスト名で指定したレコードの登録内容を変更(更新)します。

fqdn
変更(更新)対象のレコードを特定する FQDN (ex."www.dozens.jp")。

prio
変更後のプライオリティ。整数値か、null を指定します。

content
変更後の値。

ttl
変更後のTTL。省略時は 7200 です。
指定できる TTL は、Dozens の料金プランにもよりますので、Doznes API のドキュメントでご確認下さい。 

戻り値
指定のレコードと同じゾーンに登録されているすべてのレコードの配列

 

public DozensRecord[] DeleteRecord(string zoneOrFQDName, string name = null)

指定したゾーン名、レコード名のレコードを削除します。

zoneOrFQDName
削除対象のレコードを含むゾーンの名前 (ex."dozens.jp")。
あるいは、削除対象のレコードを特定する FQDN (ex."www.dozens.jp")。

name
削除対象のレコード名 (ex."www","www.dozens.jp")。
zoneOrFQDName に FQDN (ex."www.dozens.jp") を指定した場合は、null を指定してください。
省略時は null です。

戻り値
指定のレコードと同じゾーンに登録されているすべてのレコードの配列

 

プロパティ

public string Token { get; set; }

Dozens REST API を呼び出すときに使う、認証後のトークンを取得または設定します。
通常は設定する必要はありません。
コンストラクタまたは Auth メソッドに指定された Dozens ID と API KEY によって自動的に認証され、その結果が設定されます。

public string BaseURL  { get; set; }

Dozens REST API の URL を取得または設定します。既定では "http://dozens.jp/api" に初期化されます。

 

 


 

 

DozensZone クラス

概要

Dozens の DNS ゾーン情報です。

プロパティ

public int Id { get; set; }

ゾーンを一意に識別する、Dozens 内部で用いるゾーンのIDを取得または設定します。

public string Name { get; set; }

ゾーンの名前 (ex. "dozens.jp") を取得または設定します。

 

 


 

DozensRecord クラス

概要

Dozens の DNS レコード情報です。

プロパティ

public int Id { get; set; }

レコードを一意に識別する、Dozens 内部で用いるレコードのIDを取得または設定します。

public string Name { get; set; }

レコードの FQDN (ex. "www.dozens.jp") を取得または設定します。

public string Type { get; set; }

レコードのタイプ (ex."A","CNAME","MX","TXT") を取得または設定します。

public int? Prio { get; set; }

レコードのプライオリティを取得または設定します (null 指定可)。

public string Content { get; set; }

レコードの値 (ex. "192.168.0.1", "mail.dozens.jp") を取得または設定します。

public int TTL { get; set; }

レコードの TTL を取得または設定します。

 

 


 

 

F# から利用する際の留意点

  • 引数の省略はできません。

 

Windows PowerShell から利用する際の留意点

  • UpdateRecord メソッドのオーバーロードバージョンのうち、FQDN でレコードを指定するバージョンは呼び出せません(PowerShell のオーバーロード解決アルゴリズムによる制限?)。
    ゾーン名とホスト名の二つでレコードを指定するバージョンを利用して下さい。
  • プライオリティ指定を空にしたい場合は、$null と指定して下さい。

 

VBScript から利用する際の留意点

  • プライオリティ指定を空にしたい場合は、Nothing と指定して下さい。

 

VBScript はじめ、COM クライアントから利用する際の留意点

  • COMではメソッドのオーバーロードは実現できていないため、DoznesAPI.Doznes クラスのメソッドのオーバーロード各バージョンには、下表のとおり別名が割り当てられています。
メソッド COM上でのメソッド別名
DeleteZone(int zoneId) DeleteZone
DeleteZone(string zoneName) DeleteZone_2
UpdateRecord(int recordId, int prio, string content, int ttl) UpdateRecord
UpdateRecord(int recordId, object prio, string content, int ttl) UpdateRecord_2
UpdateRecord(string zoneName, string name, int prio, string content, int ttl) UpdateRecord_3
UpdateRecord(string zoneName, string name, object prio, string content, int ttl) UpdateRecord_4
UpdateRecord(string fqdn, int prio, string content, int ttl) UpdateRecord_5
UpdateRecord(string fqdn, object prio, string content, int ttl) UpdateRecord_6
DeleteRecord(int recordId) DeleteRecord
DeleteRecord(string zoneOrFQDName, string name) DeleteRecord_2
  • IDispatch 経由の遅延バインディングでのみ呼び出せます。COM インターフェースは定義されていません。

Last edited Jul 26, 2011 at 3:29 PM by jsakamoto, version 10

Comments

No comments yet.