移動

• リクエスト
• レスポンス
• 例

監査ログ情報の取得

get

/console/admin/api/v2/dashboard/statistics/auditlog

監査ログには、チャネル、組織、ノードおよびチェーンコードに関連するアクションなど、インスタンスの管理コンソール・アクティビティが記録されます。

リクエスト

サポートされるメディア・タイプ

• application/json

問合せパラメータ

• action: string
  返される監査ログ・アクションの名前
• endTime(必須): string
  'yyyyMMddhhmmss'形式の時間範囲の終了時間
• limit: number
  返されるログ・エントリの最大数。指定しない場合、デフォルトは100で、これはパラメータの最大許容値でもあります。
• offset: number
  スキップするログ・エントリの数
• startTime(必須): string
  'yyyyMMddhhmmss'形式の時間範囲の開始時間
• userIdentity: string
  ユーザー・アイデンティティ

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

制約の結果の一連の監査ログを含むレスポンス。

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• data: object StatsAuditLog

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/StatsAuditLog"
        }
    }
}

ネストしたスキーマ: StatsAuditLog

型: object

ソースの表示

• auditLogs: array auditLogs
• limit: number
• offset: number
• total: number

{
    "type":"object",
    "properties":{
        "total":{
            "type":"number"
        },
        "limit":{
            "type":"number"
        },
        "offset":{
            "type":"number"
        },
        "auditLogs":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

ネストしたスキーマ: auditLogs

型: array

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

ネストしたスキーマ: items

型: object

400レスポンス

無効な引数

本文()

ルート・スキーマ: 400errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

例:

{
    "respMesg":"invalid argument"
}

デフォルト・レスポンス

予期しないエラー

本文()

ルート・スキーマ: errorModel

型: object

ソースの表示

• code(必須): integer(int32)
• message(必須): string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る

例

このエンドポイントは、チャネル、組織、ノードおよびチェーンコードに関連するアクションを含む管理コンソール・アクティビティを記録するインスタンス監査ログを取得するために使用されます。action、userIdentity、limitおよびoffsetパラメータは、エンドポイントの動作に影響します。結果は、指定した時間範囲内の指定したスコープの一連の監査ログ・エントリを含むJSON本文です。

次の例は、cURLを使用してRESTリソースにGETリクエストを送信し、監査ログを取得する方法を示しています。

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v2/dashboard/statistics/auditlog?startTime=<yyyymmddhhmmss>&endTime=<yyyymmddhhmmss>"

たとえば、

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v2/dashboard/statistics/auditlog?limit=50&offset=10&startTime=20210811050000&endTime=20210812050000"

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
  "limit": 50,
  "offset": 10,
  "count": 2,
  "auditLog": [
    {
      "TimeStamp": "2021-08-12 00:05:22.553",
      "UserIdentity": "[e-mail]",
      "Component": "CONSOLE",
      "ComponentID": "console-1",
      "Severity":"Informative",
      "Action": "Start Peer",
      "ActionStatus": "Succeeded",
      "Details": "Start Peer(peer1) successfully"
    },
    {
      "TimeStamp": "2021-08-12 00:05:25.553",
      "UserIdentity": "[e-mail]",
      "Component": "CONSOLE",
      "ComponentID": "console-1",
      "Severity":"Informative",
      "Action": "Start Peer",
      "ActionStatus": "Succeeded",
      "Details": "Start Peer(peer2) successfully"
    }
  ]
}

先頭に戻る