getAppTypeTemplate

Available in VPC

View template information of the app type specified by Data Forest.

Requests

Request parameters

Request headers

See common guide.

Request bodies

• JSON

    {
        "appTypeId": "string"
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetAppTypeTemplateRequest>
        <appTypeId>string</appTypeId>
    </GetAppTypeTemplateRequest>
  

Responses

Response bodies

• JSON

    {
        "message": "string",
        "success": true,
        "template": "string"
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetAppTypeTemplateResponse>
        <message>string</message>
        <success>true</success>
        <template>string</template>
    </GetAppTypeTemplateResponse>
  

Errors

See DataForest overview

Examples

Request Examples

• HTTP

  POST https://df.apigw.ntruss.com/api/v2/apps/getAppTypeTemplate
  HOST: df.apigw.ntruss.com
  Content-Type: application/json
  x-ncp-apigw-timestamp: 1658898041497
  x-ncp-iam-access-key: 17F9A6E9F72BD92ED94B
  x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
  {
  "appTypeId": "DEV-1.0.0"
  }
  

• BASH

  curl -X POST "https://df.apigw.ntruss.com/api/v2/apps/getAppTypeTemplate" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-ncp-apigw-timestamp:1658898041497" \
  -H "x-ncp-iam-access-key:17F9A6E9F72BD92ED94B" \
  -H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=" \
  -d "{ \"appTypeId\": \"DEV-1.0.0\"}" \
  

Response examples

• HTTP

  HTTP Status	Description
  200	OK

• BASH

  {
  "success": true,
  "template": "{\"name\":\"<app-name>\",\"lifetime\": integer,\",\"queue\":\"dev\",\"description\":\"DEV-1.0.0\",\"artifact\":{\"id\":\"{{DEFAULT_DOCKER_REGISTRY}}/dataforest/df-env: 20** 1229\",\"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\"}}",
  }