Data Forestの概要

Prev Next

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
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名
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クラウドプラットフォームポータルのサポートに問い合わせ
400 - invalid request parameters パラメータ入力エラー
403 - not allowed to access 権限のないリクエスト
  • アカウントに権限を追加するか、適切な認証情報を使用
404 - no such element 存在しないリソースまたはパスを照会
  • 入力値を確認し、有効なリソースまたはパスを入力
500 - unexpected error 不明なエラーが発生
  • NAVERクラウドプラットフォームポータルのサポートに問い合わせ
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

  • JSON
    {
    "error": {
        "message": "string",
        "success": "false"
    }
}
  • XML
<ErrorResponse>
    <message>string</message>
    <success>false</success>
</ErrorResponse>

Data Forest API

Data Forestサービスで提供する APIの説明は次の通りです。

Accounts

Data Forestアカウント関連 APIの説明は次の通りです。

API 説明
checkAvailableName Data Forestアカウント名の有効性と重複をチェック
create Data Forestアカウントを作成
getList Data Forestアカウントリストを照会
getDetail Data Forestアカウントの詳細を個別照会
checkHasResource Data Forestアカウント所有のリソースは存在しないか確認
getKerberosKeytab Kerberos Keytabをダウンロード
resetKerberosKeytab Kerberos Keytabをリセット
resetPassword Data Forestアカウントのパスワードをリセット
setQuota Data Forestアカウントの HDFS Quotaを変更
delete Data Forestアカウントを削除

Apps

Data Forestアプリ関連 APIの説明は次の通りです。

API 説明
checkAvailableName Data Forestアプリ名の有効性と重複をチェック
getAppBasicSetting Data Forestアプリタイプの基本設定を照会
getAppTypeIdList Data Forestアプリタイプの IDリストを照会
getAppTypeTemplate Data Forestアプリタイプのテンプレート情報を照会
create Data Forestアプリを作成
getList Data Forestアカウントのアプリリストを照会
getDetail Data Forestアプリの詳細を個別照会
setContainerCount Data Forestアプリコンポーネントのコンテナ数を変更
setLifetime Data Forestアプリ稼働時間(Lifetime)を変更
killContainer Data Forestアプリコンポーネントのコンテナを再起動
killMaster Data Forestアプリ Application Masterを再起動
start Data Forestアプリを起動
stop Data Forestアプリを停止
delete Data Forestアプリを削除

Data Forest関連リソース

Data Forestについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。