ページの先頭行へ戻る
Cloud Storage Gateway V1.2.0 リファレンスガイド
FUJITSU Software
第1章 CSG REST API > 1.2 CSG REST API一覧 > 1.2.17 操作ログ
前次

1.2.17 操作ログ

1.2.17.1 GET /v1/log/audit_logs

機能

操作ログを一覧表示

処理概要

システムに対してユーザーが実行した操作の操作ログ情報が一覧表示されます。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

filter_cols

フィルターするカラム名を指定します。
“,”で連結して複数のカラムを指定することが可能です。
[例]
id,phase,action_result

任意

string

query

filter_vals

filter_colsで指定したカラム名に対して、指定順にフィルターの条件を指定します。
数値の場合、“~”で範囲を指定することが可能です。
[例]
50~*,Complete,Failed

任意

string

query

sort_cols

ソートするカラム名を指定します。
[例]
id,phase,action_result

任意

string

query

sort_vals

sort_colsで指定したカラム名に対して、指定順にソートの条件を指定します。

  • 昇順: asc

  • 降順: desc

[例]
asc,asc,desc

任意

string

query

show_cols

表示するカラム名を指定します。
[例]
id,phase,action_result

任意

string

query

hide_cols

非表示にするカラム名を指定します。
[例]
id,phase,action_result

任意

string

query

limit

表示する項目数を指定します。

任意

integer

query

offset

項目の表示開始位置を指定します。

任意

integer

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

表示

形式

列挙型定数

200

id

操作ログID

Yes

integer

request_id

リクエストID

No

integer

last_updated_at

最後更新日時
(iso8601の拡張形式
YYYY-MM-DDThh:mm:ss+hh:mm)

Yes

timestamp

submitted_at

操作実施日時
(iso8601の拡張形式
YYYY-MM-DDThh:mm:ss+hh:mm)

No

timestamp

started_at

処理開始日時
(iso8601の拡張形式
YYYY-MM-DDThh:mm:ss+hh:mm)

No

timestamp

completed_at

処理完了日時
(iso8601の拡張形式
YYYY-MM-DDThh:mm:ss+hh:mm)

No

timestamp

target_name

操作対象名

Yes

string

action

処理名

Yes

string

action_parameter

処理のパラメーター

Yes

string

user_name

ユーザー名

Yes

string

user_role

ユーザーロール

No

string

connection_source_ip_address

接続元IPアドレス

No

string

call_from

呼出し元

Yes

string

phase

処理の状態

Yes

enum

Submit:
Submit

Start:
Start

Complete:
Complete

action_result

処理の結果

Yes

enum

Success:
Success

Warning:
Warning

Failed:
Failed

message

メッセージ

Yes

string

confirmation

既読/未読の判別

  • true : 既読

  • false : 未読

Yes

boolean

1.2.17.2 GET /v1/log/audit_logs/{id}

機能

操作ログの詳細表示

処理概要

操作ログに記録されている各操作の詳細が表示されます。

確認したログは既読になります。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

操作ログのID

必須

integer

path

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

200

id

操作ログID

integer

request_id

リクエストID

integer

last_updated_at

最後更新日時
(iso8601の拡張形式
YYYY-MM-DDThh:mm:ss+hh:mm)

timestamp

submitted_at

操作実施日時
(iso8601の拡張形式
YYYY-MM-DDThh:mm:ss+hh:mm)

timestamp

started_at

処理開始日時
(iso8601の拡張形式
YYYY-MM-DDThh:mm:ss+hh:mm)

timestamp

completed_at

処理完了日時
(iso8601の拡張形式
YYYY-MM-DDThh:mm:ss+hh:mm)

timestamp

target_name

操作対象名

string

action

処理名

string

action_parameter

処理のパラメーター

string

user_name

ユーザー名

string

user_role

ユーザーロール

string

connection_source_ip_address

接続元IPアドレス

string

call_from

呼出し元

string

phase

処理の状態

enum

Submit:
Submit

Start:
Start

Complete:
Complete

action_result

処理の結果

enum

Success:
Success

Warning:
Warning

Failed:
Failed

message

メッセージ

string

confirmation

既読/未読の判別

  • true : 既読

  • false : 未読

boolean

1.2.17.3 GET /v1/log/audit_logs/download

機能

監査ログのダウンロード

処理概要

監査ログ(操作ログ、および、コンソールでのコマンド操作ログ)をダウンロードします。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

from_date

操作ログについて、ダウンロードの対象とする期間の開始日を指定します。(YYYYMMDDの形式で指定)

省略するとAPI実行日の31日前の0:00:00以降の操作ログをダウンロードします。

[例]
20180301

任意

string

query

to_date

操作ログについて、ダウンロードの対象とする期間の終了日を指定します。(YYYYMMDDの形式で指定)

省略するとAPI実行時点までの操作ログをダウンロードします。

[例]
20180301

任意

string

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

正常終了時はありません。

前次
Copyright FUJITSU LIMITED 2018-20