ゾーンの作成 (POST /v1.0/hostedzone)
ゾーンの作成を行います。
リクエストボディにてゾーンの作成に必要な情報を入力し、それにもとづいてゾーンが作成されます。
登録できるゾーン数はプロジェクトごとに最大500までです。
API実行の際にはドメインの所有権を確認するために確認コードによる認証を行います。
最初に本APIを実行すると、Unauthorisedエラーが発生します。Unauthorisedエラーが発生した場合、レスポンスのエラーメッセージにある確認コードをレジストラまたはDNSに設定し、再度本APIを実行してください。
同時刻に新規作成中ゾーンと同一名のゾーン作成APIを実行した場合、500 Internal Errorとなりますので、リトライを実施してください。
Request Headers
なし
Request Parameter
なし
Request Elements
CreateHostedZoneRequest
リクエストのエンベロープ。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | None | Name
HostedZoneConfig |
Name
ゾーン名。FQDN形式。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | CreateHostedZoneRequest | None |
HostedZoneConfig
付加情報のエンベロープ。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 0..1 | CreateHostedZoneRequest | Comment |
Comment
コメント。全角255文字以内。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 0..1 | HostedZoneConfig | None |
HTTP ステータス
ステータス
リクエストのステータスを返却する。
- 201:
- 正常終了
- 400:
- 認証が必要/ゾーン名不正
- 404:
- ゾーン名の指定が不正
- 409:
- 存在するゾーン名を指定した
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response Elements(正常終了時)
CreateHostedZoneResponse
レスポンスのエンベロープ。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | None | HostedZone
ChangeInfo DelegationSet |
HostedZone
ゾーン情報のエンベロープ。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | CreateHostedZoneResponse | Id
Name CallerReference Config ResourceRecordSetCount |
Id
作成されたゾーンのID。ゾーン名と同じ値。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | HostedZone | None |
Name
作成されたゾーンの名称。正規化された値。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | HostedZone | None |
CallerReference
作成されたゾーンのゾーン識別子。ゾーン名と同じ値。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | HostedZone | None |
Config
付加情報のエンベロープ。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | HostedZone | Comment |
Comment
コメント。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 0..1 | Config | None |
ResourceRecordSetCount
ホストゾーン内に登録されているレコード数。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | HostedZone | None |
ChangeInfo
更新リクエスト情報のエンベロープ。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | CreateHostedZoneResponse | Id
Status SubmittedAt |
Id
更新リクエストID。
GetChange APIで更新リクエスト情報の取得に使用します。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | ChangeInfo | None |
Status
更新リクエストの現在の状態。
PENDINGまたはINSYNC。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | ChangeInfo | None |
SubmittedAt
更新リクエスト発行日時。形式:YYYY-MM-DDThh:mm:ss.SSSZ
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | ChangeInfo | None |
DelegationSet
ネームサーバ情報のエンベロープ。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | CreateHostedZoneResponse | NameServers |
NameServers
ネームサーバリストのエンベロープ。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | DelegationSet | NameServer |
NameServer
ゾーンに割り当てられたネームサーバ。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..n | NameServers | None |
Example of Request
POST /v1.0/hostedzone HTTP/1.1
Date: Fri, 06 Jun 2014 11:00:37 GMT
Content-Length: …
Host: dns.gls.cloud.global.fujitsu.com
Content-Type: application/xml
Accept: application/xml
X-Auth-Token: MIIFvgY…
<?xml version="1.0" encoding="UTF-8"?>
< CreateHostedZoneRequest xmlns="http://docs.cloudcommunity.global.fujitsu.com/dns/api/v1.0/">
<Name>example.com</Name>
<HostedZoneConfig>
<Comment>comment</Comment>
</HostedZoneConfig>
</CreateHostedZoneRequest>
Example of Response
HTTP/1.1 201 Created
Date: Fri, 06 Jun 2014 11:00:38 GMT
Content-Length: …
Content-Type: application/xml
x-fj-request-id: d96bd874-9bf2-11e1-8ee7-c98a0037a2b6
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
< CreateHostedZoneResponse xmlns="http://docs.cloudcommunity.global.fujitsu.com/dns/api/v1.0/">
<HostedZone>
<Id>example.com</Id>
<Name>example.com<Name>
<CallerReference>example.com</CallerReference>
<Config>
<Comment>comment</Comment>
</Config>
<ResourceRecordSetCount>0</ResourceRecordSetCount>
</HostedZone>
<ChangeInfo>
<Id>cb7faf29ae2bb2bd489d0d27b36e28fc</Id>
<Status>INSYNC</Status>
<SubmittedAt>2014-06-06T11:00:38.370Z</SubmittedAt>
</ChangeInfo>
<DelegationSet>
<NameServers>
<NameServer>ns0.dns.nifcloud.com</NameServer>
<NameServer>ns1.dns.nifcloud.com</NameServer>
</NameServers>
</DelegationSet>
</CreateHostedZoneResponse>
ドメインの所有権を確認するための確認コードによる認証の流れ
- CreateHostedZone APIでは作成するゾーンのドメインが、APIを実行した利用者が所有するドメインであることを確認するために確認コードによる認証が必要になります。
以下に確認コードの設定方法を示します。
指定するドメインが新規取得ドメイン(まだどのDNSでも管理されていない)か、既存ドメイン(すでにほかのDNSで管理されている)で設定方法は異なります。
- 確認コードの取得方法
作成予定のゾーンと同じパラメタを指定して、CreateHostedZone APIを実行します。APIの実行はUnauthorizedでエラーになり、エラーメッセージに確認コードが出力されるので取得してください。
Response Body: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ErrorResponse xmlns="http://docs.cloudcommunity.global.fujitsu.com/dns/api/v1.0/"> <Error><Type>Sender</Type><Code>Unauthorized</Code> <Message>name_server:f0094d76e096551441d24af257488a6a.ns-verify.dns.nifcloud.jp,txt:nifty-dns-verify=f0094d76e096551441d24af257488a6a</Message> </Error><RequestId>req-ac1ac325-2880-4cf5-8e5f-42dc9097b5d4</RequestId></ErrorResponse>
- 新規取得ドメインの場合の確認コードの設定方法
レジストラに以下のネームサーバを設定してください。以下の値はレスポンス例が返却された場合の値であり、ダミーです。
発行される値は、APIを実行する毎に変わる場合があります。
f0094d76e096551441d24af257488a6a.ns-verify.dns.nifcloud.jp
- 既存ドメインの場合の確認コードの設定方法
DNSにテキストレコードを設定してください。以下の値はレスポンス例が返却された場合の値であり、ダミーです。
発行される値は、APIを実行する毎に変わる場合があります。
nifty-dns-verify=f0094d76e096551441d24af257488a6a