Data Box Frame overview

Prev Next

Available in VPC

Data Box Frame is a NAVER Cloud Platform service that helps analysts freely analyze customer data and data managers restrict unauthorized data removal. The Data Box Frame service provides APIs for creating box frames and data boxes and reviewing data import and export in the RESTful form.

Common Data Box Frame settings

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

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://databoxframe.apigw.ntruss.com

Request headers

The following describes the request 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)
x-ncp-lang Optional Multilingual handling of response data
  • ko-KR | en-US (default) | zh-CN
    • ko-KR: Korean
    • en-US: English
    • zh-CN: Chinese (Simplified)
Note

When calling bucket-related Data Box Frame API from a sub account, the sub account may need permission for the Object Storage service.

Response

The following describes the common response format.

Response body

The response body includes the following data:

error
error defines the API call failure information. The following describes error.

Field Type Required Description
error Object - Error code and message
error.errorCode String Required Errors
error.message String Required Error message
error.details String Required Error message detailed description

Response status codes

The following describes the response status codes.

HTTP status code Code Message Description
200 - - Succeeded
400 10001 - Request information and parameter error.
400 130*** - Request information and parameter error.
401 - - Invalid authentication information
403 10002 - Unauthorized request
404 10009 - Non-existent resource or path
500 130000 - Internal service error.
500 139999 - Integrated service API call error
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.

{
    "error": {
        "errorCode": "200",
        "message": "Authentication Failed",
        "details": "Invalid authentication information."
    }
}

Data Box Frame API

The following describes the APIs provided by the Data Box Frame service.

Data Box Frame

The following describes the APIs for Data Box Frame.

API Description
get-data-box-frame-list Get Data Box Frame list.
get-data-box-frame-detail Get Data Box Frame details.
get-data-box-frame-infra-list Get Data Box Frame infrastructure list.
modify-data-box-frame-admin-infra Change Data Box Frame infrastructure settings.
change-data-box-frame-nas-volume-size Change Data Box Frame NAS capacity.
return-data-box-frame Terminate Data Box Frame.

Data Box

The following describes the APIs for Data Box.

API Description
get-bucket-list Get the list of buckets to use when importing or exporting Data Box Frame.
create-data-box Create Data Box in Data Box Frame.
get-data-box-list Get Data Box list in Data Box Frame.
get-data-box-summary-info Get Data Box summary information in Data Box Frame.
get-data-box-infra-list Get Data Box infrastructure list in Data Box Frame.
get-hadoop-cluster-info Get Hadoop cluster information in Data Box.
get-linux-info Get Linux server information in Data Box.
get-tensor-flow-info Get TensorFlow server information in Data Box.
change-data-box-nas-volume-size Change NAS capacity in Data Box.
set-block-external-network Allow and block external network connections for Data Box.
modify-data-box Change Data Box infrastructure settings.
return-data-box Terminate Data Box.

Import

The following describes APIs related to file import.

API Description
get-target-nas-list Get the list of NAS devices to save imported files in Data Box.
apply-file-import Request to import files to Data Box.
get-import-apply-list Get the list of file import requests in Data Box.
get-import-apply-detail Get details of file import requests in Data Box.

Export

The following describes APIs related to file export.

API Description
get-ssl-vpn-account-list Get the list of SSL VPN accounts registered in Data Box.
get-source-nas-list Get the list of NAS where export request files are stored in Data Box.
apply-file-export Request to export files from Data Box.
get-export-apply-list Get the list of file export requests in Data Box.
get-export-apply-detail Get details of file export request in Data Box.
return-file-export-apply Cancel file export request in Data Box.

Approve

The following describes APIs related to file export review.

API Description
get-export-file-approve-list Get the list of files subject to export review in Data Box.
get-export-file-approve-detail Get details on files subject to export review in Data Box.
export-file-approve Approve file export request in Data Box.
export-file-reject Reject file export request from Data Box.

Data Box Frame related resources

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