All Products
Search

This Product

    Web Application Firewall:CreateDefenseTemplate

    Document Center

    Web Application Firewall:CreateDefenseTemplate

    Last Updated:Apr 23, 2024

    Creates a protection rule template.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-waf:CreateDefenseTemplateWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the Web Application Firewall (WAF) instance.

    Note You can call the DescribeInstance operation to obtain the ID of the WAF instance.
    		waf_cdnsdf3****
    TemplateNamestringYes

    The name of the protection rule template.

    		test221
    TemplateTypestringYes

    The type of the protection rule template. Valid values:

    • user_default: default template.
    • user_custom: custom template.
    		user_default
    TemplateStatusintegerYes

    The status of the protection rule template. Valid values:

    • 0: disabled.
    • 1: enabled.
    		1
    DefenseScenestringYes

    The scenario in which you want to use the protection rule template. For more information, see the description of the DefenseScene parameter in the CreateDefenseRule topic.

    		waf_group
    TemplateOriginstringYes

    The origin of the protection rule template that you want to create. Set the value to custom. The value specifies that the protection rule template is a custom template.

    		custom
    DescriptionstringNo

    The description of the protection rule template.

    		Test
    ResourceManagerResourceGroupIdstringNo

    The ID of the Alibaba Cloud resource group.

    		rg-acfm***q
    RegionIdstringNo

    The region where the WAF instance resides. Valid values:

    • cn-hangzhou: the Chinese mainland.
    • ap-southeast-1: outside the Chinese mainland.
    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned result.

    RequestIdstring

    The ID of the request.

    		F48ABDF7-D777-5F26-892A-57349765D7A9
    TemplateIdlong

    The ID of the protection rule template.

    		2212

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "F48ABDF7-D777-5F26-892A-57349765D7A9",
  "TemplateId": 2212
}

    Error codes

    For a list of error codes, visit the Service error codes.