APILog API v2 | NTT Communications DeveloperPortal

Overview

本APIを利用することで、各APIの利用履歴を保存するために契約しているクラウドストレージを指定することができます。本APIで保存先を指定すると、APIをCALLしたユーザーのメールアドレスごとにログが抽出され、指定したクラウドストレージに保存されます。

ログを保存するクラウドストレージは、お客様ご自身でご用意いただく必要があります。Amazon S3、Wasabi、Azureが指定可能です。リソース変更のトレースなど、お客様のデータ管理を支援します。

※本サービスはログ転送を完全に保証するものではありません。

※転送先のストレージでの障害発生や設定したアカウントへの書込権限が無効化される等で転送に失敗した場合、システム保護のためAPIGWのアプリケーション側でストレージ情報を無効化して転送を停止する場合があります。
その場合、"API利用履歴 - ストレージ情報変更" のAPIを使ってストレージの転送を再度有効化してください。

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

Key	Value
レスポンスフォーマット	JSON
認証(OAuth)	Yes
帯域制御#1	Yes

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

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

GET /v2/apilog/storages

Request Parameters

None

Example Request

 GET /v2/apilog/storages

Response Parameters

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

Example Result

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

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

POST /v2/apilog/storages

Request Parameters

AWS/wasabi

Name	ParameterName	Description	type
storageProvider	-	転送先ストレージサービス	Dictionary
	name	ストレージサービス名	string("AWS","wasabi")
	accessKey	ストレージサービスアクセスキー	string
	secretAccessKey	ストレージサービスシークレットアクセスキー	string
	endpoint	ストレージサービスのエンドポイント	string
	bucket	ストレージサービスのバケット名	string

Azure

Name	ParameterName	Description	type
strorageProvider	-	転送先ストレージサービス	Dictionary
	name	ストレージサービス名	string("azure")
	connectionString	ストレージサービスの接続文字列	string
	containerName	ストレージサービスのコンテナ名	string

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

Name	ParameterName	Description	type
storageProvider	-	転送先ストレージサービス	Dictionary
	name	ストレージサービス名	string("AWS","wasabi")
	accessKey	ストレージサービスアクセスキー	string
	secretAccessKey	ストレージサービスシークレットアクセスキー	string
	endpoint	ストレージサービスのエンドポイント	string
	bucket	ストレージサービスのバケット名	string
storageUuid	-	登録済みストレージUUID	string

Azure

Name	ParameterName	Description	type
strorageProvider	-	転送先ストレージサービス	Dictionary
	name	ストレージサービス名	string("azure")
	connectionString	ストレージサービスの接続文字列	string
	storageAccount	ストレージサービスのリソース名	string
	containerName	ストレージサービスのコンテナ名	string
strorageUuid	-	登録済みストレージUUID	string

Example Result

{
  "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

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

Azure

Name	Description	type
id	登録されたストレージのUUID一覧	string
name	ストレージサービス名	string("azure")
storageAccount	ストレージサービスの接続文字列	string
containerName	ストレージサービスのコンテナ名	string
status	登録状況	string(activated,deactivated)

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 }}

※転送先のストレージでの障害発生や設定したアカウントへの書込権限が無効化される等で転送に失敗した場合、システム保護のためAPIGWのアプリケーション側でストレージ情報を無効化して転送を停止する場合があります。再度有効化するために、本APIを実行ください。

Request Parameters

Name	Description	type
uuid	登録されたストレージのUUID	string
activated	ステータス	query argument(true,false)

Example Request

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

Response Parameters

AWS/wasabi

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

Azure

Name	Description	type
id	登録されたストレージのUUID一覧	string
name	ストレージサービス名	string("azure")
storageAccount	ストレージサービスの接続文字列	string
containerName	ストレージサービスのコンテナ名	string
status	ステータス	string(activated,deactivated)

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

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

Example Result

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