Auditlogs

Auditlogs は、操作ログやログインログを検索・参照する機能を提供します。

このAPIは管理コンソールが提供します。接続先ホストについては共通仕様を参照ください。

操作ログ・ログインログの保持期間は90日間です。これより古いログは参照できません。

list

Auditlogs/list は、操作ログ/ログインログを検索・参照する操作を提供します。

リクエスト

/transaction/v2/auditlogs/list.[json|xml]

アクセス制御

項目
ロール APIグループ管理者
権限 なし

パラメータ

パラメータ 必須 データ型 説明
api_user Yes ASCII ユーザ認証に使用するIDを指定します。
api_key Yes ASCII ユーザ認証に使用するシークレットキーを指定します。
type Yes ASCII 取得対象のログの種類を指定します。ログインログ:login、操作ログ:operation
account No ASCII 指定された文字列に部分一致するアカウントのログを検索します。
start_date No DATE 期間検索を行うために検索開始日(yyyy-mm-dd形式)を指定します。検索開始日は検索期間に含まれます。
制約:start_dateはend_dateと等しいか過去日を指定しなければなりません。検索期間は最大1ヶ月(31日)まで指定可能です。
デフォルト:APIを実行した日
end_date No DATE 期間検索を行うために検索終了日(yyyy-mm-dd形式)を指定します。検索終了日は検索期間に含まれます。
デフォルト:APIを実行した日
p No INTEGER 参照するページ位置を指定します。
デフォルト:0
r No INTEGER 1ページに表示するレコード数を指定します。
デフォルト:10

レスポンス

ログインログ

リクエストパラメータのtypeにloginを指定した場合、ログインログを以下のフォーマットで返します。

JSON

{
  "loginlogs": [
    {
      "account": "user@hennge.com",
      "code": "1",
      "created": "2019-06-12 12:10:55",
      "ipaddress": "10.0.24.10",
      "reason": "パスワード認証失敗",
      "result": "失敗"
    },
    {
      "account": "user@hennge.com",
      "code": "0",
      "created": "2019-06-12 12:11:46",
      "ipaddress": "10.0.2.24",
      "reason": "",
      "result": "成功"
    },
    {
      "account": "user@hennge.com",
      "code": "2",
      "created": "2019-06-12 12:31:05",
      "ipaddress": "",
      "reason": "",
      "result": "ログアウト"
    },
    ...
  ]
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loginlogs>
  <loginlog>
    <created>2019-06-12 12:10:55</created>
    <account>user@hennge.com</account>
    <ipaddress>10.0.24.10</ipaddress>
    <code>1</code>
    <result>失敗</result>
    <reason>パスワード認証失敗</reason>
  </loginlog>
  <loginlog>
    <created>2019-06-12 12:11:46</created>
    <account>user@hennge.com</account>
    <ipaddress>10.0.24.10</ipaddress>
    <code>0</code>
    <result>成功</result>
    <reason></reason>
  </loginlog>
  <loginlog>
    <created>2019-06-12 12:31:05</created>
    <account>user@hennge.com</account>
    <ipaddress></ipaddress>
    <code>2</code>
    <result>ログアウト</result>
    <reason></reason>
  </loginlog>
  ....
</loginlogs>
プロパティ 説明
created ログインログが記録された日時 (YYYY-MM-DD HH:MM:SS形式)
account ログインまたはログアウトを行ったユーザのアカウント
ipaddress ログイン時の接続元IPアドレス
code ログインログの種別コード。0:成功、1:失敗、2:ログアウト
result codeの表示名。成功、失敗、ログアウトのいずれか
reason ログイン失敗時のエラー理由

操作ログ

リクエストパラメータのtypeにoperationを指定した場合、操作ログを以下のフォーマットで返します。

JSON

{
  "operationlogs": [
    {
      "account": "apiadmin@hennge.com",
      "created": "2019-05-07 14:58:51",
      "function": "エラー詳細",
      "name": "APIグループ管理者",
      "operation": "sandbox をダウンロードしました。"
    },
    {
      "account": "user@hennge.com",
      "created": "2019-05-28 16:40:08",
      "function": "サーバ構成",
      "name": "グループ管理者",
      "operation": "sandbox/20190528-001を反映しました"
    },
    {
      "account": "user@hennge.com",
      "created": "2019-06-06 18:48:12",
      "function": "接続IP設定",
      "name": "グループ管理者",
      "operation": "CMC02071:10.0.2.24を登録しました"
    },
    ...
  ]
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operationlogs>
  <operationlog>
    <created>2019-05-07 14:58:51</created>
    <account>apiadmin@hennge.com</account>
    <name>APIグループ管理者</name>
    <function>エラー詳細</function>
    <operation>sandbox をダウンロードしました。</operation>
  </operationlog>
  <operationlog>
    <created>2019-05-28 16:40:08</created>
    <account>user@hennge.com</account>
    <name>グループ管理者</name>
    <function>サーバ構成</function>
    <operation>sandbox/20190528-001を反映しました</operation>
  </operationlog>
  <operationlog>
    <created>2019-06-06 18:48:12</created>
    <account>user@hennge.com</account>
    <name>グループ管理者</name>
    <function>接続IP設定</function>
    <operation>CMC02071:10.0.2.24を登録しました</operation>
  </operationlog>
  ....
</operationlogs>
プロパティ 説明
created 操作ログが記録された日時 (YYYY-MM-DD HH:MM:SS形式)
account 操作を行ったユーザのアカウント
name 操作を行ったユーザの氏名
function 操作した機能
operation 操作内容

エラーメッセージ

フィールド エラーコード メッセージ(en) メッセージ(ja)
type 14-001 The specified {0} type is not defined. 指定されたタイプ {0} は定義されていません。
start_date,end_date 14-002 Future date cannot be specified. 将来の日付は指定できません。
start_date 14-003 Please input 31 days or less to the search duration. 検索対象期間は31日以内で入力してください。
start_date 10-003 The start_date must be earlier than the end_date. 開始日には終了日以前の日付を指定してください。

download

Auditlogs/download は、操作ログやログインログを検索し、CSVファイル形式でダウンロードする操作を提供します。

リクエスト

/transaction/v2/auditlogs/download.[json|xml]

アクセス制御

項目
ロール APIグループ管理者
権限 ダウンロード許可

パラメータ

パラメータ 必須 データ型 説明
api_user Yes ASCII ユーザ認証に使用するIDを指定します。
api_key Yes ASCII ユーザ認証に使用するシークレットキーを指定します。
type Yes ASCII 取得対象のログの種類を指定します。ログインログ:login、操作ログ:operation
account No ASCII 指定された文字列に部分一致するアカウントのログを検索します。
start_date No DATE 期間検索を行うために検索開始日(yyyy-mm-dd形式)を指定します。検索開始日は検索期間に含まれます。
制約:start_dateはend_dateと等しいか過去日を指定しなければなりません。検索期間は最大1ヶ月(31日)まで指定可能です。
デフォルト:APIを実行した日
end_date No DATE 期間検索を行うために検索終了日(yyyy-mm-dd形式)を指定します。検索終了日は検索期間に含まれます。
デフォルト:APIを実行した日

レスポンス

リクエストが成功した場合、Content-Type に application/octet-stream を指定し、 CSVファイルをZIP圧縮してダウンロードします。 データ暗号化を設定している場合、パスワード付き暗号化ZIPファイルをダウンロードします。

ファイル名

auditlogs-yyyyMMdd_HHmmss.zip (例; auditlogs-20190612_175202.zip)

ログインログ

リクエストパラメータのtypeにloginを指定した場合、ログインログを以下のフォーマットで返します。

"created","account","ipaddress","code","result","reason"
"2019-06-12 12:10:55","user@hennge.com","10.0.24.10","1","失敗","パスワード認証失敗"
"2019-06-12 12:11:46","user@hennge.com","10.0.2.24","0","成功",""
"2019-06-12 12:31:05","user@hennge.com","","2","ログアウト",""
プロパティ 説明
created ログインログが記録された日時 (YYYY-MM-DD HH:MM:SS形式)
account ログインまたはログアウトを行ったユーザのアカウント
ipaddress ログイン時の接続元IPアドレス
code ログインログの種別コード。0:成功、1:失敗、2:ログアウト
result codeの表示名。成功、失敗、ログアウトのいずれか
reason ログイン失敗時のエラー理由

操作ログ

リクエストパラメータのtypeにoperationを指定した場合、操作ログを以下のフォーマットで返します。

"created","account","name","function","operation"
"2019-05-07 14:58:51","apiadmin@hennge.com","APIグループ管理者","エラー詳細","sandbox をダウンロードしました。"
"2019-05-28 16:40:08","user@hennge.com","グループ管理者","サーバ構成","sandbox/20190528-001を反映しました"
"2019-06-06 18:48:12","user@hennge.com","グループ管理者","接続IP設定","CMC02071:10.0.2.24を登録しました"
プロパティ 説明
created 操作ログが記録された日時 (YYYY-MM-DD HH:MM:SS形式)
account 操作を行ったユーザのアカウント
name 操作を行ったユーザの氏名
function 操作した機能
operation 操作内容

エラーメッセージ

フィールド エラーコード メッセージ(en) メッセージ(ja)
type 14-001 The specified {0} type is not defined. 指定されたタイプ {0} は定義されていません。
start_date,end_date 14-002 Future date cannot be specified. 将来の日付は指定できません。
start_date 14-003 Please input 31 days or less to the search duration. 検索対象期間は31日以内で入力してください。
start_date 10-003 The start_date must be earlier than the end_date. 開始日には終了日以前の日付を指定してください。