MENU
      create

        create


        Article summary

        The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

        Available in VPC

        Create a Data Forest app.

        Requests

        Request parameters

        Parameter nameRequiredTypeRestrictionsDescription
        accountIdYESStringEnter up to 22 characters- Account identifier UUID (base62)
        - accountId can be obtained through the getList API fo Accounts
        queueNameYESString- Enter up to 60 characters
        - Only longlived can be used
        - YARN queue name
        - Default: longlived
        appTypeIdYESStringEnter up to 60 characters- Data Forest app type and app version
        - Example: DEV-1.0.0
        - appTypeId can be obtained through the GetAppTypeIdList API
        nameYESStringEnter 3 to 15 charactersApp name
        lifetimeYESInteger300 (seconds) - 604800 (seconds), -1 (infinite)App's lifetime (unit: second)
        descriptionNOStringEnter up to 2048 charactersApp description
        dependentIdsNOList<String>List of dependency app IDs required to create the app
        componentsYESAppComponentRequest- AppComponentRequest data type
        - Components that make up the Data Forest app
        - Component information can be obtained by running the getAppBasicSetting API.

        Request headers

        See the common guide

        Request body

        • JSON
          {
              "components": [
                  {
                  "containerCount": 0,
                  "cpuCount": 0,
                  "memoryMb": 0,
                  "name": "string"
                  }
              ],
              "accountId": "string",
              "appTypeId": "string",
              "dependentIds": [
                  "string"
              ],
              "description": "string",
              "lifetime": 0,
              "name": "string",
              "queueName": "longlived"
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <CreateAppRequest>
              <components>
                  <containerCount>0</containerCount>
                  <cpuCount>0</cpuCount>
                  <memoryMb>0</memoryMb>
                  <name>string</name>
              </components>
              <accountId>string</accountId>
              <appTypeId>string</appTypeId>
              <dependentIds>string</dependentIds>
              <description>string</description>
              <lifetime>0</lifetime>
              <name>string</name>
              <queueName>longlived</queueName>
          </CreateAppRequest>
          XML

        Responses

        Response body

        CreateAppRequest

        • JSON
          {
          "id": "string",
          "message": "string",
          "success": true
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <CreateAppResponse>
              <id>string</id>
              <message>string</message>
              <success>true</success>
          </CreateAppResponse>
          XML

        Errors

        See Data Forest overview

        Examples

        Request example

        • HTTP

          POST https://df.apigw.ntruss.com/api/v2/apps/create
          HOST: df.apigw.ntruss.com
          Content-Type: application/json
          x-ncp-apigw-timestamp: 1505290625682
          x-ncp-iam-access-key: D78BB444D6D3C84CA38A
          x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
          {
          "accountId": "0EUndFjwPUpehRdMm4X4Vj",
          "queueName": "longlived",
          "appTypeId": "DEV-1.0.0",
          "name": "dev24x7",
          "lifetime": 604800,
          "description": "string",
          "dependentIds": [
              "8xaHHIwgJG1cSNkIeDrr8D"
          ],
          "components": [
              {
              "name": "shell",
              "memoryMb": 2048,
              "cpuCount": 1,
              "containerCount": 1
              }
          ]
          }
          HTTP
        • BASH

          curl -X POST "https://df.apigw.ntruss.com/api/v2/apps/create" \
          -H "accept: application/json" \
          -H "Content-Type: application/json" \
          -H "x-ncp-apigw-timestamp:1505290625682" \
          -H "x-ncp-iam-access-key:D78BB444D6D3C84CA38A" \
          -H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo="
          -d '{
          "accountId": "0EUndFjwPUpehRdMm4X4Vj",
          "queueName": "longlived",
          "appTypeId": "DEV-1.0.0",
          "name": "dev24x7",
          "lifetime": 604800,
          "description": "string",
          "dependentIds": [
              "8xaHHIwgJG1cSNkIeDrr8D"
          ],
          "components": [
              {
              "name": "shell",
              "memoryMb": 2048,
              "cpuCount": 1,
              "containerCount": 1
              }
          ]
          }'
          Bash

        Response example

        • HTTP

          HTTP StatusDescription
          200OK
        • BASH

          {
          "success": true,
          "message": "success",
          "id": "VmYi7mOFyhNe107T2p9vDi"
          }
          JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.