ListRouteRules - 查询规则列表

查询规则列表。

调试

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

授权信息

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

请求语法

POST /routeRule/list HTTP/1.1

请求参数

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

请求 Body。

ruleNamebyte

规则名称。

规则
serviceNamebyte

服务名称。

服务
pageNumberinteger

分页页码。

1
pageSizeinteger

分页大小。

10
clientTokenstring

幂等号。

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

路由类型:

  • 0:触发事件。
  • 1:仅触发报警。
0
notFilterRouteRuleDeletedboolean

不过滤已删除流转规则。

false

返回参数

名称类型描述示例值
object

响应结构。

requestIdstring

请求 ID。

C4BE3837-1A13B-A225-2C88188E8A43
dataarray<object>

规则列表。

规则列表object
routeRuleIdlong

规则 ID。

10000
tenantRamIdlong

租户 ID。

1344383
ruleNamestring

规则名称。

规则名字
relatedServiceNamestring

服务名称。

关联服务名字
timeWindowlong

时间窗口。

时间窗口
matchCountlong

命中次数。

10
timeWindowUnitlong

时间单位:

  • MINUTE:分钟。
  • SECOND:秒。
MINUTE
relatedServiceIdlong

关联服务 ID。

1
routeTypestring

路由类型:

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

事件级别递减:

  • P1
  • P2
  • P3
  • P4
P1
assignObjectIdlong

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

10
assignObjectTypestring

事件分派对象类型:

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

影响程度:

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

创建时间。

2020-03-05 15:53:55
updateTimestring

修改时间。

2020-03-05 15:53:55
enableStatusstring

是否启用:

  • DISABLE-禁用
  • ENABLE-启用
DISABLE
monitorSourceNamesstring

监控源名称。

zabbix
relServiceDeleteTypeinteger

服务删除字段。

1
isValidinteger

是否有效:

  • 0:无效。
  • 1:有效。
1
totalCountlong

总条数。

10
pageNumberlong

分页页码。

1
pageSizelong

分页大小。

10

示例

正常返回示例

JSON格式

{
  "requestId": "C4BE3837-1A13B-A225-2C88188E8A43",
  "data": [
    {
      "routeRuleId": 10000,
      "tenantRamId": 1344383,
      "ruleName": "规则名字",
      "relatedServiceName": "关联服务名字",
      "timeWindow": 0,
      "matchCount": 10,
      "timeWindowUnit": 0,
      "relatedServiceId": 1,
      "routeType": "INCIDENT",
      "incidentLevel": "P1",
      "assignObjectId": 10,
      "assignObjectType": "SERVICEGROUP",
      "effection": "LOW",
      "createTime": "2020-03-05 15:53:55",
      "updateTime": "2020-03-05 15:53:55",
      "enableStatus": "DISABLE",
      "monitorSourceNames": "zabbix",
      "relServiceDeleteType": 1,
      "isValid": 1
    }
  ],
  "totalCount": 10,
  "pageNumber": 1,
  "pageSize": 10
}

错误码

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