Available in VPC
Cloud Hadoop is a NAVER Cloud Platform service that allows users to freely use open source-based frameworks such as Apache Hadoop, HBase, Spark, Hive, and Presto to process big data easily and quickly. Cloud Hadoop provides APIs for Cloud Hadoop cluster management and notebook node management in the RESTful form.
Common Cloud Hadoop settings
The following describes commonly used request and response formats in Cloud Hadoop APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://ncloud.apigw.ntruss.com
Request headers
The following describes the request headers.
Field | Required | Description |
---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
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)
|
Response
The following describes the common response format.
Response body
The response body includes the following data:
responseError
responseError defines the API call failure information. The following describes responseError.
Field | Type | Required | Description |
---|---|---|---|
returnCode |
String | Required | Errors |
returnMessage |
String | Required | Error message |
Response status codes
The following describes the response status codes.
HTTP status code | Code | Message | Description |
---|---|---|---|
400 | 900 | Required field is not specified. location: [Parameter name] | Missing required parameter
|
400 | 5000009 | An error occurred while processing the internal system. | An internal system error has occurred.
|
400 | 5000020 | Processing of [View or Change]/[Sub Account action name] SubAccount authentication failed. | No permission on sub account.
|
400 | 5001005 | The cluster is in another operation. Please try again after the existing work is completed. | Called an already running cluster.
|
400 | 5001022 | Not a user-owned cluster. | Cluster instance number input error
|
400 | 5001049 | Network Interface does not have an IP that can be assigned. | Insufficient subnet
|
400 | 5001139 | Contract restriction error. Creation limit is set. The cluster can no longer be created. Please contact customer support to modify the limit. | Creation limit
|
400 | 5001269 | The instance could not be found. | The cluster has been deleted and does not exist.
|
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
{ "responseError":{ "returnCode":"stirng", "returnMessage":"stirng" } }
- XML
<responseError> <returnCode>stirng</returnCode> <returnMessage>stirng</returnMessage> </responseError>
Cloud Hadoop API
The following describes the APIs provided by the Cloud Hadoop service.
Clusters
The following describes the cluster-related APIs.
API | Description |
---|---|
backupClusterConfiguration | Back up cluster settings on a Object Storage bucket. |
changeCloudHadoopNodeCount | Change the number of cluster nodes. |
changeCloudHadoopNodeSpec | Upgrade cluster node specification. |
createCloudHadoopInstance | Create cluster. |
deleteCloudHadoopInstance | Delete cluster. |
getCloudHadoopAddOnList | Get the list of components that can be installed additionally. |
getCloudHadoopBucketList | Get available Object Storage buckets. |
getCloudHadoopClusterTypeList | Get available cluster types. |
getCloudHadoopImageProductList | Get available cluster images. |
getCloudHadoopInstanceDetail | Get details of a single cluster. |
getCloudHadoopInstanceList | Get cluster list. |
getCloudHadoopLoginKeyList | Get the authentication key in use. |
getCloudHadoopMysqlInstanceList | Get Cloud DB for MySQL that can be integrated with a Hive metastore. |
getCloudHadoopMysqlUserList | Get user information of Cloud DB for MySQL that can be integrated with a Hive metastore. |
getCloudHadoopObjectList | Get the list of objects in a Object Storage bucket in use. |
getCloudHadoopProductList | Get available node-specific server types. |
getCloudHadoopTargetSubnetList | Get the subnet in use. |
getCloudHadoopTargetVpcList | Get the VPC in use. |
saveExternalHiveMetaStore | Integrate Hive metastore. |
testConnectExternalHiveMetaStore | Test Hive metastore integration availability. |
Notebooks
The following describes the notebook-related APIs.
API | Description |
---|---|
createCloudHadoopNotebookInstance | Create a notebook. |
deleteCloudHadoopNotebookInstance | Delete a notebook. |
getCloudHadoopNotebookBucketList | Get available Object Storage buckets. |
getCloudHadoopNotebookComponentList | Get available notebook components. |
getCloudHadoopNotebookImageProductList | Get available notebook images. |
getCloudHadoopNotebookInstanceDetail | Get details of a single notebook. |
getCloudHadoopNotebookInstanceList | Get the list of notebooks. |
getCloudHadoopNotebookProductList | Get available notebook node server types. |
Cloud Hadoop related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Cloud Hadoop APIs.
- Cloud Hadoop API guides
- Create signature: how to create a signature to add to the request header
- Sub Account User Guide: how to issue the access key to be added to the request header
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the Cloud Hadoop service
- How to use the Cloud Hadoop service
- Cloud Hadoop (VPC) User Guide: how to use Cloud Hadoop in the NAVER Cloud Platform console
- Ncloud use environment guide: guide on VPC and Classic environments and supported features
- Introduction to pricing, characteristics, and detailed features: the summary of pricing system, characteristics, and detailed features of Cloud Hadoop
- Latest service news: the latest news on the Cloud Hadoop service
- FAQ: frequently asked questions from the Cloud Hadoop service users
- Contact us: Send direct inquiries for unresolved questions that aren't answered by the API guide.