CreateUserWafRuleset - Edge Security Acceleration - Alibaba Cloud Documentation Center

Operation description

Request description

This API creates a new WAF ruleset for a specified instance.
The required InstanceId parameter specifies the instance for which to create the ruleset.
The Phase parameter defines the application phase of the ruleset, such as custom rules or rate limiting.
The required Name and Expression parameters specify the name of the ruleset and its match expression.
The optional Description parameter specifies a description for the ruleset.
The Status parameter controls whether the ruleset is active (on) or inactive (off).
The Rules parameter specifies a list of rules. Each rule includes properties such as a name, position, expression, and action.
A successful response returns the unique ID of the new ruleset in the Id parameter and a list of associated rule IDs in the RuleIds parameter.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	esa-site-ads11w
Phase	string	Yes	The execution phase of the WAF.	http_custom
Name	string	Yes	The name of the WAF ruleset.	example
Description	string	No	The description of the WAF ruleset.	this is a test ruleset.
Status	string	Yes	The status of the WAF ruleset.	on
Expression	string	Yes	The expression for the WAF ruleset.	ip.src == 1.1.1.1
Shared	WafBatchRuleShared	No	The shared configuration for WAF batch rules.
Rules	array	No	A list of rule configurations in the WAF ruleset.
	WafRuleConfig	No	A rule configuration in the WAF ruleset.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	15C66C7B-671A-4297-9187-2C4477247A74
Id	integer	The ID of the WAF ruleset.	665d3af3621bccf3fe29e1a4
RuleIds	array	A list of rule IDs in the WAF ruleset.
	integer	A rule ID in the WAF ruleset.	87570

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Id": 0,
  "RuleIds": [
    87570
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
403	Rule.Config.Noncompliance	The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.	The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.
403	Rule.Config.Malformed	The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.	The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.
403	%s.NotSupport	The specified resource type %s is not supported.	The specified resource type is not supported. To use this type of resource, please contact us.
403	%s.OverQuota	The quantity of %s exceeds the quota.	The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.
403	%s.WrongValueMatched	The value of specified parameter %s can not pass the matching check.	The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.