get-datafence-infra-list

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

Datafence 인프라 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v1/fence/get-datafence-infra-list

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`fenceId`	Integer	Required	Datafence 번호 get-datafence 참조
`page`	Integer	Optional	페이지 번호 0~100 (기본값: 0)
`size`	Integer	Optional	페이지당 항목 수 1~100 (기본값: 10)

요청 예시

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/fence/get-datafence-infra-list?fenceId=26&page=1&size=10' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`totalCount`	Integer	-	응답 결과 수
`content`	Array	-	Datafence 목록

`content`

content에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`infraType`	String	-	인프라 유형 `FENCE_UBUNTU`: 관리용 Ubuntu 서버 `FENCE_NAS`: Datafence NAS
`instanceName`	String	-	인프라 인스턴스 이름
`privateIp`	String	-	인프라 비공인 IP `infraType`이 `FENCE_UBUNTU`인 경우, 표시
`publicIp`	String	-	인프라 공인 IP `infraType`이 `FENCE_UBUNTU`인 경우, 표시
`osName`	String	-	서버 운영 체제 이름 `infraType`이 `FENCE_UBUNTU`인 경우, 표시
`specName`	String	-	서버 또는 NAS 스펙 이름 `infraType`이 `NAS`인 경우, 용량 표시
`userName`	String	-	서버 접속 계정 이름 `infraType`이 `NAS`인 경우, 마운트 경로 표시
`createDate`	String	-	Datafence 생성 일시 ISO 8601 형식(UTC+9 포함)
`statusCode`	String	-	Datafence 상태 코드 `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: 인프라 생성 중 `USE`: 이용 중 `ING`: 변경 중 `RETURN`: 반납 중 `TERMINATE`: 반납 완료
`statusName`	String	-	Datafence 상태 이름 `인프라 생성중` \| `이용중` \| `변경 중` \| `반납중` \| `반납완료`
`instanceNo`	Integer	-	인프라 인스턴스 번호
`instanceStatus`	String	-	인프라 상태 이름 `이용중` \| `재시작` \| `설정중`
`instanceStatusCode`	String	-	인프라 상태 코드 `RUN` \| `REBOOT` \| `SETTING` `RUN`: 이용 중 `REBOOT`: 재시작 `SETTTING`: 설정

응답 상태 코드

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

응답 예시

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

{
  "totalCount": 2,
  "content": [
    {
      "infraType": "Server",
      "instanceName": "fence-XX-Y",
      "privateIp": "xxx.xxx.xxx.xxx",
      "publicIp": "xxx.xxx.xxx.xxx",
      "osName": "Ubuntu",
      "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
      "userName": "root",
      "createDate": "2025-03-25T15:39:04+09:00",
      "statusCode": "USE",
      "statusName": "이용중",
      "instanceNo": "-",
      "instanceStatus": "이용중",
      "instanceStatusCode": "RUN"
    },
    {
      "infraType": "NAS",
      "instanceName": "XXfenceY",
      "specName": "500",
      "userName": "/mnt/nasr/XXfenceY",
      "createDate": "2025-01-09T13:51:10+09:00",
      "statusCode": "USE",
      "statusName": "이용중",
      "instanceNo": "-",
      "instanceStatus": "이용중",
      "instanceStatusCode": "USE"
    }
  ]
}