操作ログ転送機能のご利用方法

本ページでは、操作ログ転送機能のご利用方法をご説明いたします。

Wasabiオブジェクトストレージの設定方法

操作ログ転送機能をご利用いただくにあたり必要となる、Wasabiオブジェクトストレージの設定方法についてご説明いたします。

Wasabiオブジェクトストレージの設定方法

  1. Wasabiアカウントを作成

  1. Wasabiのユーザーを作成

    • Smart Data Platform Knowledge Centerの Wasabi ユーザー作成手順 に沿って、Wasabiユーザーを作成してください。
      なお、ユーザー作成後に表示されるユーザー名/アカウント名/初期パスワード/アクセスキー / シークレットキーをメモ帳等で保存してください。
    • ユーザーを作成した後は、 Wasabi Management Console 利用手順 に沿って、Wasabiコンソールへログインしてください。
../_images/wasabi_user.png

  1. CREATE BUCKETを選択
../_images/wasabi_bucket.png

  1. Bucket Name・Regionを入力し、CREATE BUCKETを選択
    • 入力するBucket Nameは、メモ帳等で保存してください。
../_images/wasabi_create_bucket.png

  1. ログを転送する先のBucketのEndpointを確認


IAMロールの作成時のリソースの値

操作ログ転送機能に関するAPIの実行を許可するIAMロールの作成時のリソースの値についてご説明いたします。

IAMロールの作成時のリソースの値

  1. リソースに指定する値は、下記の通りです。

    {
        "basePath": "/v2/apilog",
        "ipAddress": "*",
        "path": "*",
        "verb": "*"
    }
    

ログの転送設定の方法

操作ログ転送機能をご利用いただく際のログの転送設定の方法をご説明いたします。

ログの転送設定の方法

  1. SDPFポータルにログインし、ヘッダー部分のプロファイルを選択する
../_images/portal_profile.png

  1. API鍵/API秘密鍵を取得する
../_images/apikey.png
  • API秘密鍵の情報を失念した場合は、「API鍵を再生成」からAPI鍵・API秘密鍵を改めて発行してください。

  1. 取得したAPI鍵/秘密鍵の情報を用いて、以下のAPIを実行する

    • Method
    POST
    
    • Base Path
    https://api.ntt.com/v1/oauth/accesstokens
    
    • Request Headers
    Content-Type: application/json
    
    • Request Body
    {
        "grantType": "client_credentials",
        "clientId": "2.で取得したAPI鍵",
        "clientSecret": "2.で取得したAPI秘密鍵"
    }
    

  1. 3.で実行したAPIの結果からAccess Tokenを取得する

    • Example Result
    {
        "accessToken": "[Access_Token]",
        "tokenType": "BearerToken",
        "expiresIn": "3599",
        "scope": "READ WRITE",
        "issuedAt": "1407483969338"
    }
    
    • 注意:取得したアクセストークンは、 APIゲートウェイ規約 に従い、センシティブに扱うようにしてください。共有、および、他人に貸与してはなりません。

  1. 以下APIを実行して、ログの転送設定を行う

    • Method
    POST
    
    • Base Path
    https://api.ntt.com/v2/apilog/storages
    
    • Request Headers
    Content-Type: application/json
    Authorization: Bearer [4.で取得したAccess Token]
    
    • Request Body
    {
        "storageProvider": {
            "name": "wasabi",
            "accessKey": "ストレージサービスのアクセスキー",
            "secretAccessKey": "ストレージサービスのシークレットキー",
            "endpoint": "ストレージサービスのendpoint",
            "bucket": "ストレージサービスのBucket"
        }
    }
    
    • ストレージにWasabiを設定していただく際は、Wasabiの設定方法でメモ帳等に保管したアクセスキー,シークレットキー,endpoint,Bucketをご指定ください。

  1. APIの実行結果を確認する

    • Example Result
    {
        "storageProvider": {
            "name": "wasabi",
            "accessKey": "ストレージサービスのアクセスキー",
            "secretAccessKey": "ストレージサービスのシークレットキー",
            "endpoint": "ストレージサービスのendpoint",
            "bucket": "ストレージサービスのBucket"
        },
        "storageUuid": "登録されているストレージに対応したUUIDが表示されます。"
    }
    
    • 実行結果に記載されるUUIDは、ログの転送設定確認テストの方法やログの転送設定解除の方法で利用します。

ログの転送設定確認テストの方法

ログの転送設定が問題なく設定できているか確認する方法についてご説明いたします。

ログの転送設定確認テストの方法

  1. 以下のAPIを実行する

    • Method
    POST
    
    • Base Path
    https://api.ntt.com/v2/apilog/storages/{登録されているストレージに対応したUUID}/validate
    
    • Request Headers
    Content-Type: application/json
    Authorization: Bearer [Access Token]
    
    • Request Body
    {
    }
    
    • Request Bodyに関して、具体的な値の指定は不要ですが、{}の入力は必要です。

  1. APIの実行結果を確認する

    • Example Result
      下記の結果が返却されれば、ログの転送設定が問題なく、設定されております。
    {
        "message": "dummy data is queued"
    }
    
    • なお、ログの転送設定ができていない場合は、以下の結果が返却されます。
    {
        "message": "ValidationError:storageUuid not found"
    }
    

  1. 対象のストレージにテストログが格納されていることを確認する

    • テストログが対象ストレージに登録されていることが確認できたら、ログの転送が設定されています。
      なお、テストログは以下のフォーマットで出力されます。
フィールド名 説明
username Smart Data PlatformのユーザーID
apilogStorageUuid 転送設定したストレージに対応するUUID
message This is a validate dummy data(固定値)
apilogValidate true(固定値)
eventTime お客様がAPIを実行した時刻(UTC(協定世界時)で表示)

ログの転送設定解除の方法

ログの転送設定を解除する方法についてご説明いたします。

ログの転送設定解除の方法

  1. 以下のAPIを実行する

    • Method
    DELETE
    
    • Base Path
    https://api.ntt.com/v2/apilog/storages/{登録されているストレージに対応したUUID}
    
    • Request Headers
    Authorization: Bearer [Access Token]
    

ログの確認方法

wasabiオブジェクトストレージに転送されたログの確認方法についてご説明いたします。

ログの確認方法

  1. Wasabi ログイン画面 に遷移する

  1. ログイン画面上で以下の情報を入力する

    • Root Account Email or Alias : アカウント名
    • Subuser Name : ユーザー名
    • Password : パスワード
../_images/wasasbi_login.png

  1. ログの転送先に指定したBucketを選択する
../_images/wasabi_bucket_ch.png

  1. ポータル操作/API操作を実行した日付のフォルダにアクセスする

    • YYYY / MM / DDの形式でフォルダが自動生成されています。

  1. ポータル操作 / API操作を実行した時間(UTC(協定世界時))でフォルダ内を検索する

../_images/wasabi_search.png

ストレージ登録状況確認方法

操作ログの転送先として、設定したストレージの登録状況を確認する方法についてご説明いたします。

ログの転送設定の方法

  1. 以下APIを実行する

    • Method
    GET
    
    • Base Path
    https://api.ntt.com/v2/apilog/storages/{登録されているストレージに対応したUUID}
    
    • Request Headers
    Authorization: Bearer [Access Token]
    
  2. APIの実行結果を確認する

    • Example Result
      Statusが”activated”になっていれば、登録されたストレージは有効化されています。
      Statusが”deactivated”になっている場合は、ストレージ登録状況の有効化方法を実施して、ストレージを有効化してください。
    {
        "id": "登録されているストレージに対応したUUID",
        "name": "wasabi",
        "endpoint": "ストレージサービスのendpoint",
        "bucket": "ストレージサービスのBucket",
        "status": "activated" or "deactivated"
    }
    

ストレージ登録状況の有効化方法

操作ログの転送先として、設定したストレージの登録状況を有効化する方法についてご説明いたします。

ストレージ登録状況の有効化方法

  1. 以下APIを実行する

    • Method
    POST
    
    • Base Path
    https://api.ntt.com/v2/apilog/storages/{登録されているストレージに対応したUUID}?activated=true
    
    • Request Headers
    Authorization: Bearer [Access Token]
    
  2. APIの実行結果を確認する

    • Example Result
      Statusが”activated”になっていれば、登録されたストレージは有効化されています。
    {
        "id": "登録されているストレージに対応したUUID",
        "name": "wasabi",
        "endpoint": "ストレージサービスのendpoint",
        "bucket": "ストレージサービスのBucket",
        "status": "activated"
    }