DescribeReportRecipientStatus - Security Center - Alibaba Cloud Documentation Center

Queries the status of a report recipient by using the security report feature of the System Configuration module in the Security Center console.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeReportRecipientStatus	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	39.174.xxx.xxx
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
Recipients	string	Yes	The email address of the recipient. Separate multiple email addresses with commas (,).	username@example.com,username@example.com

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8
ReportRecipientList	array<object>	The report recipients.
ReportRecipient	object	The information about a single report recipient.
Recipient	string	The email address of the report recipient. Note If no email is specified when you create a report, the value of this parameter is empty.	username@example.com
IsVerify	integer	Indicates whether the email address is verified. Valid values: 0: no 1: yes Note If no email is specified when you create a report, the value of this parameter is empty.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8",
  "ReportRecipientList": [
    {
      "Recipient": "username@example.com",
      "IsVerify": 1
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	-101	%s %s	-
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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