View record

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:

Method	URI
GET	/dns/v1/ncpdns/record/{domainId}

Request headers

For information about the headers common to all Record APIs, see Record API request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`domainId`	Integer	Required	Domain ID See View domain

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`page`	Integer	Required	Page number of the paged results You can enter from 0
`size`	Integer	Required	Number of results to display on a page
`recordType`	String	Optional	Record type `A` \| `AAAA` \| `CNAME` \| `MX` \| `PTR` \| `SPF` \| `TXT` \| `NS` \| `SRV` \| `CAA` \| `DS`
`searchContent`	String	Optional	Search 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}'

Response

The following describes the response format.

Response body

See RecordResponse for the response body.

Response status codes

For information about the HTTP status codes common to all Record APIs, see Record 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
}

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."
    }
}