GetAlertDestination - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Retrieves the information of a specified alert contact.

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

get

*All Resource

*

None

Request syntax

GET /api/v1/alertPusher/alert/getDestination HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
id	integer	No	The alert contact ID.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The status code. `code == Success` indicates that the authorization is successful. Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault message.	Success or Sysom.ServerError
data	object	The returned data.
createdAt	string	The creation time.	1751520976660
id	integer	The alert contact ID.	1
name	string	The alert contact name.	name1
params	any	The configuration parameters.	{ "webhook":"", "sec":"", }
source	string	The configuration source.	console
target	string	The alert push target. Currently, only DingTalk chatbots are supported.	dingtalk
uid	string	The user ID.	1234123412352311
updatedAt	string	The update time.	1751254826285
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
requestId	string	The request ID.	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success or Sysom.ServerError",
  "data": {
    "createdAt": "1751520976660",
    "id": 1,
    "name": "name1",
    "params": "{\n    \"webhook\":\"\",\n    \"sec\":\"\",\n}",
    "source": "console",
    "target": "dingtalk",
    "uid": "1234123412352311",
    "updatedAt": "1751254826285"
  },
  "message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
  "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.