Data Forest overview

Prev Next

Available in VPC

Data Forest is a NAVER Cloud Platform big data analytics platform service that provides a variety of open source applications from big data analysis to machine learning. The Data Forest service provides APIs for Data Forest accounts and app features in the RESTful form.

Common Data Forest settings

The following describes commonly used request and response formats in Data Forest APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://df.apigw.ntruss.com

Request headers

The following describes the headers.

Header name Required Description
x-ncp-apigw-timestamp Required This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
  • Unix timestamp format
x-ncp-iam-access-key Required Access key issued on NAVER Cloud Platform
x-ncp-apigw-signature-v2 Required Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
Accept Optional Response data format
  • application/json | application/xml | application/octet-stream
Content-type Optional Request data format
  • application/json | application/xml

Response

The following describes the common response format.

Response body

The response body includes the following data:

ErrorResponse
ErrorResponse defines API call failure information. The following describes ErrorResponse.

Field Type Required Description
message String Required Error message
success Boolean Required API processing result
  • false: failure (valid value)

Response status codes

The following describes the response status codes.

HTTP status code Code Message Description
400 - exceeded limit on resource quota Creation limit exceeded.
  • Contact Support from the NAVER Cloud Platform portal.
400 - invalid request parameters Parameter input error
403 - not allowed to access Unauthorized request.
  • Add permissions to the account or use appropriate credentials.
404 - no such element Queried a non-existent resource or path.
  • Check the input value and enter the correct resource or path.
500 - unexpected error Unknown error occurred.
  • Contact Support from the NAVER Cloud Platform portal.
Note

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

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

Data Forest API

The following describes the APIs provided by the Data Forest service.

Accounts

The following describes the APIs related to Data Forest account.

API Description
checkAvailableName Check validity and duplication of Data Forest account name.
create Create Data Forest account.
getList Get Data Forest account list.
getDetail Get details of a single Data Forest account.
checkHasResource Check the existence of resources owned by a Data Forest account.
getKerberosKeytab Download Kerberos Keytab.
resetKerberosKeytab Reset Kerberos Keytab.
resetPassword Reset the Data Forest account password.
setQuota Change HDFS quota for a Data Forest account.
delete Delete an Data Forest account.

Apps

The following describes the APIs related to Data Forest app.

API Description
checkAvailableName Check validity and duplication of Data Forest app name.
getAppBasicSetting Get Data Forest app type basic settings.
getAppTypeIdList Get the list of Data Forest app type IDs.
getAppTypeTemplate Get Data Forest app type template information.
create Create Data Forest app
getList Get the list of apps in a Data Forest account.
getDetail Get details of a single Data Forest app.
setContainerCount Change number of Data Forest app component containers.
setLifetime Change Data Forest app lifetime.
killContainer Restart Data Forest app component container.
killMaster Restart Data Forest app application master.
start Start the Data Forest app.
stop Stop the Data Forest app.
delete Delete the Data Forest app.

Data Forest related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Data Forests.