获取故障通知预览。
调试
您可以在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 | long | 否 | 故障 ID。 | 12312 |
| problemNotifyType | string | 否 | 通告类型：
| PROBLEM_NOTIFY |
| problemLevel | string | 否 | 故障等级。 | P2 |
| effectServiceIds | array | 否 | 影响服务。 | |
| long | 否 | 影响服务 ID。 | 1231 | |
| relatedServiceId | long | 否 | 关联服务 ID。 | |
| incidentId | long | 否 | 事件 ID。 | 213123 |
| serviceGroupIds | array | 否 | 协同组 ID。 | |
| long | 否 | 服务组 ID。 | 12313 | |
| clientToken | string | 否 | 幂等 Token。 | 4361a0e1-6747-4834-96ce-0c4840f13812 |
返回参数
示例
正常返回示例
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. | 故障不存在 |
访问错误中心查看更多错误码。