Querying the Sending Records of a Security Report

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

report_name

No

String

Definition

Report name, which is used to filter the sending records of a specific security. Fuzzy match is supported.

Constraints

N/A

Range

N/A

Default Value

N/A

report_category

No

String

Definition

Report type, which is used to filter the sending records of a specific security report type, such as daily, weekly, and monthly reports.

Constraints

N/A

Range

N/A

Default Value

N/A

limit

No

Long

Definition

Number of records that can be returned in a single query. This parameter is used for pagination query.

Constraints

N/A

Range

N/A

Default Value

N/A

offset

No

Long

Definition

Offset, which indicates the starting position in a pagination query, with counting starting at 0.

Constraints

N/A

Range

N/A

Default Value

N/A

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

total

Integer

Definition

Total number of security report sending records.

Constraints

N/A

Range

≥ 0

Default Value

0

items

Array of items objects

Definition

Detailed list of security report sending records.

Constraints

N/A

Range

N/A

Default Value

N/A

report_id

String

Definition

Report ID, which uniquely identifies the security report corresponding to the sending record.

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 sending record.

Constraints

N/A

Range

N/A

Default Value

N/A

report_name

String

Definition

Report name, which is the name of the security report corresponding to the sending record.

Constraints

N/A

Range

N/A

Default Value

N/A

stat_period

stat_period object

Definition

Statistical period, which is the time range of the report corresponding to the sending record.

Constraints

N/A

Range

N/A

Default Value

N/A

report_category

String

Definition

Report type, which indicates the type of the report corresponding to the sending record (for example, daily report or weekly report).

Constraints

N/A

Range

N/A

Default Value

N/A

sending_time

Long

Definition

Sending time, which is the timestamp (in milliseconds) when the report was sent.

Constraints

N/A

Range

N/A

Default Value

N/A

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

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.

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

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.

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

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.

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

200

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.