VPC 환경에서 이용 가능합니다.
Box를 반납합니다. 인프라 반납 작업에 일정 시간이 소요되므로 비동기 방식으로 처리됩니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
POST | /api/v1/box/return-box |
요청 헤더
Datafence API에서 공통으로 사용하는 헤더에 대한 정보는 Datafence 요청 헤더를 참조해 주십시오.
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
fenceId |
Integer | Required | Datafence 번호 |
boxId |
Integer | Required | Box 번호
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://datafence.apigw.ntruss.com/api/v1/box/return-box' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"fenceId": 26,
"boxId": 74
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
message |
String | - | API 처리 결과 메시지 |
응답 상태 코드
Datafence API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Datafence API 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"message": "Box return requested."
}