ニフクラAPI (DNS: ChangeResourceRecordSets)

ChangeResourceRecordSets

処理概要

レコードの作成、削除を行います。

リクエストボディにて作成/削除するレコード情報を入力し、それにもとづいてレコード情報の作成/削除が行われます。

1つのリクエスト内で複数のレコード作成/削除操作を指定できますが、処理の途中でエラーになった場合部分的な反映になる場合があります。

同じゾーンに対して同時に作成/削除操作のリクエストを行うと、エラーになる場合があります。

レコード作成/削除は即時反映ではないため、レスポンスには作成された更新リクエスト情報が含まれ、これの反映ステータスがPENDINGからINSYNCに変わったタイミングが反映完了となります。

リクエストURL

POST https://dns.api.nifcloud.com/2012-12-12N2013-12-16/hostedzone/{ZoneID}/rrset

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
ZoneID	string	ゾーンID	○

リクエストボディ

パラメーター	型	説明	必須
ChangeResourceRecordSetsRequest	structure	ルート	○
␣ChangeBatch	structure	レコード操作トランザクション処理	○
␣␣Changes	list	付加情報	○
␣␣␣Change	structure	レコード操作の一覧	○
␣␣␣␣Action	string	レコード操作の種別 値: CREATE DELETE	○
␣␣␣␣ResourceRecordSet	structure	更新リクエスト情報	○
␣␣␣␣␣Name	string	ゾーンID
␣␣␣␣␣Type	string	レコード種別 値: NS A AAAA CNAME MX TXT PTR
␣␣␣␣␣SetIdentifier	integer	レコード識別情報
␣␣␣␣␣Weight	integer	重み付け値 備考: WRR利用時のみ設定
␣␣␣␣␣Region	string	リージョン情報 備考: 登録時無視/表示時空
␣␣␣␣␣Failover	string	フェイルオーバー種別 値: PRIMARY SECONDARY 備考: Failover利用時のみ設定
␣␣␣␣␣XniftyHealthCheckConfig	structure	ヘルスチェック情報 備考: Failover利用時のみ設定
␣␣␣␣␣␣IPAddress	string	ヘルスチェック先IPアドレス
␣␣␣␣␣␣Port	integer	ヘルスチェック先ポート
␣␣␣␣␣␣Protocol	string	ヘルスチェック種別 値: HTTP HTTPS TCP
␣␣␣␣␣␣ResourcePath	string	ヘルスチェック先パス 備考: ProtocalがHTTPの場合のみ
␣␣␣␣␣␣FullyQualifiedDomainName	string	ヘルスチェック先ドメイン 備考: ProtocalがHTTPの場合のみ
␣␣␣␣␣TTL	integer	TTL値
␣␣␣␣␣ResourceRecords	list	レコードの応答情報のリスト
␣␣␣␣␣␣ResourceRecord	structure	レコードの応答情報
␣␣␣␣␣␣␣Value	string	レコードの応答値
␣␣␣␣␣XniftyComment	string	コメント

応答フィールド

レスポンスボディ

フィールド (項目)	型	説明
ChangeResourceRecordSetsResponse	structure	ルート
␣ChangeInfo	structure	更新リクエスト情報
␣␣Id	string	更新リクエストID
␣␣Status	string	反映ステータス 値: PENDING INSYNC
␣␣SubmittedAt	string	更新リクエスト発行日時 値：yyyy-mm-ddThh:mm:ss.mmmZ

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
NoSuchHostedZone	No hosted zone found	Sender	404	URLパラメーター「marker」で指定されたゾーンIDが存在しない
AccessDenied	Locked zone	Sender	403	対象ゾーンを更新中のためアクセス不可

リクエストサンプル

    POST /2012-12-12N2013-12-16/hostedzone/example.com/rrset 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>

<?xml version="1.0" encoding="UTF-8"?>
<ChangeResourceRecordSetsRequest xmlns="https://route53.amazonaws.com/doc/2012-12-12/">
<ChangeBatch>
  <Changes>
    <Change>
      <Action>CREATE</Action>
      <ResourceRecordSet>
        <Name>test.example.com</Name>
        <Type>A</Type>
        <TTL>60</TTL>
        <ResourceRecords>
          <ResourceRecord>
            <Value>1.1.1.1</Value>
          </ResourceRecord>
        </ResourceRecords>
      </ResourceRecordSet>
    </Change>
  </Changes>
  <Comment>コメント</Comment>
</ChangeBatch>
</ChangeResourceRecordSetsRequest>

  

応答サンプル

    <?xml version="1.0" encoding="UTF-8"?>
<ChangeResourceRecordSetsResponse xmlns="https://route53.amazonaws.com/doc/2012-12-12/">
  <ChangeInfo>
    <Id>63d71bec8c03bb55f9e7bfe021297542</Id>
    <Status>INSYNC</Status>
    <SubmittedAt>2021-06-17T08:53:44.110Z</SubmittedAt>
  </ChangeInfo>
</ChangeResourceRecordSetsResponse>