文档首页/ 云客服/ API参考/ 质检/监控/统计类/ 智能质检/ 静默规则接口 (silencerule)/ POST /CCSQM/rest/ccisqm/v1/silencerule/querySilenceRules
更新时间:2023-09-27 GMT+08:00

POST /CCSQM/rest/ccisqm/v1/silencerule/querySilenceRules

场景描述

查询静默规则列表,查询条件:page-当前页数,limit-每页展示数量,keyword-搜索关键词。

接口方法

POST

接口URI

https://域名/apiaccess/CCSQM/rest/ccisqm/v1/silencerule/querySilenceRules,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

string

False

固定填 application/json; charset=UTF-8。

2

x-app-key

string

False

appKey标识

3

Authorization

string

True

鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

4

x-UserId

string

False

操作员标识

可在登陆后,进入员工管理页面,查看接口返回的userId

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1.1

page

number

False

当前页数

1.2

limit

number

True

每页展示的数量

1.3

keyword

string(64)

False

搜索的关键词

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

是否必选

说明

1.1

data

array[object]

False

返回信息

1.1.1

score

string

False

规则分数

1.1.2

seconds

string

False

连续静默秒数

1.1.3

times

string

False

静默次数

1.1.4

silence_id

string

False

静默规则标识

1.1.5

name

string

False

规则名称

1.2

resultCode

string

False

返回码,0405000表示成功,其他表示失败

1.3

paging

object

False

分页信息

1.3.1

total

number

False

总数

1.4

resultDesc

string

False

返回描述

  • 响应状态码: 400

    错误的请求:请检查请求路径及参数。

  • 响应状态码: 401

    未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景描述:查询静默规则列表

    请求头:

    x-app-key:************************************  
    X-UserID:1611917095665261978  
    Authorization:Bearer ********************************

    请求参数:

    {
    	"page": 1,
    	"limit": 10
    }

    响应参数:

    {
    	"data": [{
    		"score": "-5",
    		"seconds": "3",
    		"times": "1",
    		"silence_id": "894378242029391872",
    		"name": "静默规则名称1"
    	}, {
    		"score": "-3",
    		"seconds": "4",
    		"times": "4",
    		"silence_id": "922671254081638400",
    		"name": "test3"
    	}, {
    		"score": "-5",
    		"seconds": "5",
    		"times": "5",
    		"silence_id": "922671488287379456",
    		"name": "tes4"
    	}, {
    		"score": "-4",
    		"seconds": "5",
    		"times": "4",
    		"silence_id": "922987647176019968",
    		"name": "test34"
    	}, {
    		"score": "-4",
    		"seconds": "5",
    		"times": "4",
    		"silence_id": "922988537635147776",
    		"name": "test35444"
    	}],
    	"resultCode": "0405000",
    	"paging": {
    		"total": 5
    	},
    	"resultDesc": "操作成功"
    }