Help Center/ CodeArts Pipeline/ API Reference/ API/ Rule Management/ Updating a rule
Updated on 2023-11-28 GMT+08:00
View PDF

Updating a rule

Function

Updating a rule

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Indicates the 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. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).
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

Plug-in ID

plugin_name

No

String

Plug-in

plugin_version

No

String

Add-on version.

content

Yes

Array of RuleContent objects

Rule Attribute Set
Table 4 RuleContent

Parameter

Mandatory

Type

Description

group_name

Yes

String

Group

can_modify_when_inherit

No

Boolean

Can the Threshold of an Inherited Subpolicy 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

Property 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 Codes

error_msg

String

Description

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

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"
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Failed request

401

Authentication failed.

403

No permission

404

The resource does not exist.

Error Codes

See Error Codes.

Parent topic: Rule Management