ListAlerts

Updated at:

Retrieves alert information.

Operation description

Calls the ListAlerts operation to retrieve source alert information.

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

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:::vodSource/mySourceLocation/MySource

Category

string

No

The alert type. Valid values:

  • Scheduling Error: An error occurred while building the schedule.

  • PlayBack Warning: An exception occurred while pulling the address when adding a source.

  • info: Information.

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:::vodSource/mySourceLocation/MySource

Code

string

The error code.

ScheduleError

Message

string

The error message.

xxxxx

Category

string

The category. Valid values:

  • Scheduling Error: An error occurred while building the schedule.

  • PlayBack Warning: An exception occurred while pulling the address when adding a source.

  • info: Information.

Scheduling Error

RelatedResourceArns

string

The ARNs of related resources.

acs:ims:mediaweaver:::vodSource/mySourceLocation/MySource

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.