All Products
Search
Document Center

Web Application Firewall:DescribeDefenseResourceNames

Last Updated:Nov 15, 2024

Performs a pagination query to retrieve the names of protected objects.

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:DescribeDefenseResourceNameslist
*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_v2_public_cn-9lb****5s03
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-aekzd4c****pdwy
ResourcestringNo

The name of the protected object that you want to query.

example.xxxxaliyundoc.com
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 20.

10
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 ID of the request.

C1823E96-EF4B-5BD2-9E02-1D18****3ED8
TotalCountlong

The total number of entries returned.

75
Resourcesarray

The names of the protected objects.

Resourcestring

The name of the protected object.

example.aliyundoc.com-waf

Examples

Sample success responses

JSONformat

{
  "RequestId": "C1823E96-EF4B-5BD2-9E02-1D18****3ED8",
  "TotalCount": 75,
  "Resources": [
    "example.aliyundoc.com-waf"
  ]
}

Error codes

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