DescribeAtiAlertSettings - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries alert settings.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	eyJhbGciOiJIUzI1NiIsInR5cC.....

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
AlertGroup	object
AlertGroup	array	The alert notification group.
	string	The alert notification group.	[\"Cloud Account Alarm Contact\"]
AlertConfig	object
AlertConfig	array<object>	The alert rule configuration.
	object	The alert rule configuration.
NoticeType	string	The alert event type: Identity certificate is about to expire Server certificate is about to expire Certificate has expired Certificate has been revoked	身份证书即将过期
SmsNotice	boolean	Indicates whether SMS alert notifications are configured. Valid values: true: Configured. When an alert event occurs, an SMS notification is sent. false: Not configured. SMS notifications are supported only on the China site (aliyun.com) and are not supported on the China site (Chinese mainland).	true
DingtalkNotice	boolean	Indicates whether DingTalk alert notifications are configured. Valid values: true: Configured. When an alert event occurs, a DingTalk notification is sent. false: Not configured.	false
EmailNotice	boolean	Indicates whether email alert notifications are configured. Valid values: true: Configured. When an alert event occurs, an email notification is sent. false: Not configured.	true
AccessDeniedDetail	object	The details about the access denial. This field is returned only when the RAM authentication fails.
AuthAction	string	The unauthorized operation that was attempted.	UpdateRspDomainServerProhibitStatusForGatewayOte
AuthPrincipalDisplayName	string	The display name of the authorization principal.	2015555733387XXXX
AuthPrincipalOwnerId	string	The ID of the authorization principal owner.	10469733312XXX
AuthPrincipalType	string	The identity type.	SubUser
EncodedDiagnosticMessage	string	The encrypted complete diagnostic message.	AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==
NoPermissionType	string	The reason for the authentication failure. Valid values: ExplicitDeny: explicit deny. ImplicitDeny: implicit deny.	ImplicitDeny
PolicyType	string	The policy type.	DlpSend

Examples

Success response

JSON format

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF55925",
  "AlertGroup": {
    "AlertGroup": [
      "[\\\"云账号报警联系人\\\"]"
    ]
  },
  "AlertConfig": {
    "AlertConfig": [
      {
        "NoticeType": "身份证书即将过期",
        "SmsNotice": true,
        "DingtalkNotice": false,
        "EmailNotice": true
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "UpdateRspDomainServerProhibitStatusForGatewayOte",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "10469733312XXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "DlpSend"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.