ListRules - 获取规则列表

目前该API接口已标记为弃用,推荐使用替代API:Qualitycheck(2019-01-15) - ListRulesV4

获取规则列表。

调试

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

授权信息

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

请求参数

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

一个 JSON 格式的字符串,完整 JSON 字符串信息,具体内容参见以下详细信息。

{"pageNumber":1,"pageSize":10}
BaseMeAgentIdlong

业务空间 Id

请求参数 Json 字符串信息

属性值类型是否必须示例值说明
pageNumberInteger1当前页码,起始值:1。
pageSizeInteger10分页查询时设置的每页行数。
ridInteger1234567规则 ID。
ruleNameString“禁用语检测”规则名称。

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

82C91484-B2D5-4D2A-A21F-A6D73F**
Successboolean

请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null 表示失败。

true
Codestring

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200
Messagestring

出错时表示出错详情,成功时为 successful。

successful
PageNumberinteger

规则列表页码。

1
PageSizeinteger

每页行数。

10
Countinteger

总条数。

20
Dataobject []

规则列表

Typeinteger

规则所属的规则类型的 type 值。

1
RuleTypeinteger

规则类别,可能值:

  • 1:自定义创建的规则
  • 0:系统预置规则
1
CreateTimestring

规则的创建时间。

2020-04-20T20:10Z
Commentsstring

规则的备注信息。

检测是否出现了禁用语
TypeNamestring

规则所属的规则类型的名称。

服务规范
Namestring

规则名称。

禁用语检测
Ridlong

规则 ID。

1234567
BusinessCategoryNameListarray

规则所关联的适用业务名称。

string

规则所关联的适用业务名称。

["所有业务"]

示例

正常返回示例

JSON格式

{
  "RequestId": "82C91484-B2D5-4D2A-A21F-A6D73F**\t",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "Count": 20,
  "Data": [
    {
      "Type": 1,
      "RuleType": 1,
      "CreateTime": "2020-04-20T20:10Z",
      "Comments": "检测是否出现了禁用语",
      "TypeName": "服务规范",
      "Name": "禁用语检测",
      "Rid": 1234567,
      "BusinessCategoryNameList": [
        "[\"所有业务\"]"
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-19OpenAPI 变更为 deprecated,即将下线看变更集
变更项变更内容
API 弃用说明(deprecated)OpenAPI 变更为 deprecated,即将下线
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用