DescribeApisecExamples - 查询API安全样例信息 - Web 应用防火墙

查询API安全样例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例 ID。说明您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。	waf_elasticity-cn-0xldbqtm005
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q
ApiId	string	是	API 的 ID。	867ade***24ee6e205b8da82b8f84
ExampleType	string	否	样例的类型。取值： sensitive：表示敏感信息类型。 risk：表示风险类型。	sensitive
RequestSensitiveTypeList	array	否	请求敏感信息类型列表。
	string	否	请求敏感信息类型。	1001
ResponseSensitiveTypeList	array	否	响应敏感信息类型列表。
	string	否	响应敏感信息类型。	1001
AbnormalTag	string	否	风险类型。	LackOfSpeedLimit
NextToken	string	否	下一页查询凭证（Token）。	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	否	分页查询时每页个数。取值范围为：1-5，默认值为 5。	5
ClusterId	string	否	混合云集群 ID。说明只针对混合云场景，您可以调用 DescribeHybridCloudClusters 获取混合云集群信息。	176

返回参数

名称	类型	描述	示例值
	object	请求结果。
RequestId	string	本次请求的 ID。	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Examples	array<object>	样例列表。
	array<object>	样例信息。
Protocol	string	协议的类型。取值： http：表示 http 协议。 https：表示 https 协议。	http
ApiUrl	string	完整请求路径。	http://www.test.com/api/v1/hello.php?token=TkJGQw
PocPayload	string	验证请求。	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>	请求敏感数据信息列表。
	object	请求敏感数据信息。
SensitiveCode	string	敏感信息类型。	1000
SensitiveDataList	array	敏感信息数据列表。
	string	敏感信息数据。	90.88.49.19
ResponseSensitiveData	array<object>	响应敏感数据信息列表。
	object	响应敏感数据信息。
SensitiveCode	string	敏感信息类型。	1000
SensitiveDataList	array	敏感信息数据列表。
	string	敏感信息数据。	90.88.49.19
Request	string	样例请求内容，以一系列参数构造的 JSON 格式转化成字符串。包含的字段如下： method：表示请求方法。 host：表示请求域名。 header：表示请求头。 server_port：表示服务端口。 body：表示请求体内容。 url：表示请求路径。 server_protocol：表示服务端协议。说明当 body 内容超过 16K，仅返回部分内容。	{ "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	样例响应内容，以一系列参数构造的 JSON 格式转化成字符串。包含的字段如下： status：表示状态码。 header：表示响应头。 body：表示响应体内容。说明当 body 内容超过 16K，仅返回部分内容。	{ "header": { "Connection": "keep-alive", "Content-Encoding": "gzip", "Content-Type": "text/html; charset=UTF-8" }, "body": "xxxx", "status": 200 }
NextToken	string	下一页查询凭证（Token）。	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	分页查询时每页个数。取值范围为：1-5，默认值为 5。	5
TotalCount	integer	结果的总数。	5

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。