Updated on 2024-06-14 GMT+08:00

Updating a Rule

Function

This API is used to update a rule.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{domain_id}/rules/{rule_id}/update

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Tenant ID.

rule_id

Yes

String

Rule ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Rule type.

name

Yes

String

Rule name.

layout_content

Yes

String

Layout content.

plugin_id

No

String

Extension ID.

plugin_name

No

String

Extension name.

plugin_version

No

String

Extension version.

content

Yes

Array of RuleContent objects

Rule attribute set.

Table 4 RuleContent

Parameter

Mandatory

Type

Description

group_name

Yes

String

Group name.

can_modify_when_inherit

No

Boolean

Whether thresholds of an inherited policy can be modified.

properties

Yes

Array of RuleProperty objects

Rule attribute list.

Table 5 RuleProperty

Parameter

Mandatory

Type

Description

key

Yes

String

Attribute key.

type

Yes

String

Type.

name

Yes

String

Display name.

operator

No

String

Comparison operators.

value

Yes

String

Attribute value.

value_type

Yes

String

Data type.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

status

Boolean

Creation status.

rule_id

String

Rule ID.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

PUT https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/425eba0deaf04596a74cf7967d7fc04d/update

{
  "name" : "New Rule-20230919104204",
  "type" : "Test",
  "plugin_id" : "official_devcloud_apiTest",
  "plugin_name" : "official_devcloud_apiTest",
  "plugin_version" : "0.0.12",
  "layout_content" : "layout_content",
  "content" : [ {
    "group_name" : "API test pass rate access control",
    "properties" : [ {
      "key" : "pass_ratio",
      "name" : "API test pass rate",
      "type" : "judge",
      "operator" : "=",
      "value_type" : "float",
      "value" : "0.5"
    } ]
  } ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "status" : true,
  "rule_id" : "425eba0deaf04596a74cf7967d7fc04d"
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartspipeline.v2.region.CodeArtsPipelineRegion;
import com.huaweicloud.sdk.codeartspipeline.v2.*;
import com.huaweicloud.sdk.codeartspipeline.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateRuleSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateRuleRequest request = new UpdateRuleRequest();
        UpdateRuleReq body = new UpdateRuleReq();
        List<RuleProperty> listContentProperties = new ArrayList<>();
        listContentProperties.add(
            new RuleProperty()
                .withKey("pass_ratio")
                .withType("judge")
                .withName("API test pass rate")
                .withOperator("=")
                .withValue("0.5")
                .withValueType("float")
        );
        List<RuleContent> listbodyContent = new ArrayList<>();
        listbodyContent.add(
            new RuleContent()
                .withGroupName("API test pass rate access control")
                .withProperties(listContentProperties)
        );
        body.withContent(listbodyContent);
        body.withPluginVersion("0.0.12");
        body.withPluginName("official_devcloud_apiTest");
        body.withPluginId("official_devcloud_apiTest");
        body.withLayoutContent("layout_content");
        body.withName("New Rule-20230919104204");
        body.withType("Test");
        request.withBody(body);
        try {
            UpdateRuleResponse response = client.updateRule(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartspipeline.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsPipelineClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateRuleRequest()
        listPropertiesContent = [
            RuleProperty(
                key="pass_ratio",
                type="judge",
                name="API test pass rate",
                operator="=",
                value="0.5",
                value_type="float"
            )
        ]
        listContentbody = [
            RuleContent(
                group_name="API test pass rate access control",
                properties=listPropertiesContent
            )
        ]
        request.body = UpdateRuleReq(
            content=listContentbody,
            plugin_version="0.0.12",
            plugin_name="official_devcloud_apiTest",
            plugin_id="official_devcloud_apiTest",
            layout_content="layout_content",
            name="New Rule-20230919104204",
            type="Test"
        )
        response = client.update_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartspipeline.NewCodeArtsPipelineClient(
        codeartspipeline.CodeArtsPipelineClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateRuleRequest{}
	operatorProperties:= "="
	var listPropertiesContent = []model.RuleProperty{
        {
            Key: "pass_ratio",
            Type: "judge",
            Name: "API test pass rate",
            Operator: &operatorProperties,
            Value: "0.5",
            ValueType: "float",
        },
    }
	var listContentbody = []model.RuleContent{
        {
            GroupName: "API test pass rate access control",
            Properties: listPropertiesContent,
        },
    }
	pluginVersionUpdateRuleReq:= "0.0.12"
	pluginNameUpdateRuleReq:= "official_devcloud_apiTest"
	pluginIdUpdateRuleReq:= "official_devcloud_apiTest"
	request.Body = &model.UpdateRuleReq{
		Content: listContentbody,
		PluginVersion: &pluginVersionUpdateRuleReq,
		PluginName: &pluginNameUpdateRuleReq,
		PluginId: &pluginIdUpdateRuleReq,
		LayoutContent: "layout_content",
		Name: "New Rule-20230919104204",
		Type: "Test",
	}
	response, err := client.UpdateRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

Authentication failed.

403

No permission.

404

Resource not found.

Error Codes

See Error Codes.