getAppBasicSetting
- 印刷する
- PDF
getAppBasicSetting
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
Data Forest指定のアプリタイプの基本作成設定を照会します。
リクエスト
リクエストパラメータ
パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
accountId | YES | String | 最大22文字まで入力 | - アカウント識別子 UUID(base62) - accountIdは Accountsの getList APIを通じて取得可能 |
appTypeId | YES | String | 最大60文字まで入力 | - Data Forestのアプリタイプとアプリバージョン - appTypeIdは Appsの getAppTypeIdList APIを通じて取得可能 - 例: DEV-1.0.0 |
リクエストヘッダ
リクエストボディ
- JSON
{ "accountId": "string", "appTypeId": "string" }
- XML
<?xml version="1.0" encoding="UTF-8"?> <GetAppBasicSettingRequest> <accountId>string</accountId> <appTypeId>string</appTypeId> </GetAppBasicSettingRequest>
レスポンス
レスポンスボディ
- 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" }
- 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>
エラーコード
例
リクエスト例
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" }
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\"}" \
レスポンス例
HTTP
HTTP Status Description 200 OK BASH
{ "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 }] }
この記事は役に立ちましたか?