get-box-infra-list

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

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

요청

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

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

요청 헤더

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

요청 쿼리 파라미터

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

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

요청 예시

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-infra-list?fenceId=26&boxId=74&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	-	Box 인프라 목록

`content`

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

필드	타입	필수 여부	설명
`infraType`	String	-	인프라 유형 코드 Product Code 참조
`instanceNo`	Integer	-	인프라 인스턴스 번호
`instanceName`	String	-	인프라 인스턴스 이름
`blockStorageInstanceNo`	Integer	-	서버에 마운트된 블록 스토리지 인스턴스 번호
`blockStorageSize`	Integer	-	블록 스토리지 크기(GB)
`privateIp`	String	-	서버 비공인 IP
`specName`	String	-	서버 스펙 이름 또는 NAS 용량(GB) get-product-spec 참조
`userName1`	String	-	서버 첫 번째 접근 계정 또는 NAS 마운트 경로
`userName2`	String	-	서버 두 번째 접근 계정
`statusCode`	String	-	Box 상태 코드 `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: 인프라 생성 중 `USE`: 이용 중 `ING`: 변경 중 `RETURN`: 반납 중 `TERMINATE`: 반납 완료
`statusName`	String	-	Box 상태 이름 `인프라 생성중` \| `이용중` \| `변경 중` \| `반납중` \| `반납완료`
`instanceStatusCode`	String	-	인프라 상태 코드 `RUN` \| `REBOOT` \| `SETTING` `RUN`: 이용 중 `REBOOT`: 재시작 `SETTING`: 설정 중
`instanceStatus`	String	-	인프라 상태 이름 `이용중` \| `재시작` \| `설정중`

응답 상태 코드

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

응답 예시

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

{
    "totalCount": 5,
    "content": [
        {
            "infraType": "CON",
            "instanceNo": *********,
            "instanceName": "conn-26-74-1",
            "blockStorageInstanceNo": 1047*****,
            "blockStorageSize": 500,
            "privateIp": "10.0.1.70",
            "specName": "Connect Windows Server (S2 W1 : 2vCPU 8GB Mem)",
            "userName1": "ncp1",
            "userName2": "ncp2",
            "statusCode": "USE",
            "statusName": "이용중",
            "instanceStatus": "이용중",
            "instanceStatusCode": "RUN"
        },
        {
            "infraType": "SVR_LNX_UBUNTU",
            "instanceNo": *********,
            "instanceName": "svrlnx-26-74-1",
            "blockStorageInstanceNo": 1047*****,
            "blockStorageSize": 500,
            "privateIp": "10.0.1.72",
            "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
            "userName1": "root",
            "statusCode": "USE",
            "statusName": "이용중",
            "instanceStatus": "이용중",
            "instanceStatusCode": "RUN"
        },
        {
            "infraType": "TF_CPU",
            "instanceNo": *********,
            "instanceName": "tfcpu-26-74-1",
            "blockStorageInstanceNo": 1047*****,
            "blockStorageSize": 500,
            "privateIp": "10.0.1.71",
            "specName": "Tensorflow CPU Linux Server (S2-L1 : 2vCPU 8GB Mem)",
            "userName1": "root",
            "statusCode": "USE",
            "statusName": "이용중",
            "instanceStatus": "이용중",
            "instanceStatusCode": "RUN"
        },
        {
            "infraType": "BOX_NAS",
            "instanceNo": *********,
            "instanceName": "74box1",
            "specName": "500",
            "userName1": "/mnt/74box1",
            "statusCode": "USE",
            "statusName": "이용중",
            "instanceStatus": "이용중",
            "instanceStatusCode": "USE"
        },
        {
            "infraType": "HD",
            "instanceNo": *********,
            "instanceName": "hd-26-74-1",
            "privateIp": "10.0.1.75",
            "specName": "2.2",
            "userName1": "sshuser",
            "statusCode": "USE",
            "statusName": "이용중",
            "instanceStatus": "이용중",
            "instanceStatusCode": "USE"
        }
    ]
}