Datafence overview

Prev Next

Available in VPC

Datafence is a NAVER Cloud Platform service that builds an analytics environment where analysts can freely analyze customer data and data admins can restrict unauthorized data export. The Datafence service provides APIs for creating datafences and boxes and reviewing data import and export in RESTful format.

Common Datafence settings

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

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://datafence.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 Datafence APIs 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 Error code
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 2600003 - Not the owner of datafence (or box)
400 2600005 - Requested external network settings are the same as the current settings.
400 2600010 - Server in box rebooted.
400 2600011 - Box creation limit exceeded.
400 2600013 - Invalid password
400 2600023 - At least 1 box is required in datafence.
400 2600024 - Box is uneditable.
400 2600025 - Datafence is unavailable.
400 2600026 - Invalid action type.
400 2600029 - Bucket does not exist.
400 2600031 - Number of servers requested exceeds the allowed range.
400 2600033 - Requested Hadoop block storage exceeds the allowed size.
400 2600035 - Invalid block storage or NAS instance number
400 2600038 - Requested NAS exceeds allowed size.
400 2600040 - Size of NAS to be changed is the same as before.
400 2600041 - Server does not exist in box.
400 2600047 - Box storage does not exist.
400 2600053 - Datafence does not exist.
400 2600054 - Box does not exist.
400 2600072 - Invalid specification code.
400 2600073 - Invalid software code.
400 2610001 - Invalid export request number
400 2610002 - Duplicated request file name
400 2610004 - Maximum number of requests exceeded
400 2610006 - File size exceeded
400 2610008 - Invalid file name
400 2610010 - Already approved export request
400 2610012 - Requested file not found
403 10002 - Unauthorized request
404 10003 - Non-existent resource
500 10007 - Internal service 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."
    }
}

Datafence API

The following describes the APIs provided by the Datafence service.

Datafence

The following describes the datafence-related APIs.

API Description
get-datafence Get the datafence list.
get-datafence-infra-history Get the datafence infrastructure history.
get-datafence-infra-list Get the datafence infrastructure list.
get-fence-custom-image Get the datafence user image.
change-datafence-infra Change datafence infrastructure settings.
change-fence-nas-volume Change datafence NAS capacity.

Box

The following describes the box-related APIs.

API Description
get-bucket-list Get the list of buckets to use when importing or exporting datafence.
get-product-spec Get the box specification list.
create-box Create a box in a datafence.
get-box-custom-image Get the user image in a box.
get-box-history Get the box history in a datafence.
get-box-infra-history Get the box infrastructure history in a datafence.
get-box-infra-list Get the box infrastructure list in a datafence.
get-box-list Get the box list in a datafence.
get-box-summary-info Get the summary information of boxes in a datafence.
get-connect-info Get connect server information in a box.
get-hadoop-cluster-info Get Hadoop cluster information in a box.
get-linux-info Get Linux server information in a box.
get-windows-info Get Windows Server information in a box.
get-tensorflow-info Get TensorFlow server information in a box.
change-box-block-external-network Allow and block external network connections for a box.
change-box-infra Change box infrastructure settings.
change-box-nas-volume Change NAS capacity in a box.
return-box Terminate a box.

Import

The following describes APIs related to file import.

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

Export

The following describes APIs related to file export.

API Description
create-file-export Request to export files from a box.
get-export-detail Get details of file export request in a box.
get-export-list Get the list of file export requests in a box.
get-source-nas-list Get the list of NAS where export request files are stored in a box.
cancel-file-export Cancel file export request in a box.

Export Approval

The following describes APIs related to file export review.

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

Datafence related resources

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