调用ListRules获取规则列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListRules |
系统规定参数。取值：ListRules。 |
| JsonStr | String | 是 | {"pageNumber":1,"pageSize":10} |
一个Json格式的字符串，完整Json字符串信息，具体内容参见以下详细信息。 |
|
属性 |
值类型 |
是否必须 |
示例值 |
说明 |
|---|---|---|---|---|
|
pageNumber |
Integer |
是 |
1 |
当前页码，起始值：1。 |
|
pageSize |
Integer |
是 |
10 |
分页查询时设置的每页行数。 |
|
rid |
Integer |
否 |
1234567 |
规则id。 |
|
ruleName |
String |
否 |
“禁用语检测” |
规则名称。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | 200 |
结果代码，200 表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。 |
| Count | Integer | 20 |
总条数。 |
| Data | Array |
详细返回数据。 |
|
| BusinessCategoryNameList | List | ["所有业务"] |
规则所关联的适用业务名称。 |
| Comments | String | 检测是否出现了禁用语 |
规则的备注信息。 |
| CreateTime | String | 2020-04-20T20:10Z |
规则的创建时间。 |
| Name | String | 禁用语检测 |
规则名称。 |
| Rid | Long | 1234567 |
规则ID。 |
| RuleType | Integer | 1 |
规则类别，可能值：1(自定义创建的规则)；0(系统预置规则)。 |
| Type | Integer | 1 |
规则所属的规则类型的type值。 |
| TypeName | String | 服务规范 |
规则所属的规则类型的名称。 |
| Message | String | successful |
出错时表示出错详情，成功时为successful。 |
| PageSize | Integer | 10 |
每页行数。 |
| PageNumber | Integer | 1 |
规则列表页码。 |
| RequestId | String | 82C91484-B2D5-4D2A-A21F-A6D73F** |
请求ID。 |
| Success | Boolean | true |
请求是否成功，调用方可根据此字段来判断请求是否成功：true表示成功；false/null表示失败。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListRules
&JsonStr={"pageNumber":1,"pageSize":10}
&<公共请求参数>正常返回示例
XML 格式
<ListRulesResponse>
<RequestId>51330D59-DF7B-4768-8123-E8C3****</RequestId>
<Message>successful</Message>
<PageSize>2</PageSize>
<PageNumber>1</PageNumber>
<Data>
<Type>1</Type>
<TypeName>服务规范</TypeName>
<Comments>23423</Comments>
<CreateTime>2020-04-20T20:10Z</CreateTime>
<RuleType>1</RuleType>
<Rid>12345678</Rid>
<OperationMode>1</OperationMode>
<Name>禁用语检测</Name>
<BusinessCategoryNameList>所有业务</BusinessCategoryNameList>
</Data>
<Data>
<Type>1</Type>
<TypeName>服务规范</TypeName>
<Comments>111</Comments>
<CreateTime>2020-04-20T10:38Z</CreateTime>
<RuleType>1</RuleType>
<Rid>12345679</Rid>
<OperationMode>1</OperationMode>
<Name>开头语不完整</Name>
<BusinessCategoryNameList>所有业务</BusinessCategoryNameList>
</Data>
<Count>891</Count>
<Code>200</Code>
<Success>true</Success>
</ListRulesResponse>JSON 格式
{
"RequestId":"51330D59-DF7B-4768-8123-E8C3****",
"Message":"successful",
"PageSize":2,
"PageNumber":1,
"Data":[
{
"Type":1,
"TypeName":"服务规范",
"Comments":"23423",
"CreateTime":"2020-04-20T20:10Z",
"RuleType":1,
"Rid":12345678,
"OperationMode":1,
"Name":"禁用语检测",
"BusinessCategoryNameList":[
"所有业务"
]
},
{
"Type":1,
"TypeName":"服务规范",
"Comments":"111",
"CreateTime":"2020-04-20T10:38Z",
"RuleType":1,
"Rid":12345679,
"OperationMode":1,
"Name":"开头语不完整",
"BusinessCategoryNameList":[
"所有业务"
]
}
],
"Count":891,
"Code":"200",
"Success":true
}错误码
访问错误中心查看更多错误码。
