All Products
Search
Document Center

Security Center:DescribeCustomizeReportList

Last Updated:Nov 13, 2024

Queries security reports.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeCustomizeReportListlist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
ReportStatusintegerNo

The state of the report. Valid values:

  • 0: disabled
  • 1: enabled
1
ReportTypeintegerNo

The type of the report. Valid values:

  • 0: daily report
  • 1: weekly report
  • 2: monthly report
  • 3: report whose statistics are collected in a custom time range
0
TitlestringNo

The name of the report.

test
ReportVersionstringNo

The report version. Valid values:

  • 1.0.0
  • 2.0.0
2.0.0
PinnedbooleanNo

Specifies whether to pin the report. Valid values:

  • false
  • true
false

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

9FBC6E47-7508-58C9-9E76-528E118CB1CC
ReportListarray<object>

The reports.

Reportobject

The information about the report.

ReportStatusstring

The state of the report. Valid values:

  • 0: disabled
  • 1: enabled
0
IsDefaultstring

Indicates whether the report is the default report. Valid values:

  • 0: no
  • 1: yes
1
ReportTypeinteger

The type of the report. Valid values:

  • 0: daily report
  • 1: weekly report
  • 2: monthly report
  • 3: report whose statistics are collected in a custom time range
0
ReportIdlong

The ID of the report.

1
Titlestring

The name of the report.

test
ReportVersionstring

The report version.

2.0.0
ReportStartDatelong

The start date on which the report is sent. The value is a UNIX timestamp. Unit: milliseconds.

1721836800000
ReportEndDatelong

The end date on which the report is sent. The value is a UNIX timestamp. Unit: milliseconds.

1721923199999
PinnedTimelong

The timestamp when the report is pinned. Unit: milliseconds.

1721836800000
ReportDaysinteger

The most recent days for report statistics.

7

Examples

Sample success responses

JSONformat

{
  "RequestId": "9FBC6E47-7508-58C9-9E76-528E118CB1CC",
  "ReportList": [
    {
      "ReportStatus": "0",
      "IsDefault": "1",
      "ReportType": 0,
      "ReportId": 1,
      "Title": "test",
      "ReportVersion": "2.0.0",
      "ReportStartDate": 1721836800000,
      "ReportEndDate": 1721923199999,
      "PinnedTime": 1721836800000,
      "ReportDays": 7
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParamIllegal param-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.