GetRouteRule - 查看规则详情

更新时间:
复制 MD 格式

查看规则详情。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gemp:GetRouteRule

get

*全部资源

*

无 无

请求语法

POST /routeRule/detail HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

否

请求 Body。

routeRuleId

integer

是

规则 ID。

1

clientToken

string

否

幂等号。

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

{ "routeRuleId" : 1, "}

返回参数

名称

类型

描述

示例值

object

响应结构。

requestId

string

请求 ID。

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

data

object

规则详情。

routeRuleId

integer

规则 ID。

180000000

ruleName

string

流转规则名字。

规则1

timeWindow

integer

时间窗口。

3

relatedServiceName

string

关联服务名称。

冲上云霄

enableStatus

string

是否启用:

  • disable:禁用。

  • enable:启用。

disable

relatedServiceId

integer

关联服务 ID。

1000

routeType

string

路由类型:

  • INCIDENT:触发事件。

  • ALERT:仅触发报警。

INCIDENT

incidentLevel

string

事件级别递降:

  • P1

  • P2

  • P3

  • P4

P1

assignObjectId

integer

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

1000

assignObjectType

string

事件分派对象类型:

  • SERVICEGROUP:服务组。

  • USER:单个用户。

SERVICEGROUP

effection

string

影响程度:

  • LOW:一般。

  • HIGH:严重。

LOW

matchCount

integer

命中次数。

3

childRuleRelation

string

子规则关系:

  • AND:与。

  • OR:或。

AND、OR

eventRouteChildRules

array<object>

子规则。

array<object>

子规则。

childRouteRuleId

integer

子规则 ID。

1000

isValidChildRule

boolean

规则是否有效:

  • true:有效。

  • false:无效。

false

parentRuleId

integer

规则 ID。

1800

monitorSourceId

integer

监控源 ID。

1

monitorIntegrationConfigId

integer

集成配置 ID。

1

monitorSourceName

string

监控源名称。

zabbix

childConditionRelation

integer

子条件计算关系:

  • 0:与。

  • 1:或。

1

conditions

array<object>

匹配条件。

object

条件。

key

string

条件 key。

alarmName

value

string

匹配值。

Zabbix server

operationSymbol

string

操作符。

contain

problemLevel

string

故障等级。

1

createTime

string

创建时间,格式为 YYYY-MM-DD HH:mm:ss。

2020-09-08 15:30:30

updateTime

string

修改时间,格式为 YYYY-MM-DD HH:mm:ss。

2020-09-08 15:30:30

notifyChannels

array

通知渠道。

string

通知渠道。

[SMS,PHONE]

notifyChannelNames

array

通知渠道名称。

string

通知渠道名称。

[短信,电话]

assignObjectName

string

通知对象名称。

刘先生

relServiceDeleteType

integer

服务删除字段。

1

problemLevelGroup

object

故障等级组。

object

服务组。

childRuleRelation

integer

子规则。

11

matchCount

integer

数量。

11

timeWindow

integer

时间窗口。

1

timeWindowUnit

string

时间单元。

1

enableUpgrade

boolean

是否开启。

true

upgradeTimeWindow

integer

时间窗口。

1

upgradeTimeWindowUnit

string

服务单元。

1

coverageProblemLevels

array

故障等级覆盖。

string

故障等级。

1

problemEffectionServices

array

故障影响服务。

integer

故障关联服务。

1

convergenceFields

array

收敛字段集合。

string

收敛字段名称。

name

convergenceType

integer

收敛类型:

  • 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

错误码

错误信息

描述

404 RouteRuleNotExisted The rule does not exist. 流转规则不存在

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

变更历史

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