APILog API v2

Overview

本APIを利用することで、各APIの利用履歴を保存するために契約しているクラウドストレージを指定することができます。本APIで保存先を指定すると、APIをCALLしたユーザーのメールアドレスごとにログが抽出され、指定したクラウドストレージに保存されます。
ログを保存するクラウドストレージは、お客様ご自身でご用意いただく必要があります。2022年11月現在、Amazon S3、Wasabi、Azureが指定可能です。(今後拡張予定)
リソース変更のトレースなど、お客様のデータ管理を支援します。
※本サービスはログ転送を完全に保証するものではありません。

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

Resource Information

• #1 顧客接続ユニットで適切な流量制限を行う。

API利用履歴 - ストレージ一覧検索

GET /v2/apilog/storages

Request Parameters

None

Example Request

 GET /v2/apilog/storages

Response Parameters

Example Result

{
  "storages": [
    "Displays the UUID that corresponds to the registered storage."
  ]
}

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

POST /v2/apilog/storages

Request Parameters

AWS/wasabi

Azure

Example Request

 POST /v2/apilog/storages

AWS/wasabi

{
  "storageProvider": {
    "name": "wasabi",
    "accessKey":"KEY",
    "secretAccessKey":"SECRET",
    "endpoint": "EP",
    "bucket": "BUCKET"
  }
}

Azure

{
    "storageProvider": {
        "name": "azure",
        "connectionString": "CONNECTION_STRING",
        "containerName": "CONTAINER_NAME"
    }
}

Response Parameters

AWS/wasabi

Azure

Example Result

AWS/wasabi

{
  "storageProvider": {
    "name": "wasabi",
    "accessKey":"KEY",
    "secretAccessKey":"SECRET",
    "endpoint": "EP",
    "bucket": "BUCKET"
  },
  "storageUuid": "UUID"
}

Azure

{
    "storageProvider": {
        "name": "azure",
        "connectionString": "CONNECTION_STRING",
        "storageAccount": "STORAGE_ACCOUNT_NAME",
        "containerName": "CONTAINER_NAME"
    },
    "storageUuid": "STORAGE_UUID"
}

API利用履歴 - ストレージ情報検索

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

Request Parameters

None

Example Request

 GET /v2/apilog/storages/uuid

Response Parameters

AWS/wasabi

Azure

Example Result

AWS/wasabi

{
  "id": "uuid",
  "name": "wasabi",
  "endpoint": "EP",
  "bucket": "BUCKET",
  "status": "activated"
}

Azure

{
  "id": "uuid",
  "name": "azure",
  "storageAccount": "STORAGE_ACCOUNT_NAME",
  "containerName": "CONTAINER_NAME",
  "status": "activated"
}

API利用履歴 - ストレージ情報変更

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

Request Parameters

Example Request

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

Response Parameters

AWS/wasabi

Azure

Example Result

AWS/wasabi

{
  "id": "registered storage UUID",
  "name": "AWS",
  "endpoint": "ap-northeast-1",
  "bucket": "apilog",
  "status": "activated"
}

Azure

{
  "id": "uuid",
  "name": "azure",
  "storageAccount": "STORAGE_ACCOUNT_NAME",
  "containerName": "CONTAINER_NAME",
  "status": "activated"
}

API使用履歴 - ストレージ情報削除

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

Request Parameters

None

Example Request

 DELETE /v2/apilog/storages/uuid

Response Parameters

None

Example Result

None

API使用履歴 - ストレージ接続テスト

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

Request Parameters

None

Example Request

 POST /v2/apilog/storages/uuid/validate

Response Parameters

Example Result

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