RunNotifyComponentWithEmail - Security Center - Alibaba Cloud Documentation Center

Runs the email notification component to send messages.

Operation description

Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see Pricing .

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:RunNotifyComponentWithEmail	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Receivers	array	Yes	The email addresses.
Receiver	string	Yes	The email address.	123xxx@163.com
Subject	string	Yes	The subject of the email.	title
Content	string	Yes	The body of the email.	email content
PlaybookUuid	string	Yes	The UUID of the playbook. Note You can call the DescribePlaybooks operation to query the UUIDs of playbooks.	e99dab31-499b-4307-9248-xxxxxx
NodeName	string	Yes	The name of the node in the playbook.	notify_message_1
ComponentName	string	Yes	The name of component in the playbook.	NotifyMessage
ActionName	string	Yes	The action name of the component.	notifyByCustom
AssetId	integer	Yes	The resource instance ID of the email sender. Note You can call the DescribeComponentAssets operation to query the ID.	10
Lang	string	No	The language of the content within the request and the response. Valid value: zh (default): Chinese. en: English.	zh
RoleType	string	No	The type of the view. Valid values: 0: the view of the current Alibaba Cloud account. 1: the view of all accounts for the enterprise.	0
RoleFor	long	No	The ID of the user who switches from the current view to the destination view by using the management account.	137602xxx718726

Response parameters

Parameter	Type	Description	Example
	object	SophonResult
RequestId	string	The request ID.	D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B
Data	string	The data returned.	{}
Page	object	The pagination information.
TotalCount	integer	The total number of entries returned.	30
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B",
  "Data": {},
  "Page": {
    "TotalCount": 30,
    "PageNumber": 1,
    "PageSize": 10
  }
}

Error codes

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