All Products
Search
Document Center

Security Center:DescribeNoticeConfig

Last Updated:Nov 13, 2024

Queries notification settings.

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

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

60.191.XX.XX

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

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

D185B7FF-E24C-422D-83D3-C2A25C7A2727
NoticeConfigListarray<object>

An array that consists of the notification settings.

NoticeConfigobject

The notification settings.

TimeLimitinteger

The time period during which Security Center sends notifications. Valid values:

  • 0: any time
  • 1: 08:00 to 22:00
1
AliUidlong

The ID of the user.

12123414****
CurrentPageinteger

The page number of the returned page.

1
Projectstring

The identifier of the notification item. Valid values:

  • yundun_security_Weekreport: notification for vulnerabilities
  • yundun_sas_antiransomware_task: notification for results of restoration tasks
  • sas_healthcheck: notification for baseline checks
  • sas_suspicious: notification for alerts generated by Security Center
  • yundun_aegis_AV_true: notification for precision defense
  • yundun_sas_ak_leakage: notification for AccessKey pair leaks
  • yundun_sas_config_alert: notification for configuration assessment
  • yundun_sas_vul_Emergency: notification for urgent vulnerabilities
  • yundun_webguard_event: notification for web tamper proofing
  • yundun_sas_cloud_native_firewall: notification for alerts generated by the container firewall feature
  • yundun_sas_cloud_native_firewall_Defense: notification for proactive defense implemented by the container firewall feature
  • yundun_IP_Blocking: notification for blocked brute-force attacks initiated from malicious IP addresses
  • yundun_sas_anti_virus_config: notification for virus scan
  • yundun_sas_log: notification for excess logs
  • yundun_honeypot_alarm: notification for alerts generated by the honeypot feature
  • aliyun_rasp_alarm: notification for alerts generated by the application security feature
  • virusScheduleTask: notification for completion of scheduled virus scans
  • yundun_anti_Virus: notification that no security checks are performed
  • sas_vulnerability: notification for vulnerabilities
  • weeklyreport: notification for weekly reports
  • agent: notification that the Security Center agent is offline
  • bruteforcesuccess: notification for protection against brute-force attacks
  • webshell: notification for webshells
  • suspicious: notification for alerts generated by Server Guard
  • patch: deprecated
  • remotelogin: notification for remote logons
  • health: notification for security checks
  • yundun_sas_cloudsiem_log: notifications of insufficient threat analysis log capacity
Note If the value is yundun_security_Weekreport, weekly reports are sent to notify you of unhandled vulnerabilities.
sas_suspicious
Routeinteger

The notification method. Valid values:

  • 1: text message
  • 2: email
  • 4: internal message
  • 3: text message and email
  • 5: text message and internal message
  • 6: email and internal message
  • 7: text message, email, and internal message
7

Examples

Sample success responses

JSONformat

{
  "RequestId": "D185B7FF-E24C-422D-83D3-C2A25C7A2727",
  "NoticeConfigList": [
    {
      "TimeLimit": 1,
      "AliUid": 0,
      "CurrentPage": 1,
      "Project": "sas_suspicious",
      "Route": 7
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500UnknownErrorThe request processing has failed due to some unknown error.-
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
No change history