Modifying a Rule

Function

This API is used to modify a rule.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies the account ID. Maximum: 36
policy_assignment_id	Yes	String	Specifies the rule ID. Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Specifies the invoker's token.
X-Security-Token	No	String	Specifies a temporary security credential. This parameter is mandatory when you make an API call using a temporary security credential.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
policy_assignment_type	No	String	Specifies the rule type, which can be builtin or custom. If this parameter is not specified, the default value, builtin, is used.
name	Yes	String	Specifies the rule name. Maximum: 64
description	No	String	Specifies the rule description. Maximum: 512
period	No	String	Specifies the trigger period.
policy_filter	No	PolicyFilterDefinition object	Specifies the policy filter of a rule.
policy_definition_id	No	String	Specifies the policy definition ID. Maximum: 36
custom_policy	No	CustomPolicy object	Specifies the custom rule.
parameters	No	Map<String,PolicyParameterValue>	Specifies the rule parameters.
tags	No	Array of ResourceTag objects	Tags

**Table 4** PolicyFilterDefinition
Parameter	Mandatory	Type	Description
region_id	No	String	Specifies the region ID. Maximum: 128
resource_provider	No	String	Specifies the cloud service name. Maximum: 128
resource_type	No	String	Specifies the resource type. Maximum: 128
resource_id	No	String	Specifies the resource ID. Maximum: 512
tag_key	No	String	Specifies the tag key. Maximum: 128
tag_value	No	String	Specifies the tag value. Maximum: 256

**Table 5** CustomPolicy
Parameter	Mandatory	Type	Description
function_urn	Yes	String	Specifies the URN of a custom function. Maximum: 1024
auth_type	Yes	String	Specifies the method used by a custom rule to call a function.
auth_value	No	Map<String,Object>	Specifies the value of the method used by a custom rule to call a function.

**Table 6** PolicyParameterValue
Parameter	Mandatory	Type	Description
value	No	Object	Specifies the value of the rule parameter.

**Table 7** ResourceTag
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. A tag key can contain up to 128 Unicode characters and must comply with the character set specifications in section 3.1. Minimum: 1 Maximum: 128
value	Yes	String	Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2. Minimum: 0 Maximum: 255

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
policy_assignment_type	String	Specifies the rule type, which can be builtin or custom.
id	String	Specifies the rule ID.
name	String	Specifies the rule name.
description	String	Specifies the rule description.
policy_filter	PolicyFilterDefinition object	Specifies the policy filter of a rule.
period	String	Specifies how often the rule is triggered, which can be One_Hour, Three_Hours, Six_Hours, Twelve_Hours, or TwentyFour_Hours.
state	String	Specifies the rule status.
created	String	Specifies the time when the rule was added.
updated	String	Specifies the time when the rule was modified.
policy_definition_id	String	Specifies the ID of the policy associated with a rule.
custom_policy	CustomPolicy object	Specifies the custom rule.
parameters	Map<String,PolicyParameterValue>	Specifies rule parameters.
tags	Array of ResourceTag objects	Tags
created_by	String	Specifies the rule creator.
target_type	String	Execution method of remediation.
target_id	String	The ID of a remediation object.

**Table 9** PolicyFilterDefinition
Parameter	Type	Description
region_id	String	Specifies the region ID. Maximum: 128
resource_provider	String	Specifies the cloud service name. Maximum: 128
resource_type	String	Specifies the resource type. Maximum: 128
resource_id	String	Specifies the resource ID. Maximum: 512
tag_key	String	Specifies the tag key. Maximum: 128
tag_value	String	Specifies the tag value. Maximum: 256

**Table 10** CustomPolicy
Parameter	Type	Description
function_urn	String	Specifies the URN of a custom function. Maximum: 1024
auth_type	String	Specifies the method used by a custom rule to call a function.
auth_value	Map<String,Object>	Specifies the value of the method used by a custom rule to call a function.

**Table 11** PolicyParameterValue
Parameter	Type	Description
value	Object	Specifies the value of the rule parameter.

**Table 12** ResourceTag
Parameter	Type	Description
key	String	Tag key. A tag key can contain up to 128 Unicode characters and must comply with the character set specifications in section 3.1. Minimum: 1 Maximum: 128
value	String	Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2. Minimum: 0 Maximum: 255

Status code: 400

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 404

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}

{
  "name" : "allowed-images-by-id",
  "description" : "The ECS resource is non-compliant if the image it used is not in the allowed list",
  "parameters" : {
    "listOfAllowedImages" : {
      "value" : [ "ea0d6e0e-99c3-406d-a873-3bb45462b624" ]
    }
  },
  "policy_filter" : {
    "resource_provider" : "ecs",
    "resource_type" : "cloudservers"
  },
  "policy_definition_id" : "5f3c8b9a9811a13739a32ed9",
  "tags" : [ {
    "key" : "tagkey",
    "value" : "tagValue"
  } ]
}

Example Responses

Status code: 200

Operation succeeded.

{
  "policy_assignment_type" : "builtin",
  "id" : "5fb76a240f2daf0b9662a04d",
  "name" : "volume-inuse-check",
  "description" : "An EVS disk is non-compliant if it is not mounted to a cloud server.",
  "policy_filter" : {
    "region_id" : null,
    "resource_provider" : "evs",
    "resource_type" : "volumes",
    "resource_id" : null,
    "tag_key" : null,
    "tag_value" : null
  },
  "state" : "Enabled",
  "period" : null,
  "custom_policy" : null,
  "created" : "2020-11-20T07:03:00",
  "updated" : "2020-11-20T07:03:00",
  "policy_definition_id" : "5fa36558aa1e6afc05a3d0a7",
  "parameters" : { },
  "tags" : [ {
    "key" : "tagkey",
    "value" : "tagValue"
  } ],
  "created_by" : "custom",
  "target_type" : null,
  "target_id" : null
}

Status Codes

Status Code	Description
200	Operation succeeded.
400	Invalid parameters.
403	Authentication failed or you do not have the operation permissions.
404	No rules found.
500	Server error.

Error Codes

See Error Codes.

Parent topic: Compliance

Previous topic: Querying Rules

Next topic: Querying a Specific Rule

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.