All Products
Search

This Product

    Security Center:DescribeCustomizeReportConfigDetail

    Document Center

    Security Center:DescribeCustomizeReportConfigDetail

    Last Updated:Nov 14, 2024

    Obtains the configurations of a security report.

    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-aegis:DescribeCustomizeReportConfigDetailget
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    SourceIpstringNo

    The source IP address of the request.

    		202.104.XXX.XXX
    ReportIdlongYes

    The ID of the report.
    You can call the DescribeCustomizeReportList operation to query the ID.

    		619031
    LangstringNo

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

    • zh: Chinese
    • en: English
    		zh

    Response parameters

    ParameterTypeDescriptionExample
    object
    ReportStatusstring

    The status of the report. Valid values:

    • 0: disabled.
    • 1: enabled.
    		1
    ReportLangstring

    The language of the report. Default value: zh. Valid values:

    • zh: Chinese
    • en: English
    		zh
    ChartIdsstring

    The ID of the chart that is included in the report. Multiple IDs are separated by commas (,).

    		BIZ_STAT_QUERY_KEY_ATTACK,CUSTOM_VUL_CVE_LIST,CUSTOM_VUL_SYS_LIST,CUSTOM_VUL_WEBCMS_LIST,CUSTOM_AUTO_BREAKING_PIE,CUSTOM_AK_LEAK_LIST,KEY_HP_TAMPERPROOF,KEY_HP_DEFENCE
    IsDefaultinteger

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

    • 0: no.
    • 1: yes.
    		1
    SendTimestring

    The time at which the report is sent. The value is in the HH:mm:ss format.

    		09:00:00
    ReportIdlong

    The ID of the report.

    		663434
    ReportTypestring

    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.
    		3
    Recipientsstring

    The email address of the recipient. Multiple email addresses are separated by commas (,).

    		PengZheng@eaton.com,ZhongJi@Eaton.com
    RequestIdstring

    The request ID.

    		379a9b8f-107b-4630-9e95-2299a1ea****
    ReportSendTypestring

    The time range in which the report is sent. Valid values:

    • 1: 00:00 to 06:00.
    • 2: 06:00 to 12:00.
    • 3: 12:00 to 18:00.
    • 4: 18:00 to 24:00.
    		2
    ReportEndDatestring

    The end date on which the report is sent.

    		1720022399999
    ReportStartDatestring

    The start date on which the report is sent.

    		1717430400000
    Titlestring

    The title of the report.

    		marketing report
    SendStartTimestring

    The start time at which the report is sent. The value is in the HH:mm:ss format.

    		09:00:00
    SendEndTimestring

    The end time at which the report is sent. The value is in the HH:mm:ss format.

    		10:00:00
    PinnedTimelong

    The time when the report is pinned.

    		1717430400000
    ReportDaysinteger

    The most recent days for report statistics.

    		30
    SendPeriodTypestring

    The interval at which the report is sent. Valid values:

    • DAY
    • WEEK
    • MONTH
    		MONTH
    SendPeriodDaysinteger

    The exact day within the sending period.

    		12
    TargetUidsstring

    The ID of the Alibaba Cloud account. Multiple IDs are separated by commas (,).

    		1457515594445744,1600011353839072,1766185894104675,1674080148055995,1627510829033157
    GroupTypestring

    The grouping type. Valid values:

    • ALIYUN_RG
    • SAS_GROUP
    		SAS_GROUP
    TargetGroupsstring

    The groups.

    		12125884,12140191

    Examples

    Sample success responses

    JSONformat

    {
  "ReportStatus": "1",
  "ReportLang": "zh",
  "ChartIds": "BIZ_STAT_QUERY_KEY_ATTACK,CUSTOM_VUL_CVE_LIST,CUSTOM_VUL_SYS_LIST,CUSTOM_VUL_WEBCMS_LIST,CUSTOM_AUTO_BREAKING_PIE,CUSTOM_AK_LEAK_LIST,KEY_HP_TAMPERPROOF,KEY_HP_DEFENCE",
  "IsDefault": 1,
  "SendTime": "09:00:00",
  "ReportId": 663434,
  "ReportType": "3",
  "Recipients": "PengZheng@eaton.com,ZhongJi@Eaton.com",
  "RequestId": "379a9b8f-107b-4630-9e95-2299a1ea****",
  "ReportSendType": "2",
  "ReportEndDate": "1720022399999",
  "ReportStartDate": "1717430400000",
  "Title": "marketing report",
  "SendStartTime": "09:00:00",
  "SendEndTime": "10:00:00",
  "PinnedTime": 1717430400000,
  "ReportDays": 30,
  "SendPeriodType": "MONTH",
  "SendPeriodDays": 12,
  "TargetUids": "1457515594445744,1600011353839072,1766185894104675,1674080148055995,1627510829033157",
  "GroupType": "SAS_GROUP",
  "TargetGroups": "12125884,12140191"
}

    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.