Retrieves a list of alert contacts.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
sysom:ListAlertDestinations |
list |
*All Resource
|
None | None |
Request syntax
GET /api/v1/alertPusher/alert/listDestinations HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| name |
string |
No |
The name of the alert contact. |
name1 |
| maxResults |
integer |
No |
The maximum number of records to retrieve in a single request. |
10 |
| nextToken |
string |
No |
The pagination token for the next request. |
c2f78a783f49457caba6bace6f6f79e4 |
| current |
integer |
No |
The current page number (starting from 1). |
1 |
| pageSize |
integer |
No |
The number of records per page. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| code |
string |
The status code.
|
Success |
| data |
any |
The returned data. |
{} |
| maxResults |
integer |
The maximum number of records to retrieve in a single request. |
10 |
| message |
string |
The error message.
|
server error |
| nextToken |
string |
The pagination token for the next request. |
c2f78a783f49457caba6bace6f6f79e4 |
| requestId |
string |
The request ID. |
2D693121-C925-5154-8DF6-C09A8B369822 |
| total |
integer |
The maximum number of records returned by MaxResults for this request. |
623 |
Examples
Success response
JSON format
{
"code": "Success",
"data": "{}",
"maxResults": 10,
"message": "server error",
"nextToken": "c2f78a783f49457caba6bace6f6f79e4",
"requestId": "2D693121-C925-5154-8DF6-C09A8B369822",
"total": 623
}
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.