移動先

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

インシデントの抑止

post

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

IDに一致する単一インシデントを抑止します

リクエスト

パス・パラメータ

• incidentId(必須): string(raw)
  抑止するインシデントのID

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

抑止リクエスト・ペイロード

ソースの表示

• comment: string
  最小長: 1

  最大長: 4000

  抑止アクションの説明

  例: そのインシデントはアクティブに調査中
• suppressUntil(必須): string
  指定可能な値: [ "MANUALLY_UNSUPPRESSED", "INCIDENT_CLOSES", "INCIDENT_SEVERITY_CHANGES", "AFTER_A_DAY", "AFTER_A_WEEK", "AFTER_DATE" ]

  抑止タイプ - 手動で抑止解除、インシデントのクローズ、インシデントの重大度の変更、1日後、1週間後、指定日後

  例: AFTER_A_DAY
• timeToEndSuppression: string (date-time)
  抑止を終了する時間

  例: 2021-05-25T13:41:32.230Z

{
    "required":[
        "suppressUntil"
    ],
    "type":"object",
    "properties":{
        "suppressUntil":{
            "type":"string",
            "description":"Supression types - Manually unsuppress, Incident closes, Incident severity changes, After a day, After a week, After a given date",
            "example":"AFTER_A_DAY",
            "enum":[
                "MANUALLY_UNSUPPRESSED",
                "INCIDENT_CLOSES",
                "INCIDENT_SEVERITY_CHANGES",
                "AFTER_A_DAY",
                "AFTER_A_WEEK",
                "AFTER_DATE"
            ]
        },
        "timeToEndSuppression":{
            "type":"string",
            "description":"Time to end the supression",
            "format":"date-time",
            "example":"2021-05-25T13:41:32.230Z"
        },
        "comment":{
            "maxLength":"4000",
            "minLength":"1",
            "type":"string",
            "description":"Description for suppression action",
            "example":"Actively looking into the incident"
        }
    },
    "description":"Suppression request payload"
}

先頭に戻る

レスポンス

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

• application/json

204レスポンス

ペイロードなしで操作に成功

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

先頭に戻る