CreateAlertDestination - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Creates a contact for alert notifications.

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

sysom:CreateAlertDestination

create

*All Resource

*

None

Request syntax

POST /api/v1/alertPusher/alert/createDestination HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
app_id	string	No
app_secret	string	No
group_id	array	No
	string	No
imbot	boolean	No
name	string	No	The name of the alert contact.	test_name
params	object	No	The configuration parameters of the alert contact.
email	string	No	The email address.	xxx@email.com
phone	string	No	The phone number.	1xxx
sec	string	No	The chatbot secret key.	SECxxx
webhook	string	No	The webhook URL of the chatbot.	https://oapi.dingtalk.com/robot/send?access_token=xxx
source	string	No	The configuration source.	console
target	string	No	The notification target. Currently, only DingTalk chatbots are supported.	dingtalk

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The error code.	Success
data	object	The returned data.
createdAt	integer	The time when the contact was created.	1753669116286
id	integer	The policy ID.	1
name	string	The policy name.	SysOM
params	object	The configuration parameters of the alert contact.
email	string	The email address.	xxx@email.com
phone	string	The phone number.	1xxx
sec	string	The chatbot secret key.	SECxxx
webhook	string	The webhook URL of the chatbot.	https://oapi.dingtalk.com/robot/send?access_token=xxx
source	string	The configuration source.	console
target	string	The notification target. Currently, only DingTalk chatbots are supported.	dingtalk
uid	string	The user ID.	1222933234714935
updatedAt	integer	The time when the contact was last updated.	1751254826285
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the error message of the request.	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict
requestId	string	The request ID.	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success",
  "data": {
    "createdAt": 1753669116286,
    "id": 1,
    "name": "SysOM",
    "params": {
      "email": "xxx@email.com",
      "phone": "1xxx",
      "sec": "SECxxx",
      "webhook": "https://oapi.dingtalk.com/robot/send?access_token=xxx"
    },
    "source": "console",
    "target": "dingtalk",
    "uid": "1222933234714935",
    "updatedAt": 1751254826285
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Sysom.ServerError	Server error, please correct the code according to the error message. %s.	Server error, please correct the code according to the error message
400	SysomOpenAPI.ServerError	Server error, please correct the code according to the error message.	Server error, please correct the code according to the error message

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.