移動先

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

インシデントのリストの取得

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/incidents

指定されたフィルタに基づいてインシデントのリストを返します。デフォルトでは、最も最近作成されたインシデントを先頭に示す、すべてのオープン・インシデントの最初のセットが返されます。

リクエスト

問合せパラメータ

• ageInHoursLessThanOrEqualTo: integer(int32)
  指定された日数より新しいインシデントを取得します

  デフォルト値: 744

  例:

  24

• includeMemberTargets: boolean
  指定されたターゲットのメンバーに関する一致するインシデントを含めます

  デフォルト値: true
• limit: integer(int32)
  現在のコールで返されるアイテムの数を制限します。アイテムを追加でフェッチするには、レスポンスからのself/previous/nextリンクを使用します。

  デフォルト値: 50
• page: string
  取得するアイテムのセットを特定します。レスポンスのlinksリストのhref要素により、このパラメータのエンコードされた値が提供されます。href要素の値は、それぞれのアイテム・セットをフェッチする場合はそのまま使用する必要があります。

  デフォルト値: Base64エンコード値0 つまり、MA==
• severity: array[]
  指定された重大度でフィルタします
• sort: string
  id、displayId、timeCreated、timeUpdated、statusおよびownerなどの属性で結果をソートします

  例:

  displayId:ASC,timeUpdated:DESC

• targetName: string
  特定のターゲット名でフィルタします。
• targetTypeName: string
  特定のターゲット・タイプでフィルタします。

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

操作成功 - インシデント・リストをフェッチする

本文()

ルート・スキーマ: IncidentCollection

インシデント・サマリーのリスト

すべてに一致

ソースの表示

• object ListRspns
  一般リスト・レスポンス・ラッパー
• object IncidentCollection-allOf[1]

{
    "description":"List of incident summary",
    "allOf":[
        {
            "$ref":"#/components/schemas/ListRspns"
        },
        {
            "required":[
                "items"
            ],
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of the incident summary",
                    "items":{
                        "$ref":"#/components/schemas/IncidentSummary"
                    }
                }
            }
        }
    ]
}

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

型: object

一般リスト・レスポンス・ラッパー

ソースの表示

• count(必須): integer (int32)
  戻される行の数

  例: 1
• links: object links
  読取り専用: true

  ページ分割されたリソースへのURLリンク。

{
    "required":[
        "count"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of rows returned",
            "format":"int32",
            "example":"1"
        },
        "links":{
            "required":[
                "self"
            ],
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"URL links to paginated resource(s).",
            "readOnly":true,
            "example":{
                "self":{
                    "href":"/em/api/incidents?page=MQ%3D%3D&limit=50"
                },
                "next":{
                    "href":"/em/api/incidents?page=Mg%3D%3D&limit=50"
                },
                "previous":{
                    "href":"/em/api/incidents?page=MA%3D%3D&limit=50"
                }
            }
        }
    },
    "description":"Generic list response wrapper"
}

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

型: object

ソースの表示

• items(必須): array items
  インシデント・サマリーのリスト

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of the incident summary",
            "items":{
                "$ref":"#/components/schemas/IncidentSummary"
            }
        }
    }
}

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

型: object

読取り専用: true

ページ分割されたリソースへのURLリンク。

ソースの表示

• next: object Link
  リンクを表します(self、previous、nextのいずれか)
• previous: object Link
  リンクを表します(self、previous、nextのいずれか)
• self(必須): object Link
  リンクを表します(self、previous、nextのいずれか)

{
    "required":[
        "self"
    ],
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"URL links to paginated resource(s).",
    "readOnly":true,
    "example":{
        "self":{
            "href":"/em/api/incidents?page=MQ%3D%3D&limit=50"
        },
        "next":{
            "href":"/em/api/incidents?page=Mg%3D%3D&limit=50"
        },
        "previous":{
            "href":"/em/api/incidents?page=MA%3D%3D&limit=50"
        }
    }
}

例:

{
    "self":{
        "href":"/em/api/incidents?page=MQ%3D%3D&limit=50"
    },
    "next":{
        "href":"/em/api/incidents?page=Mg%3D%3D&limit=50"
    },
    "previous":{
        "href":"/em/api/incidents?page=MA%3D%3D&limit=50"
    }
}

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

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

型: array

インシデント・サマリーのリスト

ソースの表示

• 配列: object IncidentSummary
  インシデントのサマリー

{
    "type":"array",
    "description":"List of the incident summary",
    "items":{
        "$ref":"#/components/schemas/IncidentSummary"
    }
}

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

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

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

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

先頭に戻る