ListRules - 获取规则列表

更新时间:
复制 MD 格式

获取规则列表。

说明

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

sca:ListRules

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

JsonStr

string

是

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

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

BaseMeAgentId

integer

否

业务空间 Id

123456

请求参数 Json 字符串信息

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

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

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

Success

boolean

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

true

Code

string

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

200

Message

string

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

successful

PageNumber

integer

规则列表页码。

1

PageSize

integer

每页行数。

10

Count

integer

总条数。

20

Data

array<object>

规则列表

object

规则列表

Type

integer

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

1

RuleType

integer

规则类别,可能值:

  • 1:自定义创建的规则

  • 0:系统预置规则

1

CreateTime

string

规则的创建时间。

2020-04-20T20:10Z

Comments

string

规则的备注信息。

检测是否出现了禁用语

TypeName

string

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

服务规范

Name

string

规则名称。

禁用语检测

Rid

integer

规则 ID。

1234567

BusinessCategoryNameList

array

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

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": [
        "[\"所有业务\"]"
      ]
    }
  ]
}

错误码

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

变更历史

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