GetRouteRule - 查看规则详情

查看规则详情。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /routeRule/detail HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求 Body。

routeRuleIdlong

规则 ID。

1
clientTokenstring

幂等号。

C4BE3837-1A13-413B-A225-2C88188E8A43

{ "routeRuleId" : 1, "}

返回参数

名称类型描述示例值
object

响应结构。

requestIdstring

请求 ID。

6B9347ED-FD93-42B4-B9A4-7282962F5D6A
dataobject

规则详情。

routeRuleIdlong

规则 ID。

180000000
ruleNamestring

流转规则名字。

规则1
timeWindowinteger

时间窗口。

3
relatedServiceNamestring

关联服务名称。

冲上云霄
enableStatusstring

是否启用:

  • disable:禁用。
  • enable:启用。
disable
relatedServiceIdlong

关联服务 ID。

1000
routeTypestring

路由类型:

  • INCIDENT:触发事件。
  • ALERT:仅触发报警。
INCIDENT
incidentLevelstring

事件级别递降:

  • P1
  • P2
  • P3
  • P4
P1
assignObjectIdlong

事件分派对象 ID(服务组 ID 或用户 ID)。

1000
assignObjectTypestring

事件分派对象类型:

  • SERVICEGROUP:服务组。
  • USER:单个用户。
SERVICEGROUP
effectionstring

影响程度:

  • LOW:一般。
  • HIGH:严重。
LOW
matchCountlong

命中次数。

3
childRuleRelationstring

子规则关系:

  • AND:与。
  • OR:或。
AND、OR
eventRouteChildRulesarray<object>

子规则。

子规则object

子规则。

childRouteRuleIdlong

子规则 ID。

1000
isValidChildRuleboolean

规则是否有效:

  • true:有效。
  • false:无效。
false
parentRuleIdlong

规则 ID。

1800
monitorSourceIdlong

监控源 ID。

1
monitorIntegrationConfigIdlong

集成配置 ID。

1
monitorSourceNamestring

监控源名称。

zabbix
childConditionRelationlong

子条件计算关系:

  • 0:与。
  • 1:或。
1
conditionsarray<object>

匹配条件。

匹配条件object

条件。

keystring

条件 key。

alarmName
valuestring

匹配值。

Zabbix server
operationSymbolstring

操作符。

contain
problemLevelstring

故障等级。

1
createTimestring

创建时间。

2020-09-08 15:30:30
updateTimestring

修改时间。

2020-09-08 15:30:30
notifyChannelsarray

通知渠道。

通知渠道string

通知渠道。

[SMS,PHONE]
notifyChannelNamesarray

通知渠道名称。

通知渠道名称string

通知渠道名称。

[短信,电话]
assignObjectNamestring

通知对象名称。

刘先生
relServiceDeleteTypeinteger

服务删除字段。

1
problemLevelGroupobject

故障等级组。

object

服务组。

childRuleRelationinteger

子规则。

11
matchCountlong

数量。

11
timeWindowlong

时间窗口。

1
timeWindowUnitstring

时间单元。

1
enableUpgradeboolean

是否开启。

true
upgradeTimeWindowlong

时间窗口。

1
upgradeTimeWindowUnitstring

服务单元。

1
coverageProblemLevelsarray

故障等级覆盖。

string

故障等级。

1
problemEffectionServicesarray

故障影响服务。

long

故障关联服务。

1
convergenceFieldsarray

收敛字段集合。

string

收敛字段名称。

name
convergenceTypeinteger

收敛类型:

  • 0:流转规则收敛。
  • 1:字段收敛。
0

{ "requestId": "6B9347ED-FD93-42B4-B9A4-7282962F5D6A", "data": { "routeRuleId": 180000000, "subscriptionName": "我的订阅", "ruleName": "规则 1", "timeWindow": 3, "relatedServiceName": "冲上云霄", "enableStatus": "DISABLE", "relatedServiceId": 1000, "routeType": "INCIDENT", "incidentLevel": "P1", "assignObjectId": 1000, "assignObjectType": "SERVICEGROUP", "effection": "LOW", "matchCount": 3, "eventRouteChildRules": [ { "childRouteRuleId": 1000, "isValidChildRule": false, "parentRuleId": 1800, "monitorSourceId": 1, "monitorIntegrationConfigId": 1, "monitorSourceName": "zabbix", "conditions": [ { "key": "alarmName", "value": "Zabbix server", "operationSymbol": "contain" } ] } ], "createTime": "2020-09-08 15:30:30", "updateTime": "2020-09-08 15:30:30", "notifyChannels": [ "[SMS,PHONE]" ], "notifyChannelNames": [ "[短信,电话]" ], "assignObjectName": "刘德华" } }

示例

正常返回示例

JSON格式

{
  "requestId": "6B9347ED-FD93-42B4-B9A4-7282962F5D6A",
  "data": {
    "routeRuleId": 180000000,
    "ruleName": "规则1",
    "timeWindow": 3,
    "relatedServiceName": "冲上云霄",
    "enableStatus": "disable",
    "relatedServiceId": 1000,
    "routeType": "INCIDENT",
    "incidentLevel": "P1",
    "assignObjectId": 1000,
    "assignObjectType": "SERVICEGROUP",
    "effection": "LOW",
    "matchCount": 3,
    "childRuleRelation": "AND、OR",
    "eventRouteChildRules": [
      {
        "childRouteRuleId": 1000,
        "isValidChildRule": false,
        "parentRuleId": 1800,
        "monitorSourceId": 1,
        "monitorIntegrationConfigId": 1,
        "monitorSourceName": "zabbix",
        "childConditionRelation": 1,
        "conditions": [
          {
            "key": "alarmName",
            "value": "Zabbix server",
            "operationSymbol": "contain"
          }
        ],
        "problemLevel": "1"
      }
    ],
    "createTime": "2020-09-08 15:30:30",
    "updateTime": "2020-09-08 15:30:30",
    "notifyChannels": [
      "[SMS,PHONE]"
    ],
    "notifyChannelNames": [
      "[短信,电话]"
    ],
    "assignObjectName": "刘先生",
    "relServiceDeleteType": 1,
    "problemLevelGroup": {
      "key": {
        "childRuleRelation": 11,
        "matchCount": 11,
        "timeWindow": 1,
        "timeWindowUnit": "1",
        "enableUpgrade": true,
        "upgradeTimeWindow": 1,
        "upgradeTimeWindowUnit": "1"
      }
    },
    "coverageProblemLevels": [
      "1"
    ],
    "problemEffectionServices": [
      1
    ],
    "convergenceFields": [
      "name"
    ],
    "convergenceType": 0
  }
}

错误码

HTTP status code错误码错误信息描述
404RouteRuleNotExistedThe rule does not exist.流转规则不存在

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