DescribeLiveStreamsNotifyRecords - ApsaraVideo Live - Alibaba Cloud Documentation Center

You can call this operation to query stream callback records.

Operation description

The queries per second (QPS) limit for this operation is 100 for each user. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.

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

live:DescribeLiveStreamsNotifyRecords

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The ingest domain.	push.example1.com
AppName	string	No	The name of the application to which the stream belongs. You can view the AppName on the Stream management page.	app
StreamName	string	No	The name of the stream. You can view the StreamName on the Stream management page.	stream
Status	string	No	Indicates whether the callback was successful. success: The callback was successful. failed: The callback failed.	success
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The start time must be within the last 7 days.	2017-12-10T08:00:00Z
EndTime	string	Yes	The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-10T09:00:00Z
PageSize	integer	No	The number of entries to return on each page. Default value: 20. Maximum value: 500. Valid values: an integer from 1 to 500.	20
PageNumber	integer	No	The page number. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	The stream ingest callback records.
NotifyRecordsInfo	object
LiveStreamNotifyRecordsInfo	array<object>	The stream ingest callback records.
	object
NotifyType	string	The callback type. publish: a stream ingest event. publish_done: a stream interruption event.	publish_done
Description	string	The description of the result. If the operation is successful, `success` is returned. If the operation fails, an error message is returned.	success
StreamName	string	The name of the stream.	stream
NotifyTime	string	The time when the callback occurred. The time is in UTC.	2022-10-19T19:09:28Z
DomainName	string	The ingest domain.	push.example1.com
NotifyContent	string	The content of the callback.	{\"action\":\"publish_done\",\"app\":\"push.example1.com\"}
NotifyUrl	string	The callback URL.	http://xx.xx.xx.xx/callbacks
NotifyResult	string	The result of the callback. success: The callback was successful. failed: The callback failed.	success
AppName	string	The name of the application to which the stream belongs.	app
NotifyResponse	string	The response returned by the client after the client receives the callback.	{"Code":0,"Msg":"Success"}
NotifyHeader	string
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
RequestId	string	The request ID.	F675E4B4-125D-1533-901B-11A724644285
TotalNum	integer	The total number of entries that meet the filter criteria.	20
TotalPage	integer	The total number of pages.	20

Examples

Success response

JSON format

{
  "NotifyRecordsInfo": {
    "LiveStreamNotifyRecordsInfo": [
      {
        "NotifyType": "publish_done",
        "Description": "success",
        "StreamName": "stream",
        "NotifyTime": "2022-10-19T19:09:28Z",
        "DomainName": "push.example1.com",
        "NotifyContent": "{\\\"action\\\":\\\"publish_done\\\",\\\"app\\\":\\\"push.example1.com\\\"}",
        "NotifyUrl": "http://xx.xx.xx.xx/callbacks",
        "NotifyResult": "success",
        "AppName": "app",
        "NotifyResponse": "{\"Code\":0,\"Msg\":\"Success\"}",
        "NotifyHeader": ""
      }
    ]
  },
  "PageNum": 1,
  "PageSize": 20,
  "RequestId": "F675E4B4-125D-1533-901B-11A724644285",
  "TotalNum": 20,
  "TotalPage": 20
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	Specified parameter EndTime is not valid.
400	InvalidParam	Parameter invalid.	Illegal input parameters
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.
400	Duration.Exceed	StartTime needs to be within the last 7 days.
500	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.