get-datafence

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

Datafence를 조회합니다.

요청

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

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

요청 헤더

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

요청 예시

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/fence/get-datafence' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`fenceId`	Integer	-	Datafence 번호
`fenceName`	String	-	Datafence 이름
`boxCount`	Integer	-	Box 개수
`createDate`	String	-	Datafence 생성 일시 ISO 8601 형식(UTC+9 포함)
`statusCode`	String	-	Datafence 상태 코드 `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: 인프라 생성 중 `USE`: 이용 중 `ING`: 변경 중 `RETURN`: 반납 중 `TERMINATE`: 반납 완료
`statusName`	String	-	Datafence 상태 이름 `인프라 생성중` \| `이용중` \| `변경 중` \| `반납중` \| `반납완료`
`exportScreenBucketName`	String	-	반출 심사용 버킷 이름
`description`	String	-	Datafence에 대한 설명
`sslVpnName`	String	-	SSL VPN 이름

응답 상태 코드

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

응답 예시

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

[
    {
        "fenceId": 26,
        "fenceName": "datafense001",
        "boxCount": 1,
        "createDate": "2025-04-21T11:24:01+09:00",
        "statusCode": "USE",
        "statusName": "이용중",
        "description": "Description",
        "exportScreenBucketName": "datafense001",
        "sslVpnName": "datafence-ssl001"
    }
]