Querying Bot Request Trends Reported in Bot Protection
Function
This API is used to query bot request trends reported in bot protection.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/waf/overviews/bot-manager/bot-request-on-timeline
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Tenant project ID. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
start_time |
Yes |
Integer |
Definition Start time. Constraints N/A Range N/A Default Value N/A |
end_time |
Yes |
Integer |
Definition End time. Constraints N/A Range N/A Default Value N/A |
tenant_id |
No |
String |
Definition Tenant ID. Constraints N/A Range N/A Default Value N/A |
enterprise_project_id |
No |
String |
Definition Enterprise project ID. Constraints N/A Range N/A Default Value N/A |
hosts |
No |
Array of strings |
Definition Domain name. Constraints N/A Range N/A Default Value N/A |
domain |
No |
String |
Definition Domain name. Constraints N/A Range N/A Default Value N/A |
region |
No |
String |
Definition Region. Constraints N/A Range N/A Default Value N/A |
site |
No |
String |
Definition Protected website. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
start_time |
String |
Definition Start time of a statistical period. Constraints N/A Range N/A Default Value N/A |
end_time |
String |
Definition End time of a statistical period. Constraints N/A Range N/A Default Value N/A |
time_span |
String |
Definition Interval, for example, 1h indicates every hour. Constraints N/A Range N/A Default Value N/A |
timelines |
Array of BotRequestTimeline objects |
Definition Request trend data at a specific time point. Constraints N/A Range N/A Default Value N/A |
Parameter |
Type |
Description |
---|---|---|
datetime |
String |
Definition Time point, for example, 2023-10-01 00:00:00. Constraints N/A Range N/A Default Value N/A |
normal_request_count |
Integer |
Definition Number of normal requests at the time point. Constraints N/A Range ≥0 Default Value 0 |
known_bot_matched_count |
Integer |
Definition Number of requests that match known bots at the specified time point. Constraints N/A Range ≥0 Default Value 0 |
transparent_matched_count |
Integer |
Definition Number of requests that match transparent detection at the specified time point. Constraints N/A Range ≥0 Default Value 0 |
behavior_matched_count |
Integer |
Definition Number of behavior detection requests at the specified time point. Constraints N/A Range ≥0 Default Value 0 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot