イベント履歴の照会
- 印刷する
- 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" ]
}
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
offset | Long | Optional | 照会対象のデータリストからスタートする位置
|
level | List<String> | Optional | 発生イベントのレベル
|
limit | Long | Optional | 一度に照会するデータ数
|
timeZone | String | Required | タイムゾーン(+09:00) |
from | String | Required | 照会開始日(yyyy-MM-dd) |
to | String | Required | 照会終了日(yyyy-MM-dd) |
type | List<String> | Optional | 発生イベントタイプ
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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
}
}
この記事は役に立ちましたか?