イベント履歴の照会
    • PDF

    イベント履歴の照会

    • PDF

    記事の要約

    Classic/VPC環境で利用できます。

    APIのイベント履歴を照会します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    POST/dashboards/events/search

    リクエストヘッダ

    API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

    リクエスト構文

    リクエスト構文は次の通りです。

    {
      "offset" : 0,
      "level" : [ "level" ],
      "limit" : 0,
      "timeZone" : "timeZone",
      "from" : "from",
      "to" : "to",
      "type" : [ "type" ]
    }
    

    リクエストボディ

    リクエストボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    offsetLongOptional照会対象のデータリストからスタートする位置
    • 0~9,223,372,036,854,775,807
    levelList<String>Optional発生イベントのレベル
    • EVENT | ALARM | ALERT
      • EVENT: イベント
      • ALARM: アラーム
      • ALERT: 警告
    • コレクションのアイテムは nullであってはいけない
    limitLongOptional一度に照会するデータ数
    • 1~9,223,372,036,854,775,807
    timeZoneStringRequiredタイムゾーン(+09:00)
    fromStringRequired照会開始日(yyyy-MM-dd)
    toStringRequired照会終了日(yyyy-MM-dd)
    typeList<String>Optional発生イベントタイプ
    • ES010 | ES020 | EU400 | EU410 | EU420
      • ES010: サブスクリプションリクエスト(Subscription Request)
      • ES020: サブスクリプション状態変更(Change Subscription's Status)
      • EU400: 使用量超過(Exceeded Quota)
      • EU410: 1秒当たりのリクエスト数超過(Exceeded Throttle)
      • EU420: 1秒当たりの使用量超過(Exceeded Rate)
    • コレクションのアイテムは nullであってはいけない

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/events/search \
    --header 'Content-Type: application/json' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    --data '{
      "offset" : 6,
      "level" : [ "EVENT" ],
      "limit" : 1,
      "timeZone" : "timeZone",
      "from" : "from",
      "to" : "to",
      "type" : [ "ES020" ]
    }
    

    レスポンス

    レスポンス形式を説明します。

    レスポンス構文

    構文は次の通りです。

    {
        "events": {
            "content": [
                {
                    "time": "2024-05-08 13:45:58",
                    "level": "level",
                    "type": "type",
                    "message": "message"
                }
            ],
            "total": 0
        }
    }
    

    レスポンスステータスコード

    API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
        "events": {
            "content": [
                {
                    "time": "2024-05-08 13:45:58",
                    "level": "EVENT",
                    "type": "ES020",
                    "message": "The status of subscription request for [test-***] requested by [apiKey-***] has been changed to [Accepted]."
                }
            ],
            "total": 1
        }
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.