VPC 환경에서 이용 가능합니다.
Box의 사용자 서버 이미지를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /api/v1/box/get-box-custom-image |
요청 헤더
Datafence API에서 공통으로 사용하는 헤더에 대한 정보는 Datafence 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
fenceId |
Integer | Required | Datafence 번호 |
productCode |
String | Required | Box 스펙 코드
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-custom-image?fenceId=26&productCode=CON' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
content |
Array | - | 사용자 서버 이미지 정보 |
content
content
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
imageNo |
Integer | - | 이미지 번호 |
imageName |
String | - | 이미지 이름 |
productCode |
String | - | Box 스펙 코드
|
baseServerName |
String | - | 이미지의 기본 서버 이름 |
응답 상태 코드
Datafence API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Datafence API 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"content": [
{
"imageNo": 1,
"imageName": "box-custom-image-1",
"productCode": "CON",
"baseServerName": "conn-1-1"
}
]
}