使用GetProblemPreview接口获取故障通知预览-运维事件中心-阿里云-运维事件中心(Operations Incident Center)-阿里云帮助中心

获取故障通知预览。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gemp:GetProblemPreview

get

*全部资源

*

无

请求语法

POST /problem/preview HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 Body。
problemId	integer	否	故障 ID。	12312
problemNotifyType	string	否	通告类型： PROBLEM_NOTIFY：故障通告。 PROBLEM_UPDATE：故障更新。 PROBLEM_UPGRADE：故障升级。 PROBLEM_DEGRADE：故障降级。 PROBLEM_RECOVER：故障恢复。 PROBLEM_REISSUE：故障补发。 PROBLEM_CANCEL：故障取消。	PROBLEM_NOTIFY
problemLevel	string	否	故障等级。	P2
effectServiceIds	array	否	影响服务。
	integer	否	影响服务 ID。	1231
relatedServiceId	integer	否	关联服务 ID。	21312
incidentId	integer	否	事件 ID。	213123
serviceGroupIds	array	否	协同组 ID。
	integer	否	服务组 ID。	12313
clientToken	string	否	幂等 Token。	4361a0e1-6747-4834-96ce-0c4840f13812

返回参数

名称	类型	描述	示例值
	object	响应结构。
requestId	string	请求 ID。	4361a0e1-6747-4834-96ce-0c2840fd3812
data	object	降级规则。
problem	object	关联故障。
problemName	string	故障名称。	故障名称
problemStatus	string	故障状态： HANDLING：处理中。 RECOVERED：已恢复。 REPLAYING：复盘中。 REPLAYED：已复盘。 CANCEL：已取消。	HANDLING
problemLevel	string	故障等级递降： P1 P2 P3 P4	P2
discoverTime	string	发现时间，格式为 YYYY-MM-DD HH:mm:ss。	2021-02-21 00:00:00
recoveryTime	string	恢复时间，格式为 YYYY-MM-DD HH:mm:ss。	2021-02-21 00:00:00
serviceName	string	关联服务名称。	服务A
progressSummary	string	进展摘要。	摘要123
preliminaryReason	string	初步原因。	原因A
mainHandlerName	string	主要处理人。	小明
mainHandlerId	string	主要处理人 ID。	231
isManual	boolean	是否手动。	true
isUpgrade	boolean	是否升级。	true
problemId	integer	故障 ID。	123123
relatedServiceId	integer	关联服务 ID。	213123
createTime	string	创建时间，格式为 YYYY-MM-DD HH:mm:ss。	2021-02-21 00:00:00
progressSummaryRichTextId	integer	富文本 ID。	12312
coordinationGroups	array<object>	应急协同组。
	object	应急协同组。
serviceGroupName	string	服务组名称。	服务组A
serviceGroupId	integer	服务 ID。	1231
serviceGroupDescription	string	服务组描述。	服务组描述
effectionServices	array<object>	影响服务。
	object	影响服务。
serviceName	string	影响服务名称。	服务B
serviceId	integer	影响服务 ID。	1231
voice	object	语音。
count	integer	数量。	12
users	array<object>	用户组。
	object	用户。
username	string	用户。	用户名称
mail	object	邮箱。
count	integer	数量。	123
users	array<object>	用户组。
	object	用户。
username	string	用户名称。	用户名称
sms	object	短信。
count	integer	数量。	12
users	array<object>	用户组。
	object	用户。
username	string	用户名称。	用户名称
webhook	object	webhook。
count	integer	数量。	32
serviceGroups	array<object>	服务组。
	object	服务组名称。
serviceName	string	服务名称。	服务名称
upBeforeData	string	升级前数据。	最新升级前等级
upAfterData	string	升级后数据。	最新升级后等级
deBeforeData	string	降级前数据。	最新降级前等级
deAfterData	string	降级后数据。	最新降级后等级

示例

正常返回示例

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",
      "progressSummaryRichTextId": 12312,
      "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": "最新降级后等级"
  }
}

错误码

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

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

变更历史

更多信息，参考变更详情。