POST accesslog_key

API情報

HTTPメソッドAPI名目的
POSTaccesslog_key

アクセスログダウンロード用URL発行

  • アクセスログダウンロード用のキー(DownloadKey)を発行します。

個別パラメータ

URL
  • なし
HTTPリクエストボディ
フィールドタイプ意味
BasicAuthString

Basic認証の利用 (on, off)

値: on, off

  • "on"に設定すると、 Basic認証用のパスワードを取得できます(Result.Password)。
MaxNumString

ダウンロード可能回数

  • 1~100
AclString

ダウンロードを許可するIPアドレス (IPアドレス, IPアドレス/ネットマスク)

  • 指定したIPアドレスからのアクセス時のみアクセスログがダウンロードができます。

レスポンス

フィールドタイプ意味
Result.DownloadUrlString

アクセスログをダウンロードするためのURL

値: https://"cac-front アドレス"/downloads/サービスコード/access_logs

  • IPv4のアクセスログをダウンロードする際は、以下のようにダウンロード用キー、ログの日付、URLスキームを指定する必要があります。
    https://help.cas.iijgio.jp/downloads/(サービスコード)/access_logs?download_key="ダウンロード用キー"&log_date="ログの日付 (YYYY-MM-DD)"&urlscheme="URL スキーム (http or https)"
  • 時間ごとのアクセスログをダウンロードする際は、以下のようにクエリパラメータに「&hour="(時間)"」を追加します。
    https://help.cas.iijgio.jp/downloads/(サービスコード)/access_logs?download_key="ダウンロード用キー"&log_date="ログの日付 (YYYY-MM-DD)"&hour="ログの時間 (HH)"&urlscheme="URL スキーム (http or https)"
  • IPv6のアクセスログをダウンロードする際は、以下のようにクエリパラメータに「&ip="v6"」を追加します。
    https://help.cas.iijgio.jp/downloads/(サービスコード)/access_logs?download_key="ダウンロード用キー"&log_date="ログの日付 (YYYY-MM-DD)"&urlscheme="URL スキーム (http or https)"&ip="v6" 
  • 移行先設備のアクセスログをダウンロードする際は、以下のようにクエリパラメータに「&type="v2"」を追加します。
    https://help.cas.iijgio.jp/downloads/(サービスコード)/access_logs?download_key="ダウンロード用キー"&log_date="ログの日付 (YYYY-MM-DD)"&urlscheme="URL スキーム (http or https)"&type="v2" 
  • 時間ごと、IPv6、移行先設備の指定は一度に設定可能です。必要に応じて、「&hour="(時間)"」、「&ip="v6"」、「&type="v2"」をそれぞれ追加してください。
    • 例)移行先設備のアクセスログで時間とIPv6を同時に指定したい場合は「&type="v2"」と「&hour="(時間)"」と「&ip="v6"」を追加します。
      https://help.cas.iijgio.jp/downloads/(サービスコード)/access_logs?download_key="ダウンロード用キー"&log_date="ログの日付 (YYYY-MM-DD)"&urlscheme="URL スキーム (http or https)"&type="v2"&hour="ログの時間 (HH)"&ip="v6" 
  • クエリパラメータに不正な値が指定された場合、"404 Illegal Argument" が返されます。
  • アクセスログが存在しない場合は、"404 Not Found" が返されます。
  • ダウンロードされたファイルは gzip 圧縮されています。
Result.DownloadKeyStringダウンロード用キー
Result.ExpireString

ダウンロード用キーの有効期限

  • 有効期限は発行から30分後です。 ダウンロード用キーの発行から30分以上経過すると、ダウンロード回数の上限に達しなくても、アクセスログがダウンロードできなくなります。
Result.MaxNumString

発行されたダウンロード用キーでアクセスログをダウンロードできる回数

  • 1~100
  • 標準では、最大20回までダウンロードできます。
Result.UserString

Basic認証用ID(サービスコード)

Result.PasswordString

Basic認証用パスワード

Result.AclString

ダウンロードが許可されたIPアドレス (IPアドレス, IPアドレス/ネットマスク)

  • 指定したIPアドレスからのアクセス時のみアクセスログがダウンロードができます。

エラーコード

  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照してください。

制限

  • なし

サンプル 

リクエスト 

POST /r/(APIVersion)/(ServiceCode)/accesslog_key.json
Host: cac.api.iij.jp
Content-Type: application/json
Date: Mon, 20 Jan 2014 12:34:56 GMT
x-iijapi-Expire: 2014-01-20T12:35:00Z
x-iijapi-SignatureMethod: (SignatureMethod)
x-iijapi-SignatureVersion: (SignatureVersion)
Authorization: IIJAPI (AccessKeyId):(Signature)

{
    "BasicAuth": "on",
    "MaxNum": "20",
    "Acl": "198.51.100.1"
}

レスポンスボディ

{
    "Result": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "ServiceCode": "cac########",
        "DownloadUrl": "https://help.cas.iijgio.jp/downloads/cac########/access_logs",
        "DownloadKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "Expire": "2014-06-03 00:30:00",
        "MaxNum": "20",
        "User": "cac########",
        "Password": "xxxxxxxxxxxxxx",
        "Acl": "198.51.100.1"
    }
}