调用GetRule获取规则的基本信息。

说明 该接口返回的规则idname等基本信息,可以和 获取规则详情 配合使用。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetRule

系统规定参数。取值:GetRule。

JsonStr String {"ruleIds":"123"}

完整Json字符串信息,具体内容参见以下详细信息。

请求参数Json字符串信息

属性

值类型

是否必须

说明

ruleIds

List<String>

规则标识ID,多个id以逗号分隔。

businessCategoryName

List<String>

所属业务分类名称

status

Integer

0 – 待生效,1 – 生效中, 2 – 已失效,3 - 全部。默认值为1。

返回数据

名称 类型 示例值 描述
Code String 200

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

Data

返回结果

Rules Array

分析结果信息列表

RuleInfo

分析结果信息列表

AutoReview Integer 1

审核选项。

  • 1:不自动审核
  • 3:自动审核
BusinessCategoryNameList List ["业务A","业务B"]

所属业务分类列表

BusinessCategoryNameList

所属业务分类列表

Comments String 测试规则

备注

CreateEmpid String 123

规则创建者ID

CreateTime String 2016-08-05 10:37:10

创建时间

EndTime String 2016-08-05 10:37:10

到期时间

IsDelete Integer 0

是否删除

  • 0:未删除
  • 1: 已删除
IsOnline Integer 1

【已废弃】是否已经上线,0:未上线;1:已上线。目前值固定为1.

LastUpdateEmpid String 123

最近更新的用户ID

LastUpdateTime String 2019-10-28 14:23:28

最近更新时间

Name String demo

规则名称

Rid String 4

规则ID

RuleLambda String a && b

【已废弃】规则条件间关系

RuleScoreType Integer 1

是否计分。

  • 1:不计分
  • 3:计分
ScoreName String 评分大项

评分大项名称,当ruleScoreType=3时存在。

ScoreSubName String 评分子项

评分子项名称,当ruleScoreType=3时存在。

StartTime String 2016-08-05 10:37:10

开始时间

Status Integer 1

状态。

  • 0
  • 待生效
  • 1
  • 生效中
  • 2
  • 已失效
Type Integer 1

【已废弃】规则类型

Weight String 1

【已废弃】规则权重

Message String successful

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

RequestId String F190ADE9-619A-447D-84E3-7E241A5C428E

请求ID

Success Boolean true

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

示例

请求示例


http(s)://qualitycheck.cn-hangzhou.aliyuncs.com/?Action=GetRule
&JsonStr={"ruleIds":"123"}
&<公共请求参数>

正常返回示例

XML 格式

<GetRuleResponse>
      <code>200</code>
      <data>
            <rules>
                  <createTime>2016-08-05 10:37:10</createTime>
                  <businessCategoryNameList>业务A</businessCategoryNameList>
                  <businessCategoryNameList>业务B</businessCategoryNameList>
                  <isDelete>0</isDelete>
                  <name>demo</name>
                  <rid>4</rid>
                  <status>1</status>
                  <autoReview>1</autoReview>
                  <ruleScoreType>1</ruleScoreType>
                  <scoreName>评分大项</scoreName>
                  <scoreSubName>评分子项</scoreSubName>
            </rules>
      </data>
      <message>successful</message>
      <requestId>F190ADE9-619A-447D-84E3-7E241A5C428E</requestId>
      <success>true</success>
</GetRuleResponse>

JSON 格式

{
	"message":"successful",
	"requestId":"F190ADE9-619A-447D-84E3-7E241A5C428E",
	"data":{
		"rules":[
			{
				"isDelete":0,
				"businessCategoryNameList":[
					"业务A",
					"业务B"
				],
				"createTime":"2016-08-05 10:37:10",
				"status":1,
				"rid":"4",
				"name":"demo",
				"scoreSubName":"评分子项",
				"ruleScoreType":1,
				"autoReview":1,
				"scoreName":"评分大项"
			}
		]
	},
	"code":"200",
	"success":true
}

错误码

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