All Products
Search

This Product

    Security Center:RunNotifyComponentWithMessageCenter

    Document Center

    Security Center:RunNotifyComponentWithMessageCenter

    Last Updated:Dec 10, 2025

    Sends a message using the notification component in Message Center.

    Operation description

    Before you call this operation, make sure that you understand the billing methods and pricing of Security Orchestration Automation Response (SOAR). The service is billed based on the log traffic for threat analysis and response.

    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:RunNotifyComponentWithMessageCenter

    create

    *All Resource

    *

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    Aliuid

    string

    Yes

    The ID of the user who receives the message.

    146789xxxx733152

    EventId

    string

    Yes

    The ID of the message event in Message Center. Valid values:

    • yundun_soar_incident_generate: An event is generated.

    • yundun_soar_alert_generate: An alert is generated.

    • yundun_soar_incident_update: An event is updated.

    yundun_soar_incident_generate

    Params

    string

    No

    The template parameters for the message event.

    • Event generation: aliyunUID, incidentName, incidentID, startTime

    • Alert generation: aliyunUID, alertName, alertID, startTime

    • Event update: aliyunUID, incidentName, incidentID, startTime, endTime, status, level

    {"startTime":"test222","incidentName":"test123","incidentID":"teset123"}

    ChannelTypeList

    array

    No

    A collection of channel types. If you do not specify this parameter, messages are sent through all channels by default.

    string

    No

    A channel type. Valid values:

    • sms: text message

    • email: email

    • webhook: DingTalk group webhook

    • pmsg: internal message

    sms

    PlaybookUuid

    string

    Yes

    The UUID of the playbook.

    Note

    Call the DescribePlaybooks operation to obtain the value of this parameter.

    c5c88b5e-97ca-435d-8c20-xxxxxx

    NodeName

    string

    Yes

    The name of the playbook node.

    notify_message

    ComponentName

    string

    Yes

    The name of the playbook component.

    NotifyMessage

    ActionName

    string

    Yes

    The name of the playbook action.

    notifyByMessageCenter

    AssetId

    integer

    No

    The ID of the asset. This parameter is deprecated.

    1

    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 (default): The view of the current Alibaba Cloud account.

    • 1: The view of all accounts that belong to the enterprise.

    0

    RoleFor

    integer

    No

    The user ID of the member. This parameter is used when an administrator calls the operation on behalf of a member.

    1467894xxx733152

    Response elements

    Element

    Type

    Description

    Example

    object

    SophonResult

    RequestId

    string

    The unique ID generated for the request. You can use this ID to troubleshoot issues.

    E7698CFB-4E1C-5840-8EC9-691B86729E94

    Data

    string

    The data returned.

    {}

    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 per page.

    10

    Examples

    Success response

    JSON format

    {
  "RequestId": "E7698CFB-4E1C-5840-8EC9-691B86729E94",
  "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.