ニフクラAPI (DNS: CreateHostedZone)

CreateHostedZone

処理概要

ゾーンの作成を行います。

リクエストボディにてゾーンの作成に必要な情報を入力し、それにもとづいてゾーンが作成されます。

作成したゾーンのドメインをユーザーが所持している場合、認証なしでゾーンが作成されます。

作成したゾーンのドメインをユーザーが所持していない場合、ゾーン作成前に認証が行われるため、Unauthorizedエラーが発生します。 Unauthorized発生の場合、エラーメッセージにある認証情報をレジストラまたはDNSに設定し、再度本APIを実行してください。

認証に失敗した場合は、ゾーンは作成されずエラーが返されます。

リクエストURL

POST https://dns.api.nifcloud.com/2012-12-12N2013-12-16/hostedzone

指定するパラメーター

リクエストボディ

パラメーター	型	説明	必須
CreateHostedZoneRequest	structure	ルート	○
␣Name	string	ゾーン名（ドメイン）	○
␣CallerReference	string	ゾーン識別子 備考: 無視
␣HostedZoneConfig	structure	付加情報
␣␣Comment	string	コメント（ゾーン） 使用可能文字: 0～255文字

応答フィールド

レスポンスボディ

フィールド (項目)	型	説明
CreateHostedZoneResponse	structure	ルート
␣HostedZone	structure	ゾーン情報
␣␣Id	string	ゾーンID 備考: 正規化したゾーン名
␣␣Name	string	ゾーン名（ドメイン） 備考: 正規化したゾーン名
␣␣CallerReference	string	ゾーン識別子 備考: 正規化したゾーン名
␣␣Config	structure	ゾーンの付加情報
␣␣␣Comment	string	コメント（ゾーン） 備考: リクエストで指定した値
␣␣ResourceRecordSetCount	integer	レコード設定数
␣ChangeInfo	structure	更新リクエスト情報
␣␣Id	string	更新リクエストID
␣␣Status	string	反映ステータス 値: PENDING INSYNC
␣␣SubmittedAt	string	更新リクエスト発行日時 値：yyyy-mm-ddThh:mm:ss.mmmZ
␣DelegationSet	structure	ネームサーバー情報
␣␣NameServers	list	NSドメインのリスト
␣␣␣NameServer	string	NSドメイン

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
InvalidDomainName	Invalid hosted zone name	Sender	404	ゾーン名(ドメイン)の指定が不正
HostedZoneAlreadyExists	A hosted zone has already been created.	Sender	409	存在するゾーン名(ドメイン)を設定した
Unauthorized	name_server:%value%.dns-verify.ippas.nifty.com,txt:nifty-dns-verify=%value%	Sender	401	認証が必要
AccessDenied	Locked zone	Sender	403	対象ゾーンを更新中のためアクセス不可

リクエストサンプル

    POST /2012-12-12N2013-12-16/hostedzone HTTP/1.1
Host: dns.api.nifcloud.com
Date: Thu, 17 Jun 2021 08:53:44 GMT
X-Nifty-Authorization: NIFTY3-HTTPS NiftyAccessKeyId=<Nifty Cloud Access Key>,Algorithm=<HmacSHA1|HmacSHA256>,Signature=<Signature>

<CreateHostedZoneRequest xmlns="https://route53.amazonaws.com/doc/2012-12-12/">
  <Name>example.com</Name>
  <Comment>コメント</Comment>
</CreateHostedZoneRequest>

  

応答サンプル

    <?xml version="1.0" encoding="UTF-8"?>
<CreateHostedZoneResponse xmlns="https://route53.amazonaws.com/doc/2012-12-12/">
  <HostedZone>
    <Id>/hostedzone/example.com</Id>
    <Name>example.com</Name>
    <CallerReference>example.com</CallerReference>
    <Config>
      <Comment>コメント</Comment>
    </Config>
    <ResourceRecordSetCount>0</ResourceRecordSetCount>
  </HostedZone>
  <ChangeInfo>
    <Id>c781aede931565ca3d124e756f5396f3</Id>
    <Status>INSYNC</Status>
    <SubmittedAt>2021-06-17T08:53:44.110Z</SubmittedAt>
  </ChangeInfo>
  <DelegationSet>
    <NameServers>
      <NameServer>ns0.dns.nifcloud.com</NameServer>
      <NameServer>ns1.dns.nifcloud.com</NameServer>
    </NameServers>
  </DelegationSet>
</CreateHostedZoneResponse>