create

Prev Next

Available in VPC

Create a Data Forest app.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v2/apps/create

Request headers

For information about the headers common to all Data Forest APIs, see Data Forest request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
accountId String Required Account's unique identifier
  • 0-22 characters
  • UUID converted to Base62 format
  • See getList of Accounts.
queueName String Required YARN queue name
  • longlived (default)
  • 0-60 characters
appTypeId String Required App type and version
name String Required App name
  • Enter 3 to 15 characters using a combination of lowercase English letters, numbers, and the special character "-".
  • Start and end of the string must be composed of lowercase English letters or numbers.
  • Special character "-" can't be used consecutively.
lifetime Integer Required App's uptime (second)
  • 300-604800, -1 (permanent)
description String Optional App description
  • 0-2048 characters
dependentIds Array Optional List of required dependent app IDs when creating an app
components Array Required App configuration component

Request example

The request example is as follows:

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
        }
    ]
}'

Response

This section describes the response format.

Response body

See CreateAppRequest for the response body.

Response status codes

For information about the HTTP status codes common to all Data Forest APIs, see Data Forest response status codes.

Response example

The response example is as follows:

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