stop

Prev Next

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

Data Forest 앱을 정지합니다.

요청

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

메서드 URI
POST /api/v2/apps/stop

요청 헤더

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
id String Required 앱 고유 식별자
  • 0~22자
  • UUID를 Base62로 변환한 형식
  • getList 참조

요청 예시

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

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/stop' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "id": "***ziexhg0FcWx5eGUA***"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
success Boolean - API 처리 결과
  • true | false
    • true: 성공
    • false: 실패
message String - 결과 메시지
  • successfalse인 경우, 표시
id String - 앱 고유 식별자
  • UUID를 Base62로 변환한 형식

응답 상태 코드

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

응답 예시

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

{
    "success": true,
    "id": "***ziexhg0FcWx5eGUA***"
}