レコードの概要

概要

Global DNSが提供するドメイン/レコードの作成/変更/削除機能を、規定の APIを通じて呼び出すことができる機能です。
ダッシュボードで発行した、許可された API Keyを使用すると呼び出せます。

Global DNS APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

共通リクエスト形式を説明します。

リクエスト API URLは次の通りです。

https://globaldns.apigw.ntruss.com

ヘッダの説明は次の通りです。

フィールド	必須の有無	説明
`x-ncp-apigw-timestamp`	Required	1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒) API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす Unix timestamp形式
`x-ncp-iam-access-key`	Required	NAVERクラウドプラットフォームから発行された Access Key Access Keyの発行と確認: 認証キーの作成を参照サブアカウントの Access Key発行と確認: サブアカウントの作成を参照
`x-ncp-apigw-signature-v2`	Required	NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名 Secret Keyの発行と確認: 認証キーの作成を参照署名の作成: シグネチャーの作成を参照

共通レスポンス形式を説明します。

レスポンスボディの説明は次の通りです。

error
errorは API呼び出し失敗情報を定義します。errorの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`result`	String	-	API呼び出し結果 `FAIL`: 呼び出しが失敗した場合、表示
`error`	Object	-	エラーコードとメッセージ `success`が`false`の場合に表示
`error.errorCode`	Integer	-	エラーコード
`error.message`	String	-	エラーメッセージ

Global DNS APIは NAVERクラウドプラットフォームの共通レスポンスステータスコードを使用します。NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "result": "FAIL",
    "error": {
        "errorCode": "X00006",
        "message": "権限がありません。",
        "devMessage": "権限がありません。"
    }
}