Querying the List on the Report Overview Page

Function

This API is used to query the list on the report overview page.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/report/report-list

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
report_category	No	String	Definition "Report type. If this parameter is not specified, all reports are selected by default." Constraints N/A Range daily_report: daily security reports weekly_report: weekly security reports monthly_report: monthly security reports custom_report: custom security reports Default Value N/A. If this parameter is not specified, all options are selected by default.
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of SecurityReportResponseInfo objects	Definition List on the report overview page. Range 0 to 2,147,483,647 items

**Table 5** SecurityReportResponseInfo
Parameter	Type	Description
report_id	Integer	Definition Report ID. Range 10 to 2,147,483,647 characters
report_sub_id	Integer	Definition Report sub ID. Range 10 to 2,147,483,647 characters
default_report	Boolean	Definition Whether the default value is used. The default value cannot be deleted. Range true: yes false: no
latest_create_time	Integer	Definition Latest generation time, in milliseconds. (If the returned value is null, the generation has not been performed.) Range N/A
report_name	String	Definition Report name Range The value can contain 1 to 128 characters.
report_category	String	Definition Report type. Range daily_report: daily security reports weekly_report: weekly security reports monthly_report: monthly security reports custom_report: custom security reports
report_status	String	Definition Report enabling status. Range opened closed
report_create_time	Integer	Definition Report creation time. Range N/A
sending_period	String	Definition Time range for sending reports. Range morning: 00:00 to 06:00 noon: 06:00 to 12:00 afternoon: 12:00 to 18:00 evening: 18:00 to 24:00

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "report_id" : 444,
  "report_sub_id" : 555,
  "default_report" : true,
  "report_name" : "YWK test. It is not intended for all the enterprise projects.",
  "report_category" : "custom_report",
  "report_status" : "opened",
  "report_create_time" : 1744512829390,
  "latest_create_time" : 1774196836964
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Security Reports

Previous topic: Security Reports

Next topic: Sending a Security Report

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot