getRecord

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

Classic/VPC 환경에서 이용 가능합니다.

Ncloud API 표준 규격을 적용한 API입니다.

레코드 한 건의 상세를 조회합니다. 도메인에 속하지 않는 레코드 번호는 404 ResourceNotFound 로 응답합니다. 응답의 ETag 헤더를 전체 교체(PUT) 요청의 If-Match 로 사용하면 동시 수정으로 인한 lost update 를 막을 수 있습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/domains/{domainNo}/records/{recordNo}

요청 헤더

Global DNS API에서 공통으로 사용하는 헤더에 대한 정보는 Global DNS 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`domainNo`	Integer (int64)	Required	도메인 번호 보유하지 않았거나 존재하지 않는 번호는 403 Forbidden (두 경우를 구분하지 않음) <예시> 120
`recordNo`	Integer (int64)	Required	레코드 번호 도메인에 속하지 않는 번호는 404 ResourceNotFound <예시> 5001

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://globaldns.apigw.gov-ntruss.com/dns/v2/domains/120/records/5001' \
--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)	-	레코드가 속한 도메인의 번호 <예시> 120
`domainName`	String	-	도메인 이름 <예시> example.com
`recordNo`	Integer (int64)	-	레코드 번호 <예시> 5001
`host`	String	-	레코드 호스트 (도메인 기준 상대 이름) 도메인 자체(apex)는 `@` 로 표기 <예시> www
`name`	String	-	레코드 이름 (FQDN) <예시> www.example.com
`type`	String	-	레코드 타입 `A` \| `AAAA` \| `CAA` \| `CNAME` \| `DS` \| `MX` \| `NS` \| `PTR` \| `SOA` \| `SPF` \| `SRV` \| `TXT` \| `DNSKEY` \| `NSEC3` \| `RRSIG` <예시> A
`content`	String	-	레코드 값(content) 값이 여러 개인 레코드는 줄바꿈(`\n`)으로 구분 <예시> 10.0.0.1
`ttl`	Integer (int64)	-	TTL (초) <예시> 300
`aliasNo`	Integer (int64) \| null	-	별칭 번호 (별칭 레코드가 아니면 null) <예시> 700
`pendingDeletion`	Boolean	-	레코드 삭제 대기 여부 `true` \| `false` <예시> false
`createdTimestamp`	Integer (int64)	-	생성 시각 (Unix epoch 밀리초) <예시> 1568111263000
`updatedTimestamp`	Integer (int64)	-	수정 시각 (Unix epoch 밀리초) <예시> 1568111263000
`applied`	Boolean	-	네임서버 적용 여부 `true` \| `false` `true`: 변경 내용이 네임서버에 적용됨 `false`: 생성·수정·삭제 후 아직 적용 전 <예시> true
`defaultRecord`	Boolean	-	기본 레코드 여부 기본 레코드는 삭제 불가 (400 CannotDelete) 기본 레코드 중 SOA·DS 는 수정 불가, NS 는 `ttl` 만 수정 가능 (그 밖의 수정은 400 InvalidOperation) `true` \| `false` `true`: 도메인 이름과 같은 이름(apex)의 SOA·NS·DS 레코드. 시스템이 관리하며 도메인 삭제 시 함께 정리 `false`: 사용자가 생성한 레코드 <예시> false
`loadBalancerNo`	Integer (int64) \| null	-	로드밸런서 번호 (로드밸런서 레코드가 아니면 null) <예시> 900
`loadBalancerRegionCode`	LoadBalancerRegionCode \| Null	-	로드밸런서 리전 코드 (로드밸런서 레코드가 아니면 null) <예시> KR

응답 상태 코드

Global DNS API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Global DNS 응답 상태 코드를 참조해 주십시오.

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	OK
404	ResourceNotFound	The specified resource could not be found.	요청한 레코드 번호나 작업 ID가 존재하지 않는 경우(완료 후 30일 보관 기간이 지나 삭제된 작업 포함). 일괄 수정·삭제에서는 실패 원인이 미존재뿐일 때 반환하며 해당 항목의 요청 인덱스가 `failures` 에 지목됨. 목록을 조회해 번호·ID를 확인한 뒤 다시 요청

응답 예시

응답 예시는 다음과 같습니다.

{
  "domainNo": 120,
  "domainName": "example.com",
  "recordNo": 5001,
  "host": "www",
  "name": "www.example.com",
  "type": "A",
  "content": "10.0.0.1",
  "ttl": 300,
  "aliasNo": 700,
  "pendingDeletion": false,
  "createdTimestamp": 1568111263000,
  "updatedTimestamp": 1568111263000,
  "applied": true,
  "defaultRecord": false,
  "loadBalancerNo": 900,
  "loadBalancerRegionCode": "KR"
}