APILog API

Overview

本APIは、各種APIの利用履歴を取得するAPIです。セキュリティの分析、リソース変更のトレース、お客さまのコンプライアンスマネジメントを支援します。

Resource URL

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

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

1.Base Path(Global Load Balance)

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

2.Base Path(Region)

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

Resource Information

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

API利用履歴参照

GET /v1/apilog

Request Parameters

Name Description type mandatory
targetDate 利用履歴を取得する年月日を指定#1 query argument Yes
  • #1 YYYYMMDD形式

Example Request

 GET /v1/apilog?targetDate=20150401

Response Parameters

Name Description type mandatory
eventVersion ログイベント形式のバージョン String
userIdentity type ユーザータイプ String
accountId アカウントID String
accessKeyId アクセスキーID String
userName ユーザー名 String
eventTime リクエスト日時(UTC形式) String
eventSource リクエスト先のサービス String
verb REST API method String
region レスポンス元のAPIGWのregion String
sourceIPAddress リクエスト元のグローバルIPアドレス String
userAgent UserAgent String
errorCode エラーコード String
errorMessage エラーメッセージ String
requestQueryParameters リクエスト時のクエリパラメータ String
requestParameters リクエスト時のペイロードデータ String
responseElements レスポンスデータ String

Example Result

{
  "resultCount": 2,
  "Records": [
    {
      "Record": {
        "eventVersion": "v1",
        "userIdentity": {
          "type": "client_credentials",
          "accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
          "accessKeyId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "username": "apitestuser@ntt.com"
        },
        "eventTime": "2015-03-31T12:13:14+00:00",
        "eventSource": "/v1/business-process/contracts",
        "verb": "GET",
        "region": "dc-1",
        "sourceIPAddress": "173.194.38.216",
        "userAgent": "HTTPie/0.8.0",
        "errorCode": "",
        "errorMessage": "",
        "requestQueryParameters": "",
        "requestParameters": "",
        "responseElements": {…}
      }
    },
    {
      "Record": {
        "eventVersion": "v1",
        "userIdentity": {
          "type": "client_credentials",
          "accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
          "accessKeyId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "username": "apitestuser@ntt.com"
        },
        "eventTime": "2015-03-31T13:14:15+00:00",
        "eventSource": "/v1/business-process/contracts",
        "verb": "GET",
        "region": "dc-1",
        "sourceIPAddress": "173.194.38.216",
        "userAgent": "HTTPie/0.8.0",
        "errorCode": "",
        "errorMessage": "",
        "requestQueryParameters": "",
        "requestParameters": "",
        "responseElements": {…}
      }
    }
  ]
}

  1. 2014/12現在、DNSラウンドロビン運用。準備出来次第、お客さまの地理的に近いAPIゲートウェイに自動接続予定です。別途アナウンスします。