ListAlerts
Retrieves alert information.
Operation description
Calls the ListAlerts operation to retrieve source alert information.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ice:ListAlerts |
none |
*All Resource
|
None | None |
Request syntax
POST / HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageNo |
integer |
No |
The current page number. Default value: 1. |
1 |
| PageSize |
integer |
No |
The page size. |
20 |
| ResourceArn |
string |
Yes |
The resource ARN of the source or program. |
acs:ims:mediaweaver: |
| Category |
string |
No |
The alert type. Valid values:
|
Scheduling Error |
| SortBy |
string |
No |
The sorting parameter. By default, items are sorted in descending order of creation time. |
asc |
| SortByModifiedTime |
string |
No |
Sorts items by modification time. |
asc |
| GmtStart |
string |
No |
The start time. |
2024-11-21T16:10:45Z |
| GmtEnd |
string |
No |
The end time. |
2024-11-22T16:10:45Z |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
xxx-xxxx-xxxxx-xxxx |
| TotalCount |
integer |
The total number of entries that meet the conditions. |
100 |
| PageNo |
integer |
The current page number. Default value: 1. |
1 |
| PageSize |
integer |
The number of entries per page. Default value: 10. Maximum value: 100. |
10 |
| Alerts |
array<object> |
The alert list. |
|
|
object |
The alert details. |
||
| ResourceArn |
string |
The resource ARN. |
acs:ims:mediaweaver: |
| Code |
string |
The error code. |
ScheduleError |
| Message |
string |
The error message. |
xxxxx |
| Category |
string |
The category. Valid values:
|
Scheduling Error |
| RelatedResourceArns |
string |
The ARNs of related resources. |
acs:ims:mediaweaver: |
| GmtCreate |
string |
The creation time. |
2024-07-16T10:03Z |
| GmtModified |
string |
The modification time. |
2024-07-16T10:03Z |
Examples
Success response
JSON format
{
"RequestId": "xxx-xxxx-xxxxx-xxxx",
"TotalCount": 100,
"PageNo": 1,
"PageSize": 10,
"Alerts": [
{
"ResourceArn": "acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource",
"Code": "ScheduleError",
"Message": "xxxxx",
"Category": "Scheduling Error",
"RelatedResourceArns": "acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource",
"GmtCreate": "2024-07-16T10:03Z",
"GmtModified": "2024-07-16T10:03Z"
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.