getFabricClusterList

Prev Next

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

Fabric Cluster 목록을 조회합니다.

요청

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

메서드 URI
GET | POST /vserver/v2/getFabricClusterList
참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
regionCode String Optional 리전 코드
  • getRegionList 참조
    • 조회 결과의 첫 번째 리전 (기본값)
fabricClusterPoolNo String Optional Fabric Cluster Pool 번호로 필터링
fabricClusterPoolName String Optional Fabric Cluster Pool 이름으로 필터링
fabricClusterNoList.N Array Optional Fabric Cluster 번호 목록
  • Fabric Cluster 번호로 필터링
  • getFabricClusterList 참조
  • <예시> fabricClusterNoList.1=123&fabricClusterNoList.2=124
fabricClusterName String Optional Fabric Cluster 이름으로 필터링
zoneCode String Optional 존 코드로 필터링
vpcNo String Optional VPC 번호로 필터링
serverInstanceNo String Optional 서버 인스턴스 번호로 필터링
pageNo Integer Optional 페이지 번호
  • 0~N (기본값: 0)
  • 첫 번째 페이지: 0 또는 1 입력
pageSize Integer Conditional 페이지당 항목 수
  • 1~1000
  • pageNo 입력 시 필수 입력
sortedBy String Optional 정렬 기준
  • fabricClusterNo | fabricClusterPoolCode | zoneCode
    • fabricClusterNo: Fabric Cluster 번호
    • fabricClusterPoolCode: Fabric Cluster Pool 코드
    • zoneCode: 존 코드
sortingOrder String Optional 정렬 순서
  • ASC (기본값) | DESC
    • ASC: 오름차순
    • DESC: 내림차순
responseFormatType String Optional 응답 데이터의 형식
  • xml (기본값) | json

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getFabricClusterList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***84
&fabricClusterNoList.1=13**
&pageNo=1
&pageSize=10
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
getFabricClusterListResponse Object - 응답 결과
getFabricClusterListResponse.requestId String - 요청에 대한 아이디
  • UUID 형식
getFabricClusterListResponse.returnCode String - 응답 코드
getFabricClusterListResponse.returnMessage String - 응답 메시지

응답 상태 코드

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

응답 예시

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

{
  "getFabricClusterListResponse": {
    "totalRows": 1,
    "fabricClusterList": [
      {
        "fabricClusterNo": "13**",
        "fabricClusterName": "test-***",
        "fabricClusterStatus": {
          "code": "RUN",
          "codeName": "운영중"
        },
        "regionCode": "KR",
        "zoneCode": "KR-1",
        "vpcNo": "***84",
        "fabricClusterPoolNo": "***01",
        "fabricClusterPoolName": "test-***",
        "fabricClusterPoolCode": "test-***",
        "createDate": "2025-12-12T13:36:17+0900",
        "serverCount": 5
      }
    ],
    "requestId": "9b0ed68f-b044-4fd8-b138-22397fba64df",
    "returnCode": "0",
    "returnMessage": "success"
  }
}