All Products
Search
Document Center

Web Application Firewall:DescribeDefenseTemplate

Last Updated:Nov 15, 2024

Queries a protection rule template.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeDefenseTemplateget
*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****
TemplateIdlongYes

The ID of the protection rule template.

1333
ResourceManagerResourceGroupIdstringNo

The ID of the 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 response parameters.

RequestIdstring

The ID of the request.

D7861F61-5B61-46CE-A47C-6B19160D5EB0
Templateobject

The information about the template.

DefenseScenestring

The scenario in which the template is used. For more information, see the description of the DefenseScene parameter in the CreateDefenseRule topic.

waf_group
GmtModifiedlong

The most recent time when the protection rule template was modified.

1665283642000
TemplateIdlong

The ID of the protection rule template.

10097
TemplateNamestring

The name of the protection rule template.

test0621
TemplateOriginstring

The origin of the protection rule template. If the value of this parameter is custom, the protection rule template is created by the user.

custom
TemplateStatusinteger

The status of the protection rule template. Valid values:

  • 0: disabled.
  • 1: enabled.
1
TemplateTypestring

The type of the protection rule template. Valid values:

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

The sub-scenario in which the template is used. Valid values:

  • web: The template is a bot management template that is used for website protection.
  • app: The template is a bot management template that is used for app protection.
  • basic: The template is a bot management template that is used for basic protection.
app
Descriptionstring

The description of the protection rule template.

test

Examples

Sample success responses

JSONformat

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Template": {
    "DefenseScene": "waf_group",
    "GmtModified": 1665283642000,
    "TemplateId": 10097,
    "TemplateName": "test0621",
    "TemplateOrigin": "custom",
    "TemplateStatus": 1,
    "TemplateType": "user_default",
    "DefenseSubScene": "app",
    "Description": "test"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-07-26The response structure of the API has changedView Change Details