Performs Tracing Analysis. You can use this operation to construct and initiate an impersonation HTTP/HTTPS request to the ESA platform, displaying the site configuration matching and effective settings on the ESA platform for the request.
Operation description
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Url |
string |
Yes |
The URL of the request. |
http://example.com/test |
| Protocol |
string |
No |
The HTTP protocol. Valid values:
|
HTTP/1.1 |
| Method |
string |
No |
The HTTP method. Valid values:
|
GET |
| Headers |
array<object> |
No |
The request headers. |
[] |
|
object |
No |
The request headers. |
||
| Name |
string |
No |
The HTTP request header name. |
User-Agent |
| Value |
string |
No |
The HTTP request header value. |
trace-test |
| Cookies |
array<object> |
No |
The cookie parameters. |
[] |
|
object |
No |
The cookie parameters. |
||
| Name |
string |
No |
The cookie name. |
sessionId |
| Value |
string |
No |
The cookie value. |
f9ca1f7d-15bb-4c60-ad99-71b8e3e4985b |
| Context |
object |
No |
The environment context. This parameter is optional. |
|
| GeoLocation |
object |
No |
The simulated geolocation information. |
|
| CountryCode |
string |
No |
The country/region code. Valid values:
|
CN |
| RegionCode |
string |
No |
The region or province code. This parameter is valid only when the country or region is the Chinese mainland. Valid values:
|
CN-BJ |
| IspCode |
string |
No |
The Internet service provider (ISP) code. This parameter is valid only when the country or region is the Chinese mainland. Valid values:
|
100025 |
| SkipChallenge |
boolean |
No |
Specifies whether to skip the security challenge test. |
true |
| Body |
object |
No |
The HTTP request body. |
{"PlainText":"bc58c54211db"} |
| Json |
any |
No |
The content in JSON format. If both JSON format content and plain text content are specified, the JSON format content takes precedence. |
{"request_id","3f809c32"} |
| PlainText |
string |
No |
The plain text content. |
bc58c54211db |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
9574AFDC-ABF1-5068-AAE3-6958CEBD8740 |
| StatusCode |
integer |
The HTTP status code of the request. |
200 |
| Trace |
array<object> |
The trace information of the call chain. |
|
|
array<object> |
The matching result of a feature module. |
||
| StepModuleName |
string |
The feature module. Valid values:
|
SecRules |
| Matched |
boolean |
Indicates whether the module is matched. Valid values: true and false. |
true |
| Trace |
array<object> |
The matching results of rules in the feature module. |
|
|
object |
The matched rule information. |
||
| RuleName |
string |
cache_test |
|
| Expression |
string |
(ip.geoip.country eq \"CN\") |
|
| RoutineId |
string |
test.1097011697834102 |
|
| Type |
string |
l4_ddos |
|
| OriginPoolName |
string |
21212.origin-pool.example.com |
|
| SiteVersion |
integer |
0 |
|
| EnvName |
string |
Production |
|
| ConfigType |
string |
rule |
|
| LoadBalancerName |
string |
Ib.test.example.com |
|
| RuleId |
integer |
1297141 |
|
| Level |
string |
week |
|
| DdosLevelDomestic |
string |
cn300 |
|
| DdosLevelOversea |
string |
unlimit |
|
| Action |
string |
deny |
|
| Value |
string |
1.1.1.1 |
|
| Success |
boolean |
Indicates whether the request was successful. |
true |
Examples
Success response
JSON format
{
"RequestId": "9574AFDC-ABF1-5068-AAE3-6958CEBD8740",
"StatusCode": 200,
"Trace": [
{
"StepModuleName": "SecRules",
"Matched": true,
"Trace": [
{
"RuleName": "cache_test",
"Expression": "(ip.geoip.country eq \\\"CN\\\")",
"RoutineId": "test.1097011697834102",
"Type": "l4_ddos",
"OriginPoolName": "21212.origin-pool.example.com",
"SiteVersion": 0,
"EnvName": "Production",
"ConfigType": "rule",
"LoadBalancerName": "Ib.test.example.com",
"RuleId": 1297141,
"Level": "week",
"DdosLevelDomestic": "cn300",
"DdosLevelOversea": "unlimit",
"Action": "deny",
"Value": "1.1.1.1"
}
]
}
],
"Success": true
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | The specified parameter is invalid. |
| 400 | InvalidURLParameter | The URL you entered is invalid. Please check the records of the site or the status of the site. | |
| 500 | InternalError | Failed to call the service. Try again later or contact technical support. | Failed to call the service. Try again later or contact technical support. |
| 403 | InvalidParameter.URL | The domain name in the URL you entered does not belong to this account. Please try another URL. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.