listRecordLinkableLoadBalancers

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

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

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

레코드를 생성·수정할 때 연결할 수 있는 로드밸런서 목록을 조회합니다. 로그인 회원이 보유한 로드밸런서 중 platformType 과 recordType 조건에 맞는 항목만 반환하며, loadBalancerRegionCode 를 생략하면 KR 리전을 조회합니다. 생성 중이라 아직 사용할 수 없는 로드밸런서는 제외되고, 조건에 맞는 항목이 없으면 빈 배열을 반환합니다.

요청

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

메서드	URI
GET	/record-linkable-load-balancers

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`platformType`	String	Required	플랫폼 타입 `CLASSIC` \| `VPC` \| `BOTH` <예시> VPC
`recordType`	String	Required	연결할 레코드의 타입 `A` <예시> A
`loadBalancerRegionCode`	String	Optional	로드밸런서 리전 코드 `KR` <예시> KR
`searchContent`	String	Optional	검색어 부분 일치, 대소문자 무시 길이: ~ 255 <예시> my-lb

요청 예시

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

curl --location --request GET 'https://globaldns.apigw.gov-ntruss.com/dns/v2/record-linkable-load-balancers?platformType=VPC&recordType=A' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`recordLinkableLoadBalancers`	List<LoadBalancerSummary>	-	로드밸런서 목록 (결과가 없으면 빈 배열)

LoadBalancerSummary

레코드로 연결할 수 있는 로드밸런서 요약

필드	타입	필수 여부	설명
`loadBalancerNo`	Integer (int64)	-	로드밸런서 번호 <예시> 900
`name`	String	-	로드밸런서 이름 <예시> my-lb
`platformType`	String	-	플랫폼 타입 한 번의 조회는 한 플랫폼만 대상으로 하므로 목록의 모든 항목이 같은 값 `CLASSIC` \| `VPC` <예시> VPC
`loadBalancerRegionCode`	String	-	로드밸런서 리전 코드 레코드 생성·수정 시 `loadBalancerRegionCode` 값으로 그대로 사용 `KR` <예시> KR

응답 상태 코드

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

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

HTTP 상태 코드	코드	메시지	설명
200	-	-	OK

응답 예시

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

{
  "recordLinkableLoadBalancers": [
    {
      "loadBalancerNo": 900,
      "name": "my-lb",
      "platformType": "VPC",
      "loadBalancerRegionCode": "KR"
    }
  ]
}