Modify Rule Set

Updated on 2023-11-28 GMT+08:00

View PDF

Function

Modify Rule Set

URI

PUT /v2/{domain_id}/tenant/rule-sets/{rule_set_id}/update

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
rule_set_id	Yes	String	Rule Set ID
domain_id	Yes	String	TenantID

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
name	No	String	Rule Template Instance Name
rules	No	Array of UpdateRuleInstance objects	List of rule instances

**Table 4** UpdateRuleInstance
Parameter	Mandatory	Type	Description
id	No	String	Rule Instance ID
is_valid	No	Boolean	Rule Instance Status

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
status	Boolean	Status
rule_set_id	String	Rule Set ID

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Error Message
error_code	String	Error code.

Example Requests

PUT https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/update

{
  "name" : "Create a tenant-level policy.",
  "rules" : [ {
    "id" : "097f315044244c9193f1e3f1fba7979d",
    "is_valid" : true
  }, {
    "id" : "80cfcff078074b8aa7951d7b67b3137b",
    "is_valid" : true
  } ]
}

Example Responses

Status code: 200

{
  "status" : true,
  "rule_set_id" : "6cb18ee5ca1c48caa335706e0e5ee288"
}

Status Codes

Status Code	Description
200	OK
400	Bad request
401	Unauthorized
403	Forbidden
404	Not Found

Error Codes

See Error Codes.

Parent topic: Tenant-level policy management

Previous topic: Creating a Ruleset

Next topic: Obtaining Rule Set Details

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel