Setting a Control Rule

Sets a control rule.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:appcenter:setRuleRestriction	Write	-	-	-	-

POST /v1/{project_id}/app-center/app-rules/actions/set-rule-restriction

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
app_restrict_rule_switch	Yes	Boolean	Whether to enable application control. The options are false (disabled) and true (enabled).
app_control_mode	No	Integer	Application control method. 0: Prohibits applications in the list from running.
app_periodic_switch	No	Boolean	Whether to enable periodic monitoring. The options are false (disabled) and true (enabled).
app_periodic_interval	No	Integer	Interval for periodic monitoring, in minutes.
app_force_kill_proc_switch	No	Boolean	Whether to force kill an application. The options are false (disabled) and true (enabled).

Status code: 200

Operation successful.

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 405

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 503

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

{
  "app_restrict_rule_switch" : true,
  "app_control_mode" : 0,
  "app_periodic_switch" : false
}

None

Status Code	Description
200	Operation successful.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	Service unavailable.