レコードの照会

Prev Next

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

指定した条件に基づいてレコード情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド タイプ 必須の有無 説明
page Integer Required ページングされた結果のページ番号
  • 0から入力可能
size Integer Required ページごとに表示する結果数
recordType String Optional レコードタイプ
  • A | AAAA | CNAME | MX | PTR | SPF | TXT | NS | SRV | CAA | DS
searchContent String Optional 検索キーワード
  • レコード名で検索

リクエスト例

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

curl --location --request GET 'https://globaldns.apigw.ntruss.com/dns/v1/ncpdns/record/25***?paze=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}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "content": [
        {
            "name": "domain000.com",
            "host": "@",
            "type": "SOA",
            "content": "ns1-1.ns-ncloud.com. ns1-2.ns-ncloud.com. 1 21600 1800 1209600 300",
            "ttl": 300,
            "aliasId": null,
            "aliasYn": false,
            "lbId": null,
            "lbYn": false,
            "lbRegionCode": null,
            "delYn": false,
            "domainName": "domain000.com",
            "createdDate": 1714628484,
            "modifiedDate": 1714628484,
            "applyYn": true,
            "defaultYn": true,
            "id": 261***,
            "lbPlatform": null
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 1,
        "paged": true,
        "unpaged": false
    },
    "last": false,
    "totalElements": 4,
    "totalPages": 4,
    "first": true,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "size": 1,
    "number": 0,
    "numberOfElements": 1,
    "empty": false
}

エラーコード例

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

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