获取故障通知预览

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /problem/preview HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
Object Body

body

problemId Long Body 12312

故障id

problemNotifyType String Body PROBLEM_NOTIFY

通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE:

故障补发 PROBLEM_CANCEL:故障取消

problemLevel String Body P2

故障等级

effectServiceIds Array of Long Body 1231

影响服务ID

relatedServiceId Long Body 21312

关联服务Id

incidentId Long Body 213123

事件id

serviceGroupIds Array of Long Body 12313

服务组Id

clientToken String Body 4361a0e1-6747-4834-96ce-0c4840f13812

幂等Token

返回数据

名称 类型 示例值 描述
requestId String 4361a0e1-6747-4834-96ce-0c2840fd3812

requestId

data Object

data

problem Object

object

problemName String 故障名称

故障名称

problemStatus String HANDLING

HANDLING 故障状态

HANDLING 处理中 RECOVERED 已恢复

REPLAYING 复盘中

REPLAYED 已复盘 CANCEL 已取消

problemLevel String P2

故障等级 1=P1 2=P2 3=P3 4=P4

discoverTime String 2021-02-21 00:00:00

发现时间

recoveryTime String 2021-02-21 00:00:00

恢复时间

serviceName String 服务A

关联服务 名称

progressSummary String 摘要123

进展摘要

preliminaryReason String 原因A

初步原因

mainHandlerName String 小明

主要处理人

mainHandlerId String 231

主要处理人Id

isManual Boolean true

是否手动

isUpgrade Boolean true

是否升级

problemId Long 123123

故障Id

relatedServiceId Long 213123

关联服务ID

createTime String 2021-02-21 00:00:00

创建时间

coordinationGroups Array of coordinationGroups

应急协同组

serviceGroupName String 服务组A

服务组名称

serviceGroupId Long 1231

服务Id

serviceGroupDescription String 服务组描述

服务组Maison

effectionServices Array of effectionServices

影响服务

serviceName String 服务B

影响服务名称

serviceId Long 1231

影响服务Id

voice Object

语音

count Long 12

数量

users Array of users

用户组

username String 用户名称

用户

mail Object

邮箱

count Long 123

数量

users Array of users

用户组

username String 用户名称

用户名称

sms Object

短信

count Long 12

数量

users Array of users

用户组

username String 用户名称

用户名称

webhook Object

webhook

count Long 32

数量

serviceGroups Array of serviceGroups

服务组

serviceName String 服务名称

服务名称

upBeforeData String 最新升级前等级

升级前数据

upAfterData String 最新升级后等级

升级后数据

deBeforeData String 最新降级前等级

降级前数据

deAfterData String 最新降级后等级

降级后数据

示例

请求示例

POST /problem/preview HTTP/1.1
Host:gemp.cn-shanghai.aliyuncs.com
Content-Type:application/json

{
  "problemId" : 12312,
  "problemNotifyType" : "PROBLEM_NOTIFY",
  "problemLevel" : "P2",
  "effectServiceIds" : [ 1231 ],
  "relatedServiceId" : 21312,
  "incidentId" : 213123,
  "serviceGroupIds" : [ 12313 ],
  "clientToken" : "4361a0e1-6747-4834-96ce-0c4840f13812"
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetProblemPreviewResponse>
    <requestId>4361a0e1-6747-4834-96ce-0c2840fd3812</requestId>
    <data>
        <problem>
            <problemName>故障名称</problemName>
            <problemStatus>HANDLING</problemStatus>
            <problemLevel>P2</problemLevel>
            <discoverTime>2021-02-21 00:00:00</discoverTime>
            <recoveryTime>2021-02-21 00:00:00</recoveryTime>
            <serviceName>服务A</serviceName>
            <progressSummary>摘要123</progressSummary>
            <preliminaryReason>原因A</preliminaryReason>
            <mainHandlerName>小明</mainHandlerName>
            <mainHandlerId>231</mainHandlerId>
            <isManual>true</isManual>
            <isUpgrade>true</isUpgrade>
            <problemId>123123</problemId>
            <relatedServiceId>213123</relatedServiceId>
            <createTime>2021-02-21 00:00:00</createTime>
            <coordinationGroups>
                <serviceGroupName>服务组A</serviceGroupName>
                <serviceGroupId>1231</serviceGroupId>
                <serviceGroupDescription>服务组描述</serviceGroupDescription>
            </coordinationGroups>
            <effectionServices>
                <serviceName>服务B</serviceName>
                <serviceId>1231</serviceId>
            </effectionServices>
        </problem>
        <voice>
            <count>12</count>
            <users>
                <username>用户名称</username>
            </users>
        </voice>
        <mail>
            <count>123</count>
            <users>
                <username>用户名称</username>
            </users>
        </mail>
        <sms>
            <count>12</count>
            <users>
                <username>用户名称</username>
            </users>
        </sms>
        <webhook>
            <count>32</count>
            <serviceGroups>
                <serviceName>服务名称</serviceName>
            </serviceGroups>
        </webhook>
        <upBeforeData>最新升级前等级</upBeforeData>
        <upAfterData>最新升级后等级</upAfterData>
        <deBeforeData>最新降级前等级</deBeforeData>
        <deAfterData>最新降级后等级</deAfterData>
    </data>
</GetProblemPreviewResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "4361a0e1-6747-4834-96ce-0c2840fd3812",
  "data" : {
    "problem" : {
      "problemName" : "故障名称",
      "problemStatus" : "HANDLING",
      "problemLevel" : "P2",
      "discoverTime" : "2021-02-21 00:00:00",
      "recoveryTime" : "2021-02-21 00:00:00",
      "serviceName" : "服务A",
      "progressSummary" : "摘要123",
      "preliminaryReason" : "原因A",
      "mainHandlerName" : "小明",
      "mainHandlerId" : "231",
      "isManual" : true,
      "isUpgrade" : true,
      "problemId" : 123123,
      "relatedServiceId" : 213123,
      "createTime" : "2021-02-21 00:00:00",
      "coordinationGroups" : [ {
        "serviceGroupName" : "服务组A",
        "serviceGroupId" : 1231,
        "serviceGroupDescription" : "服务组描述"
      } ],
      "effectionServices" : [ {
        "serviceName" : "服务B",
        "serviceId" : 1231
      } ]
    },
    "voice" : {
      "count" : 12,
      "users" : [ {
        "username" : "用户名称"
      } ]
    },
    "mail" : {
      "count" : 123,
      "users" : [ {
        "username" : "用户名称"
      } ]
    },
    "sms" : {
      "count" : 12,
      "users" : [ {
        "username" : "用户名称"
      } ]
    },
    "webhook" : {
      "count" : 32,
      "serviceGroups" : [ {
        "serviceName" : "服务名称"
      } ]
    },
    "upBeforeData" : "最新升级前等级",
    "upAfterData" : "最新升级后等级",
    "deBeforeData" : "最新降级前等级",
    "deAfterData" : "最新降级后等级"
  }
}

错误码

HttpCode 错误码 错误信息 描述
404 ProblemNotExisted The problem does not exist. 故障不存在

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。