VPC環境で利用できます。
Data Forestアプリタイプの基本作成設定を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /api/v2/apps/getAppBasicSetting |
リクエストヘッダ
Data Forest APIで共通して使用されるヘッダの詳細は、Data Forestのリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
accountId |
String | Required | アカウント固有 ID
|
appTypeId |
String | Required | アプリのタイプとバージョン
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/getAppBasicSetting' \
--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": "Arv**************kfn",
"appTypeId": "DEV-1.0.0"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、GetAppBasicSettingResponseをご参照ください。
レスポンスステータスコード
Data Forest APIで共通して使用されるレスポンスステータスコードの詳細は、Data Forestのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"success": true,
"template": "{\"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
}
]
}