DescribeDefenseResource - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the information about a protected object.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:DescribeDefenseResource

get

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	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-4xl****i60i
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
Resource	string	Yes	The name of the protected object that you want to query. Only exact queries are supported.	example.aliyundoc.com-waf
RegionId	string	No	The region of the WAF instance. Valid values: cn-hangzhou: The Chinese mainland. ap-southeast-1: Outside the Chinese mainland.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	439AADF2-368C-5E98-B14E-3086****0573
Resource	object	The protected object.
GmtCreate	integer	The time when the protected object was created. Unit: milliseconds.	1607493144000
GmtModified	integer	The time when the protected object was modified. Unit: milliseconds.	1691720010000
Product	string	The name of the cloud service. Valid values:	alb
Resource	string	The name of the protected object.	alb-rencs***
ResourceGroup	string	The name of the protected object group to which the protected object belongs.	example_resource_group
Detail	object	The details of the protected object. Different key-value pairs indicate different attributes of the protected object.	{ "product": "waf", "domain": "demo.aliyundoc****.com" }
Pattern	string	The pattern used for the protected object.	domain
XffStatus	integer	Indicates whether a Layer 7 proxy is deployed in front of WAF, such as Anti-DDoS Proxy and Alibaba Cloud CDN. Valid values: 0: No. 1: Yes.	0
CustomHeaders	array	The custom header fields. Note When XffStatus = 1, the first IP address in the specified header field is used as the client source IP address to prevent X-Forwarded-For (XFF) spoofing. If multiple header fields are specified, they are tried in sequence to obtain the source IP address. If the first header field does not contain a source IP address, the second header field is tried, and so on. If no source IP address is obtained from all specified header fields, the first IP address in the X-Forwarded-For header field is used. When XffStatus = 1, the first IP address is obtained.
	string	The custom header field.	x-forwarded-for
ResourceOrigin	string	The origin of the protected object. Valid values: custom: The protected object is created from access management. access: The protected object is created by the user.	custom
Description	string	The description.	This is Description
ResourceManagerResourceGroupId	string	The resource group ID.	rg-acfmoiy****p2oq
AcwCookieStatus	integer	The status of the tracking cookie. 0: Disabled. 1: Enabled.	0
AcwSecureStatus	integer	The status of the secure attribute of the tracking cookie. 0: Disabled. 1: Enabled.	0
AcwV3SecureStatus	integer	The status of the secure attribute of the slider CAPTCHA cookie. 0: Disabled. 1: Enabled.	0
OwnerUserId	string	The user ID to which the protected object belongs.	170457******9107
ResponseHeaders	array<object>	The response headers.
	object	The response header.
Key	string	Specifies the key for a custom response header.	Header-Key
Value	string	Specifies the value for a custom response header.	Header-Value

Examples

Success response

JSON format

{
  "RequestId": "439AADF2-368C-5E98-B14E-3086****0573",
  "Resource": {
    "GmtCreate": 1607493144000,
    "GmtModified": 1691720010000,
    "Product": "alb",
    "Resource": "alb-rencs***\n",
    "ResourceGroup": "example_resource_group",
    "Detail": {
      "product": "waf",
      "domain": "demo.aliyundoc****.com"
    },
    "Pattern": "domain",
    "XffStatus": 0,
    "CustomHeaders": [
      "x-forwarded-for"
    ],
    "ResourceOrigin": "custom",
    "Description": "This is Description",
    "ResourceManagerResourceGroupId": "rg-acfmoiy****p2oq",
    "AcwCookieStatus": 0,
    "AcwSecureStatus": 0,
    "AcwV3SecureStatus": 0,
    "OwnerUserId": "170457******9107",
    "ResponseHeaders": [
      {
        "Key": "Header-Key\n",
        "Value": "Header-Value\n"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.