AddRuleV4 - 新增规则(新版质检)

更新时间:
复制为 MD 格式

对应前端功能位置:质检规则配置-新建。专有云URL:ip:port/api/client/UpdateRuleById.json。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

sca:AddRuleV4

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

JsonStrForRule

string

JsonStrForlRule 具体参考文档《规则对象说明

IsCopy

boolean

是否复制。为 true 是等效于复制规则。

false

BaseMeAgentId

integer

业务空间 Id

123456

请求入参示例

{
  "rules": [
    {
      "name": "siqi-test",
      "comments": "新建测试规则",
      "autoReview": 1,
      "level": 2,
      "type": 1,
      "business": [
        {
          "bid": 0,
          "name": "所有业务"
        }
      ],
      "fullCycle": 1,
      "targetType": 10,
      "scoreNumType": 0,
      "scoreType": 1,
      "scoreNum": "1",
      "lambda": "a",
      "triggers": [
        "a"
      ],
      "ruleScoreType": 3,
      "isHitNumScore": 0
    }
  ],
  "conditions": [
    {
      "cid": "a",
      "lambda": "1",
      "check_range": {},
      "operators": [
        {
          "oid": "1",
          "type": "HIT_ANY_KEYWORDS",
          "param": {
            "contextChatMatch": false,
            "in_sentence": false,
            "keywordMatchSize": 1,
            "keywords": [
              "你好",
              "欢迎"
            ]
          }
        }
      ]
    }
  ]
}

请求代码示例

public class sca {

    private static String ak = "YOUR_ACCESS_KEY_ID";
    private static String sk = "YOUR_ACCESS_KEY_SECRET";

    private static void addRule() throws Exception {
        String json="{\n" +
                "  \"rules\": [\n" +
                "    {\n" +
                "      \"name\": \"siqi-test\",\n" +
                "      \"comments\": \"新建测试规则\",\n" +
                "      \"autoReview\": 1,\n" +
                "      \"level\": 2,\n" +
                "      \"type\": 1,\n" +
                "      \"business\": [\n" +
                "        {\n" +
                "          \"bid\": 0,\n" +
                "          \"name\": \"所有业务\"\n" +
                "        }\n" +
                "      ],\n" +
                "      \"fullCycle\": 1,\n" +
                "      \"targetType\": 10,\n" +
                "      \"scoreNumType\": 0,\n" +
                "      \"scoreType\": 1,\n" +
                "      \"scoreNum\": \"1\",\n" +
                "      \"lambda\": \"a\",\n" +
                "      \"triggers\": [\n" +
                "        \"a\"\n" +
                "      ],\n" +
                "      \"ruleScoreType\": 3,\n" +
                "      \"isHitNumScore\": 0\n" +
                "    }\n" +
                "  ],\n" +
                "  \"conditions\": [\n" +
                "    {\n" +
                "      \"cid\": \"a\",\n" +
                "      \"lambda\": \"1\",\n" +
                "      \"check_range\": {},\n" +
                "      \"operators\": [\n" +
                "        {\n" +
                "          \"oid\": \"1\",\n" +
                "          \"type\": \"HIT_ANY_KEYWORDS\",\n" +
                "          \"param\": {\n" +
                "            \"contextChatMatch\": false,\n" +
                "            \"in_sentence\": false,\n" +
                "            \"keywordMatchSize\": 1,\n" +
                "            \"keywords\": [\n" +
                "              \"你好\",\n" +
                "              \"欢迎\"\n" +
                "            ]\n" +
                "          }\n" +
                "        }\n" +
                "      ]\n" +
                "    }\n" +
                "  ]\n" +
                "}";


        Config config = new Config();
        config.setAccessKeyId(ak).setAccessKeySecret(sk)
                .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")
                .setRegionId("cn-hangzhou").setProtocol("HTTPS");

        Client client = new Client(config);
        AddRuleV4Request result = new AddRuleV4Request();

        result.setJsonStrForRule(json);

        AddRuleV4Response response = client.addRuleV4(result);
        System.out.println(JSONObject.toJSONString(response));
    }

    public static void main(String[] args) throws Exception {
        addRule();
    }
}

返回参数

名称

类型

描述

示例值

object

BaseResult

RequestId

string

请求 ID

106C6CA0-282D-4AF7-85F0-D2D24***

Success

boolean

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

true

Code

string

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

200

Message

string

响应信息

successful

Messages

object

Message

array

出错时表示出错详情,当输出多条信息时使用。

string

出错时表示出错详情,当输出多条信息时使用。

HttpStatusCode

integer

HTTP 请求返回的响应状态码,200 表示请求成功。

200

Data

integer

新建的规则 ID。

示例

正常返回示例

JSON格式

{
  "RequestId": "106C6CA0-282D-4AF7-85F0-D2D24***",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "Messages": {
    "Message": [
      "无"
    ]
  },
  "HttpStatusCode": 200,
  "Data": 0
}

错误码

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

变更历史

更多信息,参考变更详情