--- title: "getDomain" slug: "gov-global-dns-v2-domains-getdomain" updated: 2026-10-22T10:47:49Z published: 2026-10-22T10:47:49Z canonical: "api-gov.ncloud-docs.com/gov-global-dns-v2-domains-getdomain" --- > ## Documentation Index > Fetch the complete documentation index at: https://api-gov.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # getDomain 이 가이드는 API 명세를 기반으로 자동 생성했습니다. Classic/VPC 환경에서 이용 가능합니다. Ncloud API 표준 규격을 적용한 API입니다. 도메인 1건의 상세 정보를 조회합니다. 목록 조회 결과에 더해 SOA 레코드와 레코드 수를 함께 반환합니다. 응답의 `ETag` 헤더를 전체 교체(PUT) 요청의 `If-Match` 로 사용하면 동시 수정으로 인한 lost update 를 막을 수 있습니다. ## 요청 요청 형식을 설명합니다. 요청 형식은 다음과 같습니다. | 메서드 | URI | | --- | --- | | GET | /domains/{domainNo} | ### 요청 헤더 Global DNS API에서 공통으로 사용하는 헤더에 대한 정보는 [Global DNS 요청 헤더](/docs/gov-global-dns-v2-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오. ### 요청 경로 파라미터 요청 경로 파라미터에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `domainNo` | Integer (int64) | Required | 도메인 번호 - 보유하지 않았거나 존재하지 않는 번호는 403 Forbidden (두 경우를 구분하지 않음) - <예시> 120 | ### 요청 예시 요청 예시는 다음과 같습니다. ``` curl --location --request GET 'https://globaldns.apigw.gov-ntruss.com/dns/v2/domains/120' \ --header 'x-ncp-apigw-timestamp: {Timestamp}' \ --header 'x-ncp-iam-access-key: {Access Key}' \ --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' ``` ## 응답 응답 형식을 설명합니다. ### 응답 헤더 응답 헤더에 대한 설명은 다음과 같습니다. | 필드 | 필수 여부 | 설명 | | --- | --- | --- | | `ETag` | Optional | 자원의 현재 버전 식별자 - 전체 교체(PUT) 시 `If-Match` 로 보내면 그 사이 자원 변경 여부를 검사 - PUT 으로 교체되는 필드만으로 계산하므로, 비동기로 바뀌는 `status` 와 레코드 적용으로 바뀌는 `recordCount`·`soa` 는 ETag 에 영향 없음 (200 응답) | ### 응답 바디 응답 바디에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `domainNo` | Integer (int64) | - | 도메인 번호 - <예시> 1 | | `name` | String | - | 도메인 이름 - <예시> example.com | | `applied` | Boolean | - | 도메인 처리 완료 여부 (`status` 에서 파생) - `true` \| `false` - `true`: 처리 완료 (`status` 가 SUCCEEDED) - `false`: 처리 중 (`status` 가 PROCESSING) - <예시> true | | `dnssecEnabled` | Boolean | - | DNSSEC 적용 여부 - `true` \| `false` - <예시> true | | `status` | String | - | 도메인 처리 상태 - 실패 상태 값은 없으며, 완료 판정에는 작업 자원의 `done` 사용 - `PROCESSING` \| `SUCCEEDED` - `PROCESSING`: 생성·수정·삭제 처리 중. 네임서버 동기화가 확인될 때까지 유지 - `SUCCEEDED`: 처리 완료. 작업(Operation)의 `done` 이 true 가 되는 시점과 같음 - <예시> SUCCEEDED | | `description` | String \| null | - | 도메인 설명 - <예시> my domain | | `createdTimestamp` | Integer (int64) | - | 생성 시각 (Unix epoch 밀리초) - <예시> 1568111263000 | | `updatedTimestamp` | Integer (int64) | - | 수정 시각 (Unix epoch 밀리초) - <예시> 1568111263000 | | `recordCount` | Integer (int64) | - | 이 도메인(domainNo)에 속한 레코드 수 - <예시> 5 | | `soa` | Object<[SoaRecord](/docs/gov-global-dns-v2-domains-getdomain#SoaRecord)> | - | SOA 레코드 - 항상 객체이며 하위 필드만 null 가능 - 하위 필드가 모두 null 인 경우: 도메인 설정 적용 전이거나 삭제 처리 중 - 삭제가 완료된 도메인은 조회 시 403 Forbidden | #### SoaRecord SOA 레코드. 사용자가 직접 설정하지 않으며, 도메인 설정 적용 시 시스템이 값을 채웁니다. 적용 전에는 `domainName`·`nameServers`·`serial`·`refresh`·`retry`·`expire`·`ttl` 이 null 이고, `dnssecEnabled` 는 항상 값이 있습니다(적용 전에는 false). | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `domainName` | String \| null | - | 도메인 이름 - <예시> example.com | | `nameServers` | List \| null | - | 네임서버 목록 - <예시> `["ns1-1.ns-ncloud.com.", "ns1-2.ns-ncloud.com."]` | | `serial` | Integer (int64) \| null | - | SOA serial 번호 - <예시> 2019091001 | | `refresh` | Integer (int64) \| null | - | SOA refresh (초) - <예시> 3600 | | `retry` | Integer (int64) \| null | - | SOA retry (초) - <예시> 600 | | `expire` | Integer (int64) \| null | - | SOA expire (초) - <예시> 604800 | | `ttl` | Integer (int64) \| null | - | SOA 최소 TTL (초) - <예시> 300 | | `dnssecEnabled` | Boolean | - | DNSSEC 적용 여부 - `true` \| `false` - <예시> true | ### 응답 상태 코드 Global DNS API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Global DNS 응답 상태 코드](/docs/gov-global-dns-v2-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오. 이 API에만 해당하는 응답 상태 코드는 다음과 같습니다. | HTTP 상태 코드 | 코드 | 메시지 | 설명 | | --- | --- | --- | --- | | 200 | - | - | OK | ### 응답 예시 응답 예시는 다음과 같습니다. ``` { "domainNo": 1, "name": "example.com", "applied": true, "dnssecEnabled": true, "status": "SUCCEEDED", "description": "my domain", "createdTimestamp": 1568111263000, "updatedTimestamp": 1568111263000, "recordCount": 5, "soa": { "domainName": "example.com", "nameServers": [ "ns1-1.ns-ncloud.com.", "ns1-2.ns-ncloud.com." ], "serial": 2019091001, "refresh": 3600, "retry": 600, "expire": 604800, "ttl": 300, "dnssecEnabled": true } } ```