DescribeApisecExamples - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the API security examples that are detected by Web Application Firewall (WAF).

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to query the ID of the WAF instance.	waf_elasticity-cn-0xldbqtm005
RegionId	string	No	The region where the WAF instance resides. 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 example. Valid values: sensitive: sensitive data. risk: threat.	sensitive
RequestSensitiveTypeList	array	No	The list of sensitive data types in requests.
	string	No	The type of sensitive data in requests.	1001
ResponseSensitiveTypeList	array	No	The list of sensitive data types in responses.
	string	No	The type of sensitive data in responses.	1001
AbnormalTag	string	No	The type of API security threat.	LackOfSpeedLimit
NextToken	string	No	The token that is used to retrieve the next page of results.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 5. Default value: 5.	5
ClusterId	string	No	The ID of the Hybrid Cloud WAF cluster. Note This parameter is available only in hybrid cloud scenarios. Call the DescribeHybridCloudClusters operation to query information about Hybrid Cloud WAF clusters.	176

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Examples	array<object>	The list of API security examples.
	array<object>	The details of the API security example.
Protocol	string	The protocol type of the API request. Valid values: http: HTTP https: HTTPS	http
ApiUrl	string	The complete URL of the API request.	http://www.test.com/api/v1/hello.php?token=TkJGQw
PocPayload	string	The proof-of-concept (PoC) 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 sensitive data in the request.
	object	The information about the sensitive data in the request.
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 sensitive data in the response.
	object	The information about the sensitive data in the response.
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 content of the sample request. This is a string converted from a JSON object that consists of a series of parameters. The JSON object contains the following fields: method: the request method. host: the requested domain name. header: the request header. server_port: the service port. body: the request body. url: the URI of the request. server_protocol: the server-side protocol. Note If the body content exceeds 16 KB, only a portion of the 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 content of the sample response. This is a string converted from a JSON object that consists of a series of parameters. The JSON object contains the following fields: status: the status code. header: the response header. body: the response body. Note If the body content exceeds 16 KB, only a portion of the content is returned.	{ "header": { "Connection": "keep-alive", "Content-Encoding": "gzip", "Content-Type": "text/html; charset=UTF-8" }, "body": "xxxx", "status": 200 }
NextToken	string	The token that is used to retrieve the next page of results.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	The number of entries returned on each page. Valid values: 1 to 5. Default value: 5.	5
TotalCount	integer	The total number of entries returned.	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.