create

Prev Next

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

Data Forest 앱을 생성합니다.

요청

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

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

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
accountId String Required 계정 고유 식별자
  • 0~22자
  • UUID를 Base62로 변환한 형식
  • Accounts의 getList 참조
queueName String Required YARN 큐 이름
  • longlived (기본값)
  • 0~60자
appTypeId String Required 앱 타입 및 버전
name String Required 앱 이름
  • 영문 소문자, 숫자, 특수문자 '-'를 조합하여 3~15자로 입력
  • 문자열의 시작과 마지막은 영문 소문자 또는 숫자로 구성
  • 특수문자 '-' 연속 사용 불가
lifetime Integer Required 앱 구동 시간(초)
  • 300 ~ 604800, -1(영구)
description String Optional 앱 설명
  • 0~2048자
dependentIds Array Optional 앱 생성 시 필요한 의존 앱 아이디 목록
components Array Required 앱 구성 컴포넌트

요청 예시

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

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/create' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "accountId": "***FQJ88q0be79VRB2e***",
    "queueName": "longlived",
    "appTypeId": "KAFKA-2.4.0",
    "name": "kafka001",
    "lifetime": 604800,
    "description": "string",
    "dependentIds": [
        "***OMQ0QwFXb5XINOzf***"
    ],
    "components": [
        {
            "name": "broker",
            "memoryMb": 2048,
            "cpuCount": 4,
            "containerCount": 1
        },
        {
            "name": "kafka-manager",
            "memoryMb": 2048,
            "cpuCount": 1,
            "containerCount": 1
        }
    ]
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 CreateAppRequest를 참조해 주십시오.

응답 상태 코드

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

응답 예시

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

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