MENU
      getAppBasicSetting

        getAppBasicSetting


        Article summary

        Available in VPC

        Views the default creation settings of the app type specified by Data Forest.

        Requests

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        accountIdYESStringEnter up to 22 characters.- Account identifier UUID (base62)
        Id can be obtained through getList API in Accounts
        appTypeIdYESStringEnter up to 60 characters.- Data Forest app type and version
        - appTypeId can be obtained through getAppTypeIdList API of Apps.
        - Example: DEV-1.0.0

        Request headers

        See common guide.

        Request Bodies

        • JSON
          {
              "accountId": "string",
              "appTypeId": "string"
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <GetAppBasicSettingRequest>
              <accountId>string</accountId>
              <appTypeId>string</appTypeId>
          </GetAppBasicSettingRequest>
          XML

        Responses

        Response bodies

        GetAppBasicSettingResponse

        • JSON
          {
              "appMasterCpuCount": 0,
              "appMasterMemoryMb": 0,
              "dependableApp": {
                  "appTypeName": "string",
                  "appTypeVersion": "string",
                  "candidates": [
                  {
                      "accountId": "string",
                      "accountName": "string",
                      "disabled": true,
                      "finishedAt": "2023-05-08T01:40:31.591Z",
                      "id": "string",
                      "lifetimeMillis": 0,
                      "name": "string",
                      "queueName": "longlived",
                      "startedAt": "2023-05-08T01:40:31.591Z",
                      "state": "string"
                  }
                  ]
              },
              "message": "string",
              "privateQueueNames": [
                  "string"
              ],
              "publicQueueNames": [
                  "string"
              ],
              "components": [
              {
                   "name": "string",
                   "countMin": 0,
                   "countMax": 0,
                   "cpuCountMin": 0,
                   "cpuCountMax": 0,
                   "memoryMbMin": 0,
                   "memoryMbMax": 0
               }
               ],
              "success": true,
              "template": "string"
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <GetAppBasicSettingResponse>
              <appMasterCpuCount>0</appMasterCpuCount>
              <appMasterMemoryMb>0</appMasterMemoryMb>
              <dependableApp>
                  <appTypeName>string</appTypeName>
                  <appTypeVersion>string</appTypeVersion>
                  <candidates>
                      <accountId>string</accountId>
                      <accountName>string</accountName>
                      <disabled>true</disabled>
                      <finishedAt>2023-05-08T01:43:39.749Z</finishedAt>
                      <id>string</id>
                      <lifetimeMillis>0</lifetimeMillis>
                      <name>string</name>
                      <queueName>longlived</queueName>
                      <startedAt>2023-05-08T01:43:39.749Z</startedAt>
                      <state>string</state>
                  </candidates>
              </dependableApp>
              <message>string</message>
              <privateQueueNames>string</privateQueueNames>
              <publicQueueNames>string</publicQueueNames>
              <components>
                   <name>string</name>
                   <countMin>0</countMin>
                   <countMax>0</countMax>
                   <cpuCountMin>0</cpuCountMin>
                   <cpuCountMax>0</cpuCountMax>
                   <memoryMbMin>0</memoryMbMin>
                   <memoryMbMax>0</memoryMbMax>
              </components>
              <success>true</success>
              <template>string</template>
          </GetAppBasicSettingResponse>
          XML

        Errors

        See DataForest overview

        Examples

        Request Examples

        • HTTP

          POST https://df.apigw.ntruss.com/api/v2/apps/getAppBasicSetting
          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": "wWwEh34wOZOgdafhe36lEO",
          "appTypeId": "DEV-1.0.0"
          }
          HTTP
        • BASH

          curl -X POST "https://df.apigw.ntruss.com/api/v2/apps/getAppBasicSetting" \
          -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\": \"wWwEh34wOZOgdafhe36lEO\", \"appTypeId\": \"DEV-1.0.0\"}" \
          Bash

        Response examples

        • HTTP

          HTTP StatusDescription
          200OK
        • BASH

          {
          "success": true,
          "template": "{\"name\":\"<app-name>\",\"lifetime\":604800,\",\"queue\":\"dev\",\"description\":\"DEV-1.0.0\",\"artifact\":{\"id\":\"{{DEFAULT_DOCKER_REGISTRY}}/dataforest/df-env:20211229\",\"type\":\"DOCKER\"},\"quicklinks\":{\"shell\":\"https://${USER}--${SERVICE_NAME}--shell--8080.{{YARN_SERVICE_PROXY_DOMAIN}}\",\"supervisor \":\"https://${USER}--${SERVICE_NAME}--shell--9001.{{YARN_SERVICE_PROXY_DOMAIN}}\"},\"configuration\":{\"env\":{\"KRB5_KTNAME\":\"/etc/security/keytabs/{{USER}}.service.keytab\",\"YARN_CONTAINER_RUNTIME_DOCKER_LIMIT_MEMORY\":\"true\",\"TERM\":\"xterm-256color\",\"JAVA_HOME\":\"/usr/jdk64/jdk1.8.0_112\",\"HADOOP_CONF_DIR\":\"/etc/hadoop/conf\",\"HIVE_CONF_DIR\":\"/etc/hive/conf\",\"SPARK_CONF_DIR\":\"/etc/spark2/conf\",\"HADOOP_COMMON_HOME\":\"/usr/hdp/current/hadoop-client\",\"HADOOP_HDFS_HOME\":\"/usr/hdp/current/hadoop-hdfs-client\",\"HADOOP_MAPRED_HOME\":\"/usr/hdp/current/hadoop-mapreduce-client\",\"HADOOP_YARN_HOME\":\"/usr/hdp/current/hadoop-yarn-client\",\"SPARK_HOME\":\"/usr/hdp/current/spark2-client\",\"HIVE_HOME\":\"/usr/hdp/current/hive-client\",\"LDAP_URI\":\"{{LDAP_URI}}\",\"LDAP_SEARCH_BASE\":\"{{LDAP_USER_SEARCH_BASE}}\",\"LDAP_USER_FILTER\":\"(&(uid=%s)(objectClass=posixAccount)(|(uid={{USER}})(ou=memberOf=hadoop-admins)(ou=memberOf={{USER}})))\",\"SSO_AUTH_PROVIDER_URL\":\"{{SSO_AUTH_PROVIDER_URL}}\",\"SSO_AUTH_PUBLIC_KEY_PEM\":\"{{SSO_AUTH_PUBLIC_KEY_PEM}}\",\"SSO_AUTH_NON_BROWSER_USER_AGENTS\":\"curl,wget,java,python,perl,commons,go-http-client\",\"HADOOP_OPTS\":\"-Dlog4j2.formatMsgNoLookups=true\"},\"files\":[{\"type\":\"STATIC\",\"dest_file\":\"/etc/security/keytabs/{{USER}}.service.keytab\",\"src_file\":\"/user/yarn/.credentials/{{USER}}/{{USER}}.service.keytab\"}],\"properties\":{\"docker.network\":\"bridge\",\"yarn.service.am-resource.memory\":\"4096\",\"yarn.service.am.java.opts\":\"-Xmx3276m -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp -Dlog4j2.formatMsgNoLookups=true\",\"yarn.service.container-upgrade-interval.seconds\":\"0\",\"yarn.service.container-upgrade-failure.threshold\":\"-1\",\"yarn.service.am-restart.max-attempts\":\"4\",\"yarn.service.am-failure.validity-interval-ms\":\"300000\",\"yarn.service.log.exclude-pattern\":\"(service_def.json|.serviceam_history.offset)\",\"yarn.service.rolling-log.include-pattern\":\"ONLY_FAILED_CONATINER_LOGS\"}},\"components\":[{\"name\":\"shell\",\"number_of_containers\":1,\"launch_command\":\"/app/bin/supervisord\",\"resource\":{\"cpus\":1,\"memory\":\"2048\"},\"readiness_check\":{\"type\":\"PORT\",\"properties\":{\"port\":\"9001\"}}}],\"kerberos_principal\":{\"principal_name\":\"{{USER}}/app@{{DOMAIN_REALM}}\",\"keytab\":\"hdfs:///user/yarn/.credentials/{{USER}}/{{USER}}.service.keytab\"}}",
          "dependableApp": {
              "candidates": []
          },
          "appMasterCpuCount": 1,
          "appMasterMemoryMb": 4,
          "publicQueueNames": [
              "batch",
              "dev",
              "longlived"
          ],
          "privateQueueNames": [],
          "components": [{
                "name": "shell",
                "countMin": 1,
                "countMax": 30,
                "cpuCountMin": 1,
                "cpuCountMax": 24,
                "memoryMbMin": 2048,
                "memoryMbMax": 65536
           }]
          }
          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.