Data Forest Overview
- Print
- PDF
Data Forest Overview
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It is available in a VPC environment.
Overview
NAVER Cloud Platform is a cloud service built with NAVER's latest computing technology and operational know-how.
The application program interface (API) that supports the use of services and solutions provided by NAVER Cloud Platform is called NAVER Cloud Platform API.
Common attributes
API URL
https://df.apigw.ntruss.com/api/v2/
Request header
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | - This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. - If the time difference compared to the API Gateway server is 5 minutes or more, then the request is considered invalid. |
| x-ncp-iam-access-key | API key issued by NAVER Cloud Platform or access key issued by IAM |
| x-ncp-apigw-signature-v2 | - A signature that encrypts the body of the example above with the secret key mapped to access key - HmacSHA256 is used for the HMAC encryption algorithm. |
Operation
Accounts
| API name | Description |
|---|---|
| checkAvailableName | Checks the account names available when creating Data Forest account. |
| checkHasResource | Checks if there are resources created belonging to the account before deleting a Data Forest account. |
| create | Creates Data Forest account. |
| getList | Views the list of all Data Forest accounts. |
| getDetail | Views the Data Forest account details. |
| getKerberosKeytab | Downloads the Data Forest app's Kerberos Keytab. |
| resetKerberosKeytab | Resets the Data Forest account's Kerberos Keytab. |
| resetPassword | Resets the Data Forest account's account password. |
| setQuota | Changes HDFS quota of the Data Forest account. |
| delete | Deletes the Data Forest account. |
Notebooks
| API name | Description |
|---|---|
| getVpclist | View the VPC types that can be created when creating Notebooks |
| getVpcDetail | Views detailed information on VPC when creating Notebooks |
| getSubnetList | View the subnets that can be generated when creating Notebooks |
| getSubnetDetail | Views detailed information on Subnet when creating Notebooks |
| getTypeList | View the Notebook types that can be created when creating Notebooks |
| getServerTypeList | Views the server types that can be generated when creating Notebooks |
| getList | View the list of Created Notebooks |
| getDetail | View the detailed information on the created Notebook |
| getUserConfigurationSpecList | Views the user settings necessary for composition of Notebooks |
| checkAvailableName | View the name of the that can be created when creating the Notebook |
| getLoginKeyList | View the list of LoginKey |
| restart | Restarts the created Notebook |
| delete | Deletes Notebook |
| create | Creates Notebooks |
| setUserConfigurationList | Sets Notebook specifications configured by the user |
Apps
| API name | Description |
|---|---|
| checkAvailableName | Checks the account names available for creation when creating the Data Forest app. |
| getAppTypeIdList | Views the list of the Data Forest app type IDs. |
| getAppBasicSetting | Views basic creation settings for the app type specified by Data Forest. |
| getAppTypeTemplate | Views template information of the app type specified by Data Forest. |
| create | Creates the Data Forest app. |
| getList | Views the list of all apps in a Data Forest account. |
| getDetail | View the Data Forest app's details. |
| killContainer | Restarts the Data Forest app's component container. |
| killMaster | Restarts the Data Forest app's application master. |
| setContainerCount | Restarts the number of the Data Forest app's component container. |
| setLifetime | Edits the Data Forest app's lifetime. |
| start | Starts the Data Forest app. |
| stop | Stops the Data Forest app. |
| delete | Deletes the Data Forest app. |
AI Workspaces
| API name | Description |
|---|---|
| checkAvailableName | Checks whether an AI workspace name can be created. |
| getDockerImageList | Views AI workspace's Docker image list. |
| create | Creates an AI workspace. |
| getList | Views all AI workspace list. |
| getDetail | Views all AI workspace details. |
| getConfigurationList | Views AI workspace settings. |
| setConfiguration | Edits AI workspace settings. |
| delete | Deletes AI workspace. |
AI Apps
| API name | Description |
|---|---|
| submit | Runs the AI app. |
| getList | Views all AI app list. |
| getDetail | Views the AI app's details. |
| kill | Stops the AI app. |
Error code
If a wrong API request is sent, or an error occurs during its processing, then the success/failure result is returned as an HTTP status code. The detailed message is then returned in the form of JSON/XML.
Response examples
If the output format is JSON
{
"error": {
"message": "return-message",
"success": "false"
}
}
If the output format is XML
<ErrorResponse>
<message>return-message</message>
<success>false</success>
</ErrorResponse>
Error response
| HTTP Code | Return message | Description | Solutions |
|---|---|---|---|
| 400 | exceeded limit on resource quota | Creation limit exceeded | Inquire to Support > Contact Us. |
| 403 | not allowed to access | Unauthorized access | Add permission to the account, or use the appropriate authentication information. |
| 404 | no such element | Resources or paths that don't exist have been queried. | Check the input value. |
| 500 | unexpected error | Unknown error has occurred. | Inquire to Support > Contact Us. |
Was this article helpful?