Use DescribeApisecExamples to Retrieve WAF API Security Data - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries API security sample information.

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:DescribeApisecExamples

list

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID of the WAF instance. Note You can call the DescribeInstance operation to query instance ID of the WAF instance.	waf_elasticity-cn-0xldbqtm005
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
ApiId	string	Yes	The ID of the API.	867ade***24ee6e205b8da82b8f84
ExampleType	string	No	The type of the sample. Valid values: risk : Risk type. sensitive : Sensitive information type.	sensitive
RequestSensitiveTypeList	array	No	The list of request sensitive information types.
	string	No	The request sensitive information type.	1001
ResponseSensitiveTypeList	array	No	The list of response sensitive information types.
	string	No	The response sensitive information type.	1001
AbnormalTag	string	No	The risk type.	LackOfSpeedLimit
NextToken	string	No	The pagination token.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	No	The number of entries per page in a paged query. Valid values: 1 to 5. Default value: 5. This parameter is used for paging.	5
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter applies only to hybrid cloud scenarios. You can call the DescribeHybridCloudClusters operation to query hybrid cloud cluster information.	176

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Examples	array<object>	The list of samples.
	array<object>	The sample information.
Protocol	string	The protocol type. Valid values: http: HTTP protocol. https: HTTPS protocol.	http
ApiUrl	string	The full request path.	http://www.test.com/api/v1/hello.php?token=TkJGQw
PocPayload	string	The verification request.	curl -X GET -H 'Accept: /' -H 'Connection: keep-alive' -H 'User-agent: Mozilla/5.0 (Windows NT 10.0; WOW64)' -H 'Host: www.test.com' -H 'Accept-encoding: gzip, deflate' -H 'Eagleeye-rpcid: 0.1' 'http://www.test.com/api/v1/hello.php?token=TkJGQw'
RequestSensitiveData	array<object>	The list of request sensitive data.
	object	The request sensitive data.
SensitiveCode	string	The code that indicates the type of sensitive data in the request.	1000
SensitiveDataList	array	The list of sensitive data.
	string	The sensitive data entry.	90.88.49.19
ResponseSensitiveData	array<object>	The list of response sensitive data.
	object	The response sensitive data.
SensitiveCode	string	The code that indicates the type of sensitive data in the response.	1000
SensitiveDataList	array	The list of sensitive data.
	string	The sensitive data entry.	90.88.49.19
Request	string	The sample request content, which is a character string converted from a JSON format constructed with a series of parameters. The following fields are included: method: the request method. host: the request domain name. header: the request header. server_port: the service port. body: the request body content. url: the request path. server_protocol: the server protocol. Note If the body content exceeds 16 KB, only partial content is returned.	{ "method": "GET", "host": "www.test.com", "header": { "Accept": "/", "Connection": "keep-alive" }, "server_port": "80", "body": "-", "url": "/api/v1/hello.php?token=TkJGQw", "server_protocol": "HTTP/1.1" }
Response	string	The sample response content, which is a string converted from a JSON object constructed with a series of parameters. The following fields are included: status: the status code. header: the response header. body: the response body content. Note If the body content exceeds 16 KB, only partial content is returned.	{ "header": { "Connection": "keep-alive", "Content-Encoding": "gzip", "Content-Type": "text/html; charset=UTF-8" }, "body": "xxxx", "status": 200 }
NextToken	string	The pagination token.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	The number of entries per page in a paged query. Valid values: 1 to 5. Default value: 5. This parameter is used for paging.	5
TotalCount	integer	The total number of results.	5

Examples

Success response

JSON format

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Examples": [
    {
      "Protocol": "http",
      "ApiUrl": "http://www.test.com/api/v1/hello.php?token=TkJGQw",
      "PocPayload": "curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: Mozilla/5.0 (Windows NT 10.0; WOW64)' -H 'Host: www.test.com' -H 'Accept-encoding: gzip, deflate' -H 'Eagleeye-rpcid: 0.1' 'http://www.test.com/api/v1/hello.php?token=TkJGQw'",
      "RequestSensitiveData": [
        {
          "SensitiveCode": "1000",
          "SensitiveDataList": [
            "90.88.49.19"
          ]
        }
      ],
      "ResponseSensitiveData": [
        {
          "SensitiveCode": "1000",
          "SensitiveDataList": [
            "90.88.49.19"
          ]
        }
      ],
      "Request": "{\n  \"method\": \"GET\",\n  \"host\": \"www.test.com\",\n  \"header\": {\n    \"Accept\": \"*/*\",\n    \"Connection\": \"keep-alive\"\n  },\n  \"server_port\": \"80\",\n  \"body\": \"-\",\n  \"url\": \"/api/v1/hello.php?token=TkJGQw\",\n  \"server_protocol\": \"HTTP/1.1\"\n}",
      "Response": "{\n  \"header\": {\n    \"Connection\": \"keep-alive\",\n    \"Content-Encoding\": \"gzip\",\n    \"Content-Type\": \"text/html; charset=UTF-8\"\n  },\n  \"body\": \"xxxx\",\n  \"status\": 200\n}"
    }
  ],
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "MaxResults": 5,
  "TotalCount": 5
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.