ドメインの照会

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

指定した条件に基づいてドメイン情報を照会します。

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "content": [
        {
            "id": 25***,
            "name": "domain000.com",
            "completeYn": true,
            "dnssecYn": false,
            "status": "SUCCESS"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 1,
        "paged": true,
        "unpaged": false
    },
    "last": false,
    "totalElements": 2,
    "totalPages": 2,
    "first": true,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "size": 1,
    "number": 0,
    "numberOfElements": 1,
    "empty": false
}

エラーコード例

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

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