--- title: "Data Forestの概要" slug: "analytics-dataforest" tags: ["Data Forest", "overview"] updated: 2026-09-17T09:57:35Z published: 2026-09-17T09:57:35Z canonical: "api.ncloud-docs.com/analytics-dataforest" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # Data Forestの概要 VPC環境で利用できます。 Data Forestはビックデータ分析から機械学習まで、さまざまなオープンソースアプリケーションを提供する NAVERクラウドプラットフォームのビックデータ分析プラットフォームサービスです。Data Forestサービスは、Data Forestのアカウント、アプリ機能関連の APIを RESTful形式で提供します。 ## Data Forestの共通設定 Data Forest APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。 ### リクエスト 共通リクエスト形式を説明します。 #### API URL リクエスト API URLは次の通りです。 ``` https://df.apigw.ntruss.com ``` #### リクエストヘッダ ヘッダの説明は次の通りです。 | ヘッダ名 | 必須の有無 | 説明 | | --- | --- | --- | | `x-ncp-apigw-timestamp` | Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒) - API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす - Unix Timestamp形式 | | `x-ncp-iam-access-key` | Required | NAVERクラウドプラットフォームから発行された Access Key - Access Keyの発行と確認: [認証キーの作成](/docs/ja/common-ncpapi)を参照 - サブアカウントの Access Key発行と確認: [サブアカウントの作成](https://guide.ncloud-docs.com/docs/ja/subaccount-use#%EC%84%9C%EB%B8%8C-%EA%B3%84%EC%A0%95-%EC%83%9D%EC%84%B1)を参照 | | `x-ncp-apigw-signature-v2` | Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名 - Secret Keyの発行と確認: [認証キーの作成](/docs/ja/common-ncpapi)を参照 - 署名の作成: [シグネチャーの作成](/docs/ja/common-ncpapi)を参照 | | `Accept` | Optional | レスポンスデータの形式 - `application/json` \| `application/xml` \| `application/octet-stream` | | `Content-type` | Optional | リクエストデータの形式 - `application/json` \| `application/xml` | ### レスポンス 共通レスポンス形式を説明します。 #### レスポンスボディ レスポンスボディの説明は次の通りです。 **ErrorResponse** ErrorResponseは API呼び出し失敗情報を定義します。ErrorResponseの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `message` | String | Required | エラーメッセージ | | `success` | Boolean | Required | APIの処理結果 - `false`: 失敗(有効値) | #### レスポンスステータスコード レスポンスステータスコードの説明は次の通りです。 | HTTPステータスコード | コード | メッセージ | 説明 | | --- | --- | --- | --- | | 400 | - | exceeded limit on resource quota | 作成数制限を超過 - NAVERクラウドプラットフォームポータルの[**サポート**](https://www.ncloud.com/support/question/service)に問い合わせ | | 400 | - | invalid request parameters | パラメータ入力エラー | | 403 | - | not allowed to access | 権限のないリクエスト - アカウントに権限を追加するか、適切な認証情報を使用 | | 404 | - | no such element | 存在しないリソースまたはパスを照会 - 入力値を確認し、有効なリソースまたはパスを入力 | | 500 | - | unexpected error | 不明なエラーが発生 - NAVERクラウドプラットフォームポータルの[**サポート**](https://www.ncloud.com/support/question/service)に問い合わせ | 参考 NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、[Ncloud APIのレスポンスステータスコード](/docs/ja/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 #### レスポンス例 呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。 - JSON ``` { "error": { "message": "string", "success": "false" } } ``` - XML ``` string false ``` ## Data Forest API Data Forestサービスで提供する APIの説明は次の通りです。 ### Accounts Data Forestアカウント関連 APIの説明は次の通りです。 | API | 説明 | | --- | --- | | [checkAvailableName](/docs/ja/analytics-dataforest-accounts-checkavailablename) | Data Forestアカウント名の有効性と重複をチェック | | [create](/docs/ja/analytics-dataforest-accounts-create) | Data Forestアカウントを作成 | | [getList](/docs/ja/analytics-dataforest-accounts-getlist) | Data Forestアカウントリストを照会 | | [getDetail](/docs/ja/analytics-dataforest-accounts-getdetail) | Data Forestアカウントの詳細を個別照会 | | [checkHasResource](/docs/ja/analytics-dataforest-accounts-checkhasresource) | Data Forestアカウント所有のリソースは存在しないか確認 | | [getKerberosKeytab](/docs/ja/analytics-dataforest-accounts-getkerberoskeytab) | Kerberos Keytabをダウンロード | | [resetKerberosKeytab](/docs/ja/analytics-dataforest-accounts-resetkerberoskeytab) | Kerberos Keytabをリセット | | [resetPassword](/docs/ja/analytics-dataforest-accounts-resetpassword) | Data Forestアカウントのパスワードをリセット | | [setQuota](/docs/ja/analytics-dataforest-accounts-setquota) | Data Forestアカウントの HDFS Quotaを変更 | | [delete](/docs/ja/analytics-dataforest-accounts-delete) | Data Forestアカウントを削除 | ### Apps Data Forestアプリ関連 APIの説明は次の通りです。 | API | 説明 | | --- | --- | | [checkAvailableName](/docs/ja/analytics-dataforest-apps-checkAvailablename) | Data Forestアプリ名の有効性と重複をチェック | | [getAppBasicSetting](/docs/ja/analytics-dataforest-apps-getappbasicsetting) | Data Forestアプリタイプの基本設定を照会 | | [getAppTypeIdList](/docs/ja/analytics-dataforest-apps-getapptypeidlist) | Data Forestアプリタイプの IDリストを照会 | | [getAppTypeTemplate](/docs/ja/analytics-dataforest-apps-getapptypetemplate) | Data Forestアプリタイプのテンプレート情報を照会 | | [create](/docs/ja/analytics-dataforest-apps-create) | Data Forestアプリを作成 | | [getList](/docs/ja/analytics-dataforest-apps-getlist) | Data Forestアカウントのアプリリストを照会 | | [getDetail](/docs/ja/analytics-dataforest-apps-getdetail) | Data Forestアプリの詳細を個別照会 | | [setContainerCount](/docs/ja/analytics-dataforest-apps-setcontainercount) | Data Forestアプリコンポーネントのコンテナ数を変更 | | [setLifetime](/docs/ja/analytics-dataforest-apps-setlifetime) | Data Forestアプリ稼働時間(Lifetime)を変更 | | [killContainer](/docs/ja/analytics-dataforest-apps-killcontainer) | Data Forestアプリコンポーネントのコンテナを再起動 | | [killMaster](/docs/ja/analytics-dataforest-apps-killmaster) | Data Forestアプリ Application Masterを再起動 | | [start](/docs/ja/analytics-dataforest-apps-start) | Data Forestアプリを起動 | | [stop](/docs/ja/analytics-dataforest-apps-stop) | Data Forestアプリを停止 | | [delete](/docs/ja/analytics-dataforest-apps-delete) | Data Forestアプリを削除 | ## Data Forest関連リソース Data Forestについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。 - Data Forest APIの使用方法 - [署名(シグネチャー)の作成](/docs/ja/common-ncpapi): リクエストヘッダに追加する署名の作成方法 - [API Gatewayご利用ガイド](https://guide.ncloud-docs.com/docs/ja/apigw-apigw-1): リクエストヘッダに追加する API Keyを発行 - [Sub Accountご利用ガイド](https://guide.ncloud-docs.com/docs/ja/subaccount-overview): リクエストヘッダに追加する Access Keyの発行方法 - [Ncloudの共通レスポンスステータスコード](/docs/ja/common-ncpapi#3-%EC%9D%91%EB%8B%B5-%EC%83%81%ED%83%9C-%EC%BD%94%EB%93%9C): Data Forestサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報 - Data Forestサービスの使用方法 - [Data Forestご利用ガイド](https://guide.ncloud-docs.com/docs/ja/df-overview): NAVERクラウドプラットフォームコンソールで Data Forestを使用する方法 - [Ncloud使用環境ガイド](https://guide.ncloud-docs.com/docs/ja/environment-environment-1-1): VPC、Classic環境とサポート有無に関するガイド - [料金の紹介、特徴、詳細機能](https://www.ncloud.com/product/analytics/dataForest): Data Forestの料金体系、特徴、詳細機能のサマリー - [サービスのお知らせ](https://www.ncloud.com/intro/news): Data Forestサービスに関するお知らせ - [よくある質問](https://www.ncloud.com/support/faq/prod?categoryCode2=ANALY&categoryCode3=SV_0183&page=1): Data Forestサービスに関するよくあるご質問 - [お問い合わせ](https://www.ncloud.com/support/question/general): APIガイドだけでは不明な点が解消されない場合、直接お問い合わせ