MENU
      View record

        View record


        Article summary

        Available in Classic and VPC

        View record information according to the specified conditions.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        GET/ncpdns/record/{domainId}

        Request headers

        For headers common to all Record APIs, see Record API common headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        domainIdIntegerRequiredDomain ID

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        pageIntegerRequiredPage number of the paged results
        • You can enter from 0
        sizeIntegerRequiredNumber of results to display on a page
        recordTypeStringOptionalRecord type
        • A | AAAA | CNAME | MX | PTR | SPF | TXT | NS | SRV | CAA | DS
        searchContentStringOptionalSearch keyword
        • Search by record name

        Request example

        The following is a sample request.

        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}'
        Curl

        Response

        The following describes the response format.

        Response body

        See RecordResponse for the response body.

        Response status codes

        For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

        Response example

        The following is a sample response.

        {
            "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
        }
        JSON

        Error code example

        The following is a sample error code.

        {
            "result": "FAIL",
            "error": {
                "errorCode": "X00006",
                "message": "You are not authorized.",
                "devMessage": "You are not authorized."
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.