Data Box Frame の概要

概要

Data Box Frame APIは RESTfulの形で提供されます。HTTP方式の GET/POST/DELETEメソッドの呼び出しを介して行われます。
APIにより Data Box Frameおよび data Boxを作成することができ、搬入/搬出/搬出承認/搬出返却などの搬入/搬出審査を行うことができます。

共通設定

Data Box Frame API Endpoint

リクエストヘッダ

認証ヘッダ

Data Box Frame APIは NAVERクラウドプラットフォーム API Gatewayを通じ提供され、API Gatewayに登録された APIを使用するためには2種類の認証キー(Access Key ID、Secret Key)を発行する必要があります

詳細については、NAVERクラウドプラットフォーム APIガイドをご参照ください。

• 認証キーの作成
  • NAVERクラウドプラットフォームポータルのマイページ > アカウント管理 > 認証キー管理メニューで新規 API****認証キー作成をクリックして Access Key ID、Secret Keyを作成します
  • もし Access Key ID、Secret Keyがある場合このキーを使用します。

リクエスト例

curl -i -s -X GET \
-H "accept: application/json" \
-H "x-ncp-iam-access-key: 1TrIkA58bQJknHn5hsC6" \
-H "x-ncp-apigw-timestamp: 1682988927452" \
-H "x-ncp-apigw-signature-v2: 0fyArnaWvkYYsepc6rMXKFTADwE2NnIGFHQ4GyKc3pU=" \
-H "cache-control: no-cache" \
"https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-list"

• Signatureの作成(改行文字は \nを使用)

  • リクエストに合わせて StringToSignを作成し、SecretKeyで HmacSHA256アルゴリズムに暗号化した後、Base64にエンコードします。
  • この値をx-ncp-apigw-signature-v2として使用します。

• サンプルコード

public String makeSignature() {
    String space = " ";  // 空白
    String newLine = "\n";  // 改行
    String method = "POST";  // HTTPメソッド
    String url = "/api/v1/mails";  // ドメインを除く "/" 下記全体 url (クエリストリングを含む)
    String timestamp = "{timestamp}";  // 現在のタイムスタンプ(epoch、millisecond)
    String accessKey = "{accessKey}";  // access key id (from portal or sub account)
    String secretKey = "{secretKey}";  // secret key (from portal or sub account)

    String message = new StringBuilder()
        .append(method)
        .append(space)
        .append(url)
        .append(newLine)
        .append(timestamp)
        .append(newLine)
        .append(accessKey)
        .toString();

    SecretKeySpec signingKey = new SecretKeySpec(secretKey.getBytes("UTF-8"), "HmacSHA256");
    Mac mac = Mac.getInstance("HmacSHA256");
    mac.init(signingKey);

    byte[] rawHmac = mac.doFinal(message.getBytes("UTF-8"));
    String encodeBase64String = Base64.getEncoder().encodeToString(rawHmac);

  return encodeBase64String;

}

function makeSignature() {
    $space = " ";  // 空白
    $newLine = "\n";  // 改行
    $method = "POST";  // HTTPメソッド
    $uri= "/api/v1/mails";  // ドメインを除く "/" 下記全体 url(クエリストリングを含む)
    $timestamp = "{timestamp}";  // 現在のタイムスタンプ(epoch、millisecond)
    $accessKey = "{accessKey}";  // access key id (from portal or sub account)
    $secretKey = "{secretKey}";  // secret key (from portal or sub account)
    
    $hmac = $method.$space.$uri.$newLine.$timestamp.$newLine.$accessKey;
    $signautue = base64_encode(hash_hmac('sha256', $hmac, $secretKey,true));
    
    return $signautue;
}

共通レスポンス

HTTPステータスコードでリターンされ、Body情報として伝達する。

オペレーション

Data Box Frame

• get-data-box-frame-list
• get-data-box-frame-detail
• get-data-box-frame-infra-list
• modify-data-box-frame-admin-infra
• change-data-box-frame-nas-volume-size
• return-data-box-frame

Data Box

• get-data-box-list
• get-data-box-summary-info
• get-data-box-infra-list
• get-hadoop-cluster-info
• get-linux-info
• get-tensor-flow-info
• create-data-box
• modify-data-box
• change-data-box-nas-volume-size
• set-block-external-network
• return-data-box

搬入

• get-import-apply-list
• get-import-apply-detail
• get-target-nas-list
• apply-file-import

搬出

• get-export-apply-list
• get-export-apply-detail
• get-ssl-vpn-account-list
• get-source-nas-list
• apply-file-export
• return-file-export-apply

搬出の審査

• get-export-file-approve-list
• get-export-file-approve-detail
• export-file-approve
• export-file-reject

Object Storage-Bucket

• get-bucket-list