Oracle Enterprise ManagerのREST API

パブリック配信不可: 2025-05-14

IDによるインシデントの検索

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/incidents/{incidentId}

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

リクエスト

パス・パラメータ

incidentId(必須): string(raw)

インシデントのID

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

操作成功 - インシデント詳細をフェッチする

ルート・スキーマ: Incident

インシデントの詳細

すべてに一致

インシデントの詳細

ソースの表示

object IncidentSummary

インシデントのサマリー
object Incident-allOf[1]

{
    "description":"Details of an incident",
    "allOf":[
        {
            "$ref":"#/components/schemas/IncidentSummary"
        },
        {
            "type":"object",
            "properties":{
                "previousSeverity":{
                    "$ref":"#/components/schemas/Severity"
                },
                "eventsCount":{
                    "type":"integer",
                    "description":"Count of the related events",
                    "format":"int32",
                    "example":1
                },
                "symptomEventsCount":{
                    "type":"integer",
                    "description":"Count of the related symptom events",
                    "format":"int32"
                },
                "causeEventsCount":{
                    "type":"integer",
                    "description":"Count of the related cause events",
                    "format":"int32"
                },
                "compressionAttributes":{
                    "minItems":0,
                    "type":"string",
                    "description":"List of event attributes used to group the events into this incident"
                },
                "diagnosticIncidentDetails":{
                    "$ref":"#/components/schemas/DiagnosticIncidentDetails"
                },
                "firstEventId":{
                    "type":"string",
                    "description":"ID of the first event for the incident",
                    "format":"raw",
                    "example":"C8141C5FCFBA348CE053860E4B6407E8"
                }
            }
        }
    ]
}

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

型: object

インシデントのサマリー

ソースの表示

ageInHours: integer (int64)

読取り専用: true

インシデント経過期間

例: 855
canBeManuallyClosed: boolean

デフォルト値: false

ユーザーがそのインシデントをクリアできるかどうか。

例: true
displayId(必須): integer (int64)

読取り専用: true

インシデントの表示ID

例: 35
escalationLevel: object EscalationLevel

エスカレーション・レベルの詳細
id(必須): string (raw)

読取り専用: true

インシデントのID

例: C4E214A1172A2F19E053860E4B645AC7
isDiagnosticIncident: boolean

デフォルト値: false

自動診断リポジトリ(ADR)のインシデントかどうか。

例: false
isEscalated: boolean

そのインシデントがエスカレートされるかどうか。

例: true
isOpen(必須): boolean

そのインシデントがオープンされているかどうか。

例: true
links: object links

読取り専用: true

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

インシデントのメッセージ

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

最小アイテム数: 0

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

このインシデントの影響を受けるターゲット以外のエンティティ(ジョブなど)
owner: string

インシデントの現在の所有者

例: SYSMAN
priority: object Priority

優先度の詳細
severity(必須): string

読取り専用: true

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

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

例: CRITICAL
status(必須): string

インシデントの現在のステータス

例: new
suppressionStatus: object SuppressionStatus

抑止ステータスの詳細
targets: array targets

最小アイテム数: 0

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

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

読取り専用: true

チケットの詳細
timeCreated(required): string (日時)

読取り専用: true

インシデントが作成された時間

例: 2021-06-16T12:17:56.000Z
timeUpdated(required): string (日時)

読取り専用: true

インシデントが更新された時間

例: 2021-07-22T06:25:42.000Z

{
    "required":[
        "displayId",
        "id",
        "isOpen",
        "message",
        "severity",
        "status",
        "timeCreated",
        "timeUpdated"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the incident",
            "format":"raw",
            "readOnly":true,
            "example":"C4E214A1172A2F19E053860E4B645AC7"
        },
        "displayId":{
            "type":"integer",
            "description":"Display ID of the incident",
            "format":"int64",
            "readOnly":true,
            "example":35
        },
        "message":{
            "type":"string",
            "description":"Message of the incident",
            "example":"CPU Utilization is 10.821%, crossed warning (5) or critical (10) threshold."
        },
        "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 (jobs, etc.) other than targets which are affected by this incident",
            "items":{
                "$ref":"#/components/schemas/SourceEntity"
            }
        },
        "timeCreated":{
            "type":"string",
            "description":"Time when incident is created",
            "format":"date-time",
            "readOnly":true,
            "example":"2021-06-16T12:17:56.000Z"
        },
        "timeUpdated":{
            "type":"string",
            "description":"Time when incident is updated",
            "format":"date-time",
            "readOnly":true,
            "example":"2021-07-22T06:25:42.000Z"
        },
        "ageInHours":{
            "type":"integer",
            "description":"Incident age in hours",
            "format":"int64",
            "readOnly":true,
            "example":855
        },
        "isOpen":{
            "type":"boolean",
            "description":"Is the incident open?",
            "example":true
        },
        "status":{
            "type":"string",
            "description":"Current status of the incident",
            "example":"new"
        },
        "owner":{
            "type":"string",
            "description":"Current owner of the incident",
            "example":"SYSMAN"
        },
        "isEscalated":{
            "type":"boolean",
            "description":"Is the incident escalated?",
            "example":true
        },
        "escalationLevel":{
            "$ref":"#/components/schemas/EscalationLevel"
        },
        "priority":{
            "$ref":"#/components/schemas/Priority"
        },
        "suppressionStatus":{
            "$ref":"#/components/schemas/SuppressionStatus"
        },
        "severity":{
            "$ref":"#/components/schemas/Severity"
        },
        "canBeManuallyClosed":{
            "type":"boolean",
            "description":"Can the incident be cleared by user?",
            "example":true,
            "default":false
        },
        "ticket":{
            "$ref":"#/components/schemas/TicketSummary"
        },
        "isDiagnosticIncident":{
            "type":"boolean",
            "description":"Is it a Automatic Diagnostic Repository (ADR) incident?",
            "example":false,
            "default":false
        },
        "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/incidents/C4E214A1172A2F19E053860E4B645AC7"
                }
            }
        }
    },
    "description":"Summary of an incident"
}

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

型: object

ソースの表示

causeEventsCount: integer (int32)

関連する原因イベントの件数
compressionAttributes: string

このインシデントへのイベントのグループ化に使用されているイベント属性のリスト
diagnosticIncidentDetails: object DiagnosticIncidentDetails

診断インシデントの詳細
eventsCount: integer (int32)

関連イベントの件数

例: 1
firstEventId: string (raw)

そのインシデントの最初のイベントのID

例: C8141C5FCFBA348CE053860E4B6407E8
previousSeverity: string

読取り専用: true

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

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

例: CRITICAL
symptomEventsCount: integer (int32)

関連する兆候イベントの件数

{
    "type":"object",
    "properties":{
        "previousSeverity":{
            "$ref":"#/components/schemas/Severity"
        },
        "eventsCount":{
            "type":"integer",
            "description":"Count of the related events",
            "format":"int32",
            "example":1
        },
        "symptomEventsCount":{
            "type":"integer",
            "description":"Count of the related symptom events",
            "format":"int32"
        },
        "causeEventsCount":{
            "type":"integer",
            "description":"Count of the related cause events",
            "format":"int32"
        },
        "compressionAttributes":{
            "minItems":0,
            "type":"string",
            "description":"List of event attributes used to group the events into this incident"
        },
        "diagnosticIncidentDetails":{
            "$ref":"#/components/schemas/DiagnosticIncidentDetails"
        },
        "firstEventId":{
            "type":"string",
            "description":"ID of the first event for the incident",
            "format":"raw",
            "example":"C8141C5FCFBA348CE053860E4B6407E8"
        }
    }
}

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

型: object

エスカレーション・レベルの詳細

ソースの表示

displayName: string

エスカレーション・レベルの表示名

例: None
name(必須): string

読取り専用: true

指定可能な値: [ "NONE", "L1", "L2", "L3", "L4", "L5" ]

サポートされているエスカレーション・レベル・リスト

例: NONE

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "$ref":"#/components/schemas/EscalationLevels"
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the escalation level",
            "example":"None"
        }
    },
    "description":"Details of an escalation level"
}

ネストされたスキーマ: 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/incidents/C4E214A1172A2F19E053860E4B645AC7"
        }
    }
}

例:

{
    "self":{
        "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7"
    }
}

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

型: array

最小アイテム数: 0

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

このインシデントの影響を受けるターゲット以外のエンティティ(ジョブなど)

ソースの表示

配列: object SourceEntity

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

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

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

型: object

優先度の詳細

ソースの表示

displayName: string

読取り専用: true

優先度の表示ラベル

例: None
name(必須): string

優先度の内部名

例: PRIORITY_NONE

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Internal name for the priority",
            "example":"PRIORITY_NONE"
        },
        "displayName":{
            "type":"string",
            "description":"Display label for the priority",
            "readOnly":true,
            "example":"None"
        }
    },
    "description":"Details of an priority"
}

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

型: object

抑止ステータスの詳細

ソースの表示

isSuppressed(必須): boolean

デフォルト値: false

抑止が有効になっているかどうか。
suppressUntil: string

指定可能な値: [ "MANUALLY_UNSUPPRESSED", "INCIDENT_CLOSES", "INCIDENT_SEVERITY_CHANGES", "AFTER_A_DAY", "AFTER_A_WEEK", "AFTER_DATE" ]

抑止タイプ
timeToEndSuppression: string (date-time)

抑止終了時間

{
    "required":[
        "isSuppressed"
    ],
    "type":"object",
    "properties":{
        "isSuppressed":{
            "type":"boolean",
            "description":"Is the supression enabled?",
            "default":false
        },
        "suppressUntil":{
            "type":"string",
            "description":"Supression type",
            "enum":[
                "MANUALLY_UNSUPPRESSED",
                "INCIDENT_CLOSES",
                "INCIDENT_SEVERITY_CHANGES",
                "AFTER_A_DAY",
                "AFTER_A_WEEK",
                "AFTER_DATE"
            ]
        },
        "timeToEndSuppression":{
            "type":"string",
            "description":"Supression end time",
            "format":"date-time"
        }
    },
    "description":"Details of an suppression status"
}

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

型: array

最小アイテム数: 0

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

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

ソースの表示

配列: object schema

ターゲットの詳細

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

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

型: object

読取り専用: true

チケットの詳細

ソースの表示

id: string

読取り専用: true

チケットのID

例: 51d62b6cd1384ba89aeddfa647ea1380
status: string

チケットのステータス

例: Triggered
type: string

チケットのタイプ

例: TICKET
url: string

チケットのURL

例: https://api.pagerduty.com/incidents?incident_key=F746283FHDKC

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the ticket",
            "readOnly":true,
            "example":"51d62b6cd1384ba89aeddfa647ea1380"
        },
        "status":{
            "type":"string",
            "description":"Status of the ticket",
            "example":"Triggered"
        },
        "type":{
            "type":"string",
            "description":"Type of the ticket",
            "example":"TICKET"
        },
        "url":{
            "type":"string",
            "description":"URL of the ticket",
            "example":"https://api.pagerduty.com/incidents?incident_key=F746283FHDKC"
        }
    },
    "description":"Details of the ticket",
    "readOnly":true
}

ネストされたスキーマ: 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"
        }
    }
}

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

型: object

診断インシデントの詳細

ソースの表示

executionContextId: string

Oracle Automatic Diagnosticインシデントに対して提供された、オプションの実行識別子(ECID)。
problemDisplayId: integer (int32)

すべてのOracle Automatic Diagnosticインシデントが1つの問題にグループ化されます。これはその問題の、ユーザーに表示される識別子です。

例: 29
problemId: string (raw)

すべてのOracle Automatic Diagnosticインシデントが1つの問題にグループ化されます。これはその問題の、問合せ可能な識別子です。

例: C4E06BA0653225EDE053860E4B6450BC

{
    "type":"object",
    "properties":{
        "problemDisplayId":{
            "type":"integer",
            "description":"All Oracle Automatic Diagnostic Incidents are grouped into a problem. This is the user visible identifier of the problem.",
            "format":"int32",
            "example":29
        },
        "problemId":{
            "type":"string",
            "description":"All Oracle Automatic Diagnostic Incidents are grouped into a problem. This is the queryable identifier of the problem.",
            "format":"raw",
            "example":"C4E06BA0653225EDE053860E4B6450BC"
        },
        "executionContextId":{
            "type":"string",
            "description":"Optional execution identified (ECID) provided for Oracle Automatic Diagnostic Incidents."
        }
    },
    "description":"Details of diagnostic incident"
}

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"
        }
    }
}

先頭に戻る