APILog API v2

Overview

本APIを用いて、各種APIの利用履歴を格納するお客様が契約するクラウドストレージを指定します。本APIによる格納先指定が行われると、APIをCALLするユーザのメールアドレス毎に、ログが抽出され指定されたクラウドストレージに格納されます。
ログの格納を行うクラウドストレージはお客様にてご準備ください。2020年12月現在 Amazon S3およびWasabiが指定可能です。(今後順次拡張予定)
お客様のデータマネジメント、及びセキュリティ分析、リソース変更トレースなどお客さまのコンプライアンスマネジメントを支援します。

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。

グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。

1.Base Path(Global Load Balance)

https://api.ntt.com/v2/apilog

2.Base Path(Region)

https://{region}.api.ntt.com/v2/apilog
  • region is jp|us|fr|sg
  • e.g. https://us.api.ntt.com/v2/apilog
  • 指定できるregionは、将来拡充予定

Resource Information

Key Value
レスポンス フォーマット JSON
認証(OAuth) Yes
帯域制御#1 Yes
  • #1 お客さま接続単位で適切な流量制限を実施

API利用履歴 格納ストレージ一覧取得

GET /v2/apilog/storages

Request Parameters

なし

Example Request

 GET /v2/apilog/storages

Response Parameters

Name Description type
storages 登録されたストレージのUUID一覧 Array

Example Result

{
  "storages": [
    "登録されているストレージに対応したUUIDが表示されます。"
  ]
}

API利用履歴 格納ストレージ登録

POST /v2/apilog/storages

Request Parameters

Name ParameterName Description type
storageProvider - 格納先ストレージサービス Dictionary
name 格納先ストレージサービス名 string("AWS","wasabi")
accessKey ストレージサービスのAccessKey string
accessKey ストレージサービスのSecretAccessKey string
endpoint ストレージサービスのendpoint string
bucket ストレージサービスのバケット名 string

Example Request

 POST /v2/apilog/storages
{
  "storageProvider": {
    "name": "wasabi",
    "accessKey":"KEY",
    "secretAccessKey":"SECRET",
    "endpoint": "EP",
    "bucket": "BUCKET"
  }
}

Response Parameters

Name ParameterName Description type
storageProvider - 格納先ストレージサービス Dictionary
name 格納先ストレージサービス名 string("AWS","wasabi")
accessKey ストレージサービスのAccessKey string
accessKey ストレージサービスのSecretAccessKey string
endpoint ストレージサービスのendpoint string
bucket ストレージサービスのバケット名 string
storageUuid - 登録ストレージサービスのUUID string

Example Result

{
  "storageProvider": {
    "name": "wasabi",
    "accessKey":"KEY",
    "secretAccessKey":"SECRET",
    "endpoint": "EP",
    "bucket": "BUCKET"
  },
  "storageUuid": "登録されているストレージに対応したUUIDが表示されます。"
}

API利用履歴 格納ストレージ情報取得

GET /v2/apilog/storages/{{ uuid }}

Request Parameters

なし

Example Request

 GET /v2/apilog/storages/uuid

Response Parameters

Name Description type
id 登録されたストレージのUUID一覧 string
name 格納先ストレージサービス名 string("AWS","wasabi")
endpoint ストレージサービスのendpoint string
bucket ストレージサービスのバケット名 string
status 登録状況 string("activated","deactivated")

Example Result

{
  "id": "登録されているストレージに対応したUUIDが表示されます。",
  "name": "wasabi",
  "endpoint": "EP",
  "bucket": "BUCKET",
  "status": "activated"
}

API利用履歴 格納ストレージステータス変更

POST /v2/apilog/storages/{{ uuid }}

Request Parameters

Name Description type
uuid 登録されたストレージのUUID string
activated ステータス クエリパラメータ(true,false)

Example Request

 POST /v2/apilog/storages/uuid?activated=true

Response Parameters

Name Description type
id 登録されたストレージのUUID string
name 格納先ストレージサービス名 string("AWS","wasabi")
endpoint ストレージサービスのendpoint string
bucket ストレージサービスのバケット名 string
status ステータス string("activated","deactivated")

Example Result

{
  "id": "登録されているストレージに対応したUUIDが表示されます。",
  "name": "AWS",
  "endpoint": "ap-northeast-1",
  "bucket": "apilog",
  "status": "activated"
}

API利用履歴 格納ストレージ情報削除

DELETE /v2/apilog/storages/{{ uuid }}

Request Parameters

なし

Example Request

 DELETE /v2/apilog/storages/uuid

Response Parameters

なし

Example Result

なし


API利用履歴 格納ストレージ接続テスト

POST /v2/apilog/storages/{{ uuid }}/validate

Request Parameters

なし

Example Request

 POST /v2/apilog/storages/uuid/validate

Response Parameters

Name ParameterName Description type
message "dummy data is queued" string

Example Result

{
  "message": "dummy data is queued"
}