RunNotifyComponentWithEmail - Security Center - Alibaba Cloud Documentation Center

Runs the notification component to send an email message.

Operation description

Before calling this operation, understand the billing methods and pricing for Security Orchestration Application Response (SOAR). SOAR is billed based on the log traffic added to the service.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:RunNotifyComponentWithEmail

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Receivers	array	Yes	A list of email addresses.
	string	No	A single email address.	123xxx@163.com
Subject	string	Yes	The title of the email.	title
Content	string	Yes	The body of the email.	email content
PlaybookUuid	string	Yes	The UUID of the playbook. Note Call the DescribePlaybooks operation to obtain this parameter.	e99dab31-499b-4307-9248-xxxxxx
NodeName	string	Yes	The name of the playbook node.	notify_message_1
ComponentName	string	Yes	The name of the playbook component.	NotifyMessage
ActionName	string	Yes	The name of the component action.	notifyByCustom
AssetId	integer	Yes	The ID of the asset that is used to send the email. Note Call the DescribeComponentAssets operation to obtain this parameter.	10
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese en: English	zh
RoleType	string	No	The view type. Valid values: 0: The view of the current Alibaba Cloud account. 1: The view of all accounts that belong to the enterprise.	0
RoleFor	integer	No	The UID of the member whose data an administrator wants to access.	137602xxx718726

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.