All Products
Search
Document Center

Web Application Firewall:DescribeTemplateResourceCount

Last Updated:Nov 15, 2024

Queries the number of protected resources for which a protection template takes effect.

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:DescribeTemplateResourceCountlist
*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 query the ID of the WAF instance.
waf_v3prepaid_public_cn-lbj****gx08
TemplateIdsstringYes

The IDs of the protection templates that you want to query. Separate multiple template IDs with commas (,).

12345,12346
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-aekzwwkpn****5i
RegionIdstringNo

The region in which the WAF instance is deployed. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

B8064433-9781-5E86-806E-C1DD****1D95
ResourceCountarray<object>

The number of protected objects or protected object groups for which the protection template takes effect.

Countobject
TemplateIdlong

The ID of the protection template.

12345
SingleCountinteger

The number of protected objects.

30
GroupCountinteger

The number of protected object groups.

30

Examples

Sample success responses

JSONformat

{
  "RequestId": "B8064433-9781-5E86-806E-C1DD****1D95",
  "ResourceCount": [
    {
      "TemplateId": 12345,
      "SingleCount": 30,
      "GroupCount": 30
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history