Creating a Security Report

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Region

Yes

String

region id

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

• application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

• application/json;charset=UTF-8

Default Value

N/A

report_name

Yes

String

Report name.

report_period

Yes

String

Report period. The options are weekly, daily, annual, and monthly.

report_range

Yes

report_range object

Data scope.

language

Yes

String

Language.

notification_task

No

String

Notification task ID.

layout_id

Yes

String

Layout ID.

title

No

String

Email subject.

to

No

String

Recipient email address.

cc

No

String

CC recipient email address.

content

No

String

Email content.

report_file_type

No

String

Report type. Image, PDF, and HTML are supported.

frequency

No

String

Report sending frequency. The options are daily, monthly, and weekly.

binding_wizard

Yes

String

Report content.

timezone

No

String

Information.

report_rule_infos

No

Array of ReportRuleRequest objects

report rules

start

Yes

String

Start time.

end

Yes

String

End time.

rule

No

String

Cron expression of the report sending task.

ruleEnd

No

String

End time for starting the report sending task.

start_time

No

start_time object

Start time of the report statistical period.

end_time

No

end_time object

End time of the report statistical period.

day

No

Integer

Date of the report statistical period. -1: the previous day; 0: the current day.

week

No

Integer

Date of the report statistical period. -1: the previous week; 0: the current week.

month

No

Integer

Date of the report statistical period. -1: the previous month; 0: the current month.

time

No

String

Start time of the report statistical period. The time is in the format of hour:minute:second.

day

No

Integer

Date of the report statistical period. -1: the previous day; 0: the current day.

week

No

Integer

Date of the report statistical period. -1: the previous week; 0: the current week.

month

No

Integer

Date of the report statistical period. -1: the previous month; 0: the current month.

time

No

String

End time of the report statistical period. The time is in the format of hour:minute:second.

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

id

String

Report ID.

report_name

String

Report name.

report_period

String

Report period. The options are weekly, daily, annual, and monthly.

report_range

report_range object

Data scope.

language

String

Language.

notification_task

String

Notification task ID.

layout_id

String

Layout ID.

status

String

Report status. enable or disable.

is_generated

Boolean

Whether the report has been generated.

report_rule_infos

Array of ReportRuleInfo objects

report rules

start

String

Start time.

end

String

End time.

id

String

Report sending rule ID.

project_id

String

User ID.

workspace_id

String

Workspace ID.

cycle

String

Data period.

rule

String

Cron expression.

start_time

String

Start time of the report data period.

end_time

String

End time of the report data period.

email_title

String

Email subject.

email_to

String

Recipient email address.

email_content

String

Email content.

report_file_type

String

Report type. Image, PDF, and HTML are supported.

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

200

Request succeeded.

400

Request failed.