Querying the List of Historical Security Report Statistics Periods

This API is used to query the list of historical security report statistics periods.

For details, see Calling APIs.

GET /v1/{project_id}/waf/security-report/history-periods

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Tenant project ID, which is used to identify the project to which the tenant belongs. To obtain the project ID, log in to the console, click the username, choose My Credentials, locate the project in the Projects list, and check the project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
subscription_id	Yes	String	Definition Subscription ID, which is associated with the security report subscription to be queried. The value can be obtained by calling the API for querying the security report subscription list. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Number of historical security report statistics periods returned. This parameter is used for pagination query. Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Offset, which indicates the starting position in a pagination query for historical security report statistics periods. The counting starts from 0. Constraints N/A Range N/A Default Value N/A

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition Tenant token, which is used for identity authentication. You can obtain the token by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header. Constraints N/A Range Length: 32 to 4096 characters Default Value N/A
Content-Type	Yes	String	Definition Content type, which specifies the data format of the request body. Constraints N/A Range Length: 32 to 64 characters Default Value application/json;charset=utf8

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Definition Total number of records in the historical statistical period of the security report. Constraints N/A Range ≥ 0 Default Value 0
items	Array of items objects	Definition Detailed list of historical statistical periods of security reports. Constraints N/A Range N/A Default Value N/A

**Table 5** items
Parameter	Type	Description
report_id	String	Definition Report ID, which uniquely identifies the security report corresponding to the historical statistical period. Constraints N/A Range N/A Default Value N/A
subscription_id	String	Definition Subscription ID, which is associated with the security report subscription of the historical statistical period. Constraints N/A Range N/A Default Value N/A
stat_period	stat_period object	Definition Statistical period, which is the time range of a historical report. Constraints N/A Range N/A Default Value N/A

**Table 6** stat_period
Parameter	Type	Description
begin_time	Long	Definition Start time, which is the start timestamp (in milliseconds) of the statistical period. Constraints N/A Range N/A Default Value N/A
end_time	Long	Definition End time, which is the end timestamp (in milliseconds) of the statistical period. Constraints N/A Range N/A Default Value N/A

Status code: 400

**Table 7** Response body parameters
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.

**Table 8** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Status code: 401

**Table 9** Response body parameters
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.

**Table 10** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Status code: 500

**Table 11** Response body parameters
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.