RunNotifyComponentWithEmail - Security Center - Alibaba Cloud Documentation Center

Sends a message by using the email notification component.

Operation description

Before using this operation, make sure that you fully understand the billing method of the response orchestration product (threat analysis and response log ingestion traffic).

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	The list of email addresses.
	string	No	A single email address.	123xxx@163.com
Subject	string	Yes	The email subject.	title
Content	string	Yes	The email body.	email content
PlaybookUuid	string	Yes	The playbook UUID. Note You can call the DescribePlaybooks operation to obtain this parameter.	e99dab31-499b-4307-9248-xxxxxx
NodeName	string	Yes	The node name of the playbook.	notify_message_1
ComponentName	string	Yes	The component name of the playbook.	NotifyMessage
ActionName	string	Yes	The action name of the component.	notifyByCustom
AssetId	string	No	The resource instance ID of the email sender. Note You can 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 within the enterprise.	0
RoleFor	integer	No	The user ID of the member to which the administrator switches the view.	137602xxx718726

Response elements

Element	Type	Description	Example
	object	SophonResult
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for this request. You can use it to troubleshoot issues.	D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B
Data	string	The returned result data.	{}
Page	object	The pagination information.
TotalCount	integer	The total number of records.	30
PageNumber	integer	The page number of the current page in a paginated query.	1
PageSize	integer	The number of entries per page in a paginated query.	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.