ドメインの詳細照会

Prev Next

Classic/VPC環境で利用できます。

指定したドメインの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /ncpdns/domain/{domainId}

リクエストヘッダ

レコード APIで共通して使用されるヘッダの詳細は、レコード APIの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
domainId Integer Required ドメイン ID

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://globaldns.apigw.ntruss.com/dns/v1/ncpdns/domain/25***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

レスポンスボディの詳細は、DomainDetailResponseをご参照ください。

レスポンスステータスコード

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

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "id": 25***,
    "name": "domain000.com",
    "completeYn": true,
    "dnssecYn": false,
    "status": "SUCCESS",
    "description": "",
    "createdDate": 1714628484,
    "modifiedDate": 1714628501,
    "recordCount": 2,
    "soa": {
        "domainName": "domain000.com",
        "nameServers": "ns1-1.ns-ncloud.com. ns1-2.ns-ncloud.com.",
        "serial": 1,
        "refresh": 21600,
        "retry": 1800,
        "expire": 1209600,
        "ttl": 300,
        "dnssecYn": false
    }
}

エラーコード例

エラーコードのサンプルコードは次の通りです。

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