All Products
Search

This Product

    Web Application Firewall:DescribeDefenseResourceGroups

    Document Center

    Web Application Firewall:DescribeDefenseResourceGroups

    Last Updated:Apr 25, 2024

    Performs a pagination query to retrieve the information about protected object groups.

    Debugging

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

    Authorization information

    There is currently no authorization information disclosed in the API.

    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-wwo36****0i
    ResourceManagerResourceGroupIdstringNo

    The ID of the Alibaba Cloud resource group.

    		rg-acfmxc7lf****eq
    GroupNameLikestringNo

    The name of the protected object group that you want to query. Fuzzy queries are supported.

    		demoGroupName
    PageNumberintegerNo

    The page number. Default value: 1.

    		1
    PageSizeintegerNo

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

    		20
    GroupNamesstringNo

    The names of the protected object groups that you want to query. Separate multiple names with commas (,).

    		groupName1,groupName2
    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.

    		BFEC5C77-049B-5E88-A5B6-CB0C****B66E
    TotalCountlong

    The total number of entries returned.

    		10
    Groupsobject []

    The list of protected object groups.

    Descriptionstring

    The description of the protected object group.

    		This is test description
    GmtCreatelong

    The time when the protected object group was created. Unit: milliseconds.

    		1624343180000
    GmtModifiedlong

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

    		1701656305000
    GroupNamestring

    The name of the protected object group.

    		apptest
    ResourceListstring

    The names of the protected objects that are added to the protected object group. Separate multiple protected objects with commas (,).

    		example02.aliyun-waf,example01.aliyun-waf

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "BFEC5C77-049B-5E88-A5B6-CB0C****B66E",
  "TotalCount": 10,
  "Groups": [
    {
      "Description": "This is test description",
      "GmtCreate": 1624343180000,
      "GmtModified": 1701656305000,
      "GroupName": "apptest",
      "ResourceList": "example02.aliyun-waf,example01.aliyun-waf"
    }
  ]
}

    Error codes

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