Oracle Enterprise ManagerのREST API

イベントの詳細の取得

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/events/{eventId}

IDに一致するイベントの詳細を取得します

リクエスト

パス・パラメータ

eventId(必須): string(raw)

イベントのID

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

application/json

200レスポンス

操作成功

ルート・スキーマ: Event

イベントの詳細

すべてに一致

ソースの表示

object EventSummary

イベントのサマリー
object Event-allOf[1]

{
    "description":"Details of an event",
    "allOf":[
        {
            "$ref":"#/components/schemas/EventSummary"
        },
        {
            "type":"object",
            "properties":{
                "rootCauseAnalysisOutcome":{
                    "type":"string",
                    "description":"Root-cause-analysis outcome - Cause, Symptom or None",
                    "enum":[
                        "CAUSE",
                        "SYSMPTOM",
                        "NONE"
                    ]
                },
                "properties":{
                    "type":"array",
                    "description":"List of properties for an event",
                    "items":{
                        "$ref":"#/components/schemas/Property"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ: EventSummary

型: object

イベントのサマリー

ソースの表示

associatedIncidentId: string (raw)

読取り専用: true

関連するインシデントのID

例: C4E214A1172A2F19E053860E4B645AC7
canBeManuallyClosed: boolean

デフォルト値: false

ユーザーがこのイベントをクリアできるかどうか。

例: true
isOpen(必須): boolean

イベントがオープンされているかどうか。

例: true
links: object links

読取り専用: true

リソースの詳細に含まれているURLリンク。
message(必須): string

イベントのメッセージ

例: CPU使用率は10.821%で、警告(5)またはクリティカル(10)のしきい値を超えています
name: string

イベントの名前。

例: Load:cpuUtil
nonTargetEntities: array nonTargetEntities

最小アイテム数: 0

一意のアイテムが必要: true

このイベントの影響を受けるターゲット以外のエンティティ
sequenceId(必須): string (raw)

読取り専用: true

イベントのID

例: C4E06BD206B62AB3E053860E4B64C911
severity(必須): string

読取り専用: true

指定可能な値: [ "FATAL", "CRITICAL", "WARNING", "MINOR_WARNING", "CLEAR" ]

サポートされている重大度リスト

例: CRITICAL
targets: array targets

最小アイテム数: 0

一意のアイテムが必要: true

このインシデントの影響を受けるターゲット
timeCreated(required): string (日時)

読取り専用: true

イベントが作成された時間

例: 2021-07-20T16:47:56.000Z
timeUpdated(required): string (日時)

読取り専用: true

イベントの最終更新時間

例: 2021-07-21T06:25:43.000Z
typeDisplayName: string

イベント・タイプの表示名

例: Metric Alert
typeName: string

イベントのタイプ

例: metric_alert

{
    "required":[
        "isOpen",
        "message",
        "sequenceId",
        "severity",
        "timeCreated",
        "timeUpdated"
    ],
    "type":"object",
    "properties":{
        "sequenceId":{
            "type":"string",
            "description":"ID of the event",
            "format":"raw",
            "readOnly":true,
            "example":"C4E06BD206B62AB3E053860E4B64C911"
        },
        "name":{
            "type":"string",
            "description":"Name of the event",
            "example":"Load:cpuUtil"
        },
        "message":{
            "type":"string",
            "description":"Message of the event",
            "example":"CPU Utilization is 10.821%, crossed warning (5) or critical (10) threshold."
        },
        "typeName":{
            "type":"string",
            "description":"Type of the event",
            "example":"metric_alert"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Display name of the event type",
            "example":"Metric Alert"
        },
        "targets":{
            "minItems":"0",
            "uniqueItems":true,
            "type":"array",
            "description":"Targets affected by this incident",
            "items":{
                "$ref":"#/components/schemas/Target"
            }
        },
        "nonTargetEntities":{
            "minItems":"0",
            "uniqueItems":true,
            "type":"array",
            "description":"Entities other than targets which are affected by this event",
            "items":{
                "$ref":"#/components/schemas/SourceEntity"
            }
        },
        "timeCreated":{
            "type":"string",
            "description":"Time when the event is created",
            "format":"date-time",
            "readOnly":true,
            "example":"2021-07-20T16:47:56.000Z"
        },
        "timeUpdated":{
            "type":"string",
            "description":"Time when the event is last updated",
            "format":"date-time",
            "readOnly":true,
            "example":"2021-07-21T06:25:43.000Z"
        },
        "isOpen":{
            "type":"boolean",
            "description":"Is the event open?",
            "example":true
        },
        "severity":{
            "$ref":"#/components/schemas/Severity"
        },
        "canBeManuallyClosed":{
            "type":"boolean",
            "description":"Can a user clear this event?",
            "example":true,
            "default":false
        },
        "associatedIncidentId":{
            "type":"string",
            "description":"ID of the associated incident",
            "format":"raw",
            "readOnly":true,
            "example":"C4E214A1172A2F19E053860E4B645AC7"
        },
        "links":{
            "required":[
                "self"
            ],
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"URL links inside details of resource.",
            "readOnly":true,
            "example":{
                "self":{
                    "href":"/em/api/events/C4E06BD206B62AB3E053860E4B64C911"
                }
            }
        }
    },
    "description":"Summary of an event"
}

ネストされたスキーマ: Event-allOf[1]

型: object

ソースの表示

properties: array properties

イベントのプロパティのリスト
rootCauseAnalysisOutcome: string

指定可能な値: [ "CAUSE", "SYSMPTOM", "NONE" ]

根本原因分析の結果 - 「原因」、「兆候」または「なし」

{
    "type":"object",
    "properties":{
        "rootCauseAnalysisOutcome":{
            "type":"string",
            "description":"Root-cause-analysis outcome - Cause, Symptom or None",
            "enum":[
                "CAUSE",
                "SYSMPTOM",
                "NONE"
            ]
        },
        "properties":{
            "type":"array",
            "description":"List of properties for an event",
            "items":{
                "$ref":"#/components/schemas/Property"
            }
        }
    }
}

ネストされたスキーマ: links

型: object

読取り専用: true

リソースの詳細に含まれているURLリンク。

ソースの表示

self(必須): object Link

リンクを表します(self、previous、nextのいずれか)

{
    "required":[
        "self"
    ],
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"URL links inside details of resource.",
    "readOnly":true,
    "example":{
        "self":{
            "href":"/em/api/events/C4E06BD206B62AB3E053860E4B64C911"
        }
    }
}

例:

{
    "self":{
        "href":"/em/api/events/C4E06BD206B62AB3E053860E4B64C911"
    }
}

ネストされたスキーマ: nonTargetEntities

型: array

最小アイテム数: 0

一意のアイテムが必要: true

このイベントの影響を受けるターゲット以外のエンティティ

ソースの表示

配列: object SourceEntity

ソース・エンティティの詳細

{
    "minItems":"0",
    "uniqueItems":true,
    "type":"array",
    "description":"Entities other than targets which are affected by this event",
    "items":{
        "$ref":"#/components/schemas/SourceEntity"
    }
}

ネストされたスキーマ: targets

型: array

最小アイテム数: 0

一意のアイテムが必要: true

このインシデントの影響を受けるターゲット

ソースの表示

配列: object schema

ターゲットの詳細

{
    "minItems":"0",
    "uniqueItems":true,
    "type":"array",
    "description":"Targets affected by this incident",
    "items":{
        "$ref":"#/components/schemas/Target"
    }
}

ネストされたスキーマ: Link

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

href: string

リンクのためのURL

例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

ネストされたスキーマ: SourceEntity

型: object

ソース・エンティティの詳細

ソースの表示

id(必須): string (raw)

エンティティのID

例: 317C6AD6C69832D0ADDA279BEB7B7F32
name(必須): string

エンティティの名前

例: bkupjob-123456
subTypeDisplayName: string

エンティティ・タイプのサブ・タイプの表示名

例: Database backup job
subTypeName: string

エンティティ・タイプのサブタイプ

例: DBBackupJob
typeDisplayName: string

エンティティ・タイプの表示名

例: Job
typeName(必須): string

エンティティのタイプ

例: JOB

{
    "required":[
        "id",
        "name",
        "typeName"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the entity",
            "format":"raw",
            "example":"317C6AD6C69832D0ADDA279BEB7B7F32"
        },
        "name":{
            "type":"string",
            "description":"Name of the entity",
            "example":"bkupjob-123456"
        },
        "typeName":{
            "type":"string",
            "description":"Type of the entity",
            "example":"JOB"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Display name for the entity type",
            "example":"Job"
        },
        "subTypeName":{
            "type":"string",
            "description":"Sub type for an entity type",
            "example":"DBBackupJob"
        },
        "subTypeDisplayName":{
            "type":"string",
            "description":"Display name for sub type for an entity type",
            "example":"Database backup job"
        }
    },
    "description":"Details of an source entity"
}

ネストされたスキーマ: schema

型: object

ターゲットの詳細

ソースの表示

targetName: string

ターゲットの名前

例: sales_db1
targetType: string

ターゲットのタイプ

例: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

ネストされたスキーマ: properties

型: array

イベントのプロパティのリスト

ソースの表示

配列: オブジェクトプロパティ

一般プロパティ・レスポンス

{
    "type":"array",
    "description":"List of properties for an event",
    "items":{
        "$ref":"#/components/schemas/Property"
    }
}

ネストされたスキーマ: Property

型: object

一般プロパティ・レスポンス

ソースの表示

dataType: string

プロパティのデータ型

例: STRING
description: string

プロパティの説明

例: Type of the target
displayName(必須): string

プロパティの表示名

例: Target Type
displayValue: string

プロパティの表示値

例: Host
name(必須): string (raw)

読取り専用: true

プロパティの名前

例: ora_target_type
value: string

プロパティの値

例: host

{
    "required":[
        "displayName",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the property",
            "format":"raw",
            "readOnly":true,
            "example":"ora_target_type"
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the property",
            "example":"Target Type"
        },
        "description":{
            "type":"string",
            "description":"Description of the property",
            "example":"Type of the target"
        },
        "value":{
            "type":"string",
            "description":"Value of the property",
            "example":"host"
        },
        "displayValue":{
            "type":"string",
            "description":"Display value of the property",
            "example":"Host"
        },
        "dataType":{
            "type":"string",
            "description":"Data type of the property",
            "example":"STRING"
        }
    },
    "description":"Generic property response"
}

400レスポンス

不正なリクエスト

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

認証に失敗しました

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404レスポンス

見つかりません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

サービスを使用できません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る