Create zone#
ゾーンの作成を行います。
リクエストボディにてゾーンの作成に必要な情報を入力し、それにもとづいてゾーンが作成されます。
登録できるゾーン数はプロジェクトごとに最大500までです。
API実行の際にはドメインの所有権を確認するために確認コードによる認証を行います。
最初に本APIを実行すると Unauthorisedエラーが発生します。
Unauthorisedエラーが発生した場合、レスポンスのエラーメッセージにある確認コードをレジストラまたはDNSに設定し、再度本APIを実行してください。
同時刻に新規作成中ゾーンと同一名のゾーン作成APIを実行した場合、500 Internal Errorが発生するためリトライしてください。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://dns.gls.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://dns.gls.cloud.global.fujitsu.com |
HTTPメソッドとURI#
POST
/v1.0/hostedzone
HTTPステータスコード#
正常時:201
エラー時:400, 404, 409
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
CreateHostedZoneRequest | body | - | 必須 | リクエストのエンベロープ |
Name | body | string | 必須 | ゾーン名 FQDN形式で指定します。 |
HostedZoneConfig | body | - | 任意 | 付加情報のエンベロープ |
Comment | body | string | 任意 | コメント 全角255文字以内で指定します。 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
CreateHostedZoneResponse | - | レスポンスのエンベロープ |
HostedZone | - | ゾーン情報のエンベロープ |
Id | string | 作成されたゾーンのID ゾーン名と同じ値です。 |
Name | string | 作成されたゾーンの名称 正規化された値です。 |
CallerReference | string | 作成されたゾーンのゾーン識別子 ゾーン名と同じ値です。 |
Config | - | 付加情報のエンベロープ |
Comment | string | コメント |
ResourceRecordSetCount | string | ホストゾーン内に登録されているレコード数 |
ChangeInfo | - | 更新リクエスト情報のエンベロープ |
Id | string | 更新リクエストID GetChange APIで更新リクエスト情報の取得に使用します。 |
Status | string | 更新リクエストの現在の状態 PENDINGまたはINSYNC。 |
SubmittedAt | string | 更新リクエスト発行日時 形式:YYYY-MM-DDThh:mm:ss.SSSZ |
DelegationSet | - | ネームサーバ情報のエンベロープ |
NameServers | - | ネームサーバリストのエンベロープ |
NameServer | string | ゾーンに割り当てられたネームサーバ |
リクエスト例#
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>
レスポンス例#
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