All Products
Search
Document Center

Web Application Firewall:DescribeDefenseResourceGroup

Last Updated:Apr 23, 2024

Queries the information about a protected object group.

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:DescribeDefenseResourceGroupRead
  • 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****
GroupNamestringYes

The name of the protected object group whose information you want to query.

group221
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.

E67D21C6-5376-5F94-B745-70E08D03E3CB
Groupobject

The information about the protected object group.

GroupNamestring

The name of the protected object group.

group1
GmtCreatelong

The time when the protected object group was created.

23242312312
GmtModifiedlong

The most recent time when the protected object group was modified.

23242312312
ResourceListstring

The protected objects in the protected object group. The protected objects are separated with commas (,).

test1.aliyundoc.com,test2.aliyundoc.com
Descriptionstring

The description of the protected object group.

test

Examples

Sample success responses

JSONformat

{
  "RequestId": "E67D21C6-5376-5F94-B745-70E08D03E3CB",
  "Group": {
    "GroupName": "group1",
    "GmtCreate": 23242312312,
    "GmtModified": 23242312312,
    "ResourceList": "test1.aliyundoc.com,test2.aliyundoc.com",
    "Description": "test"
  }
}

Error codes

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