All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamsNotifyRecords

Last Updated:Nov 14, 2024

Queries stream ingest callback records.

Operation description

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveStreamsNotifyRecordsget
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The ingest domain.

push.example1.com
AppNamestringNo

The name of the application to which the live stream belongs. You can view the application name on the Stream Management page of the ApsaraVideo Live console.

app
StreamNamestringNo

The name of the live stream. You can view the stream name on the Stream Management page of the ApsaraVideo Live console.

stream
StatusstringNo

Specifies whether to return the records of successful or failed callbacks. Valid values:

  • success
  • failed
success
StartTimestringYes

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note The start time must be in the last seven days.
2017-12-10T08:00:00Z
EndTimestringYes

The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2017-12-10T09:00:00Z
PageSizeintegerNo

The number of entries per page. Default value: 20. Maximum value: 500. Valid values: integers from 1 to 500.

20
PageNumberintegerNo

The page number. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The stream ingest callback records.

NotifyRecordsInfoarray<object>

The stream ingest callback records.

LiveStreamNotifyRecordsInfoobject
AppNamestring

The name of the application to which the live stream belongs.

app
Descriptionstring

The result of the request. If success is returned, the request is successful. If an error message is returned, the request failed.

success
DomainNamestring

The ingest domain.

push.example1.com
NotifyContentstring

The callback content.

{\"action\":\"publish_done\",\"app\":\"push.example1.com\"}
NotifyResultstring

The callback result. Valid values:

  • success
  • failed
success
NotifyTimestring

The time when the callback was invoked. The time is displayed in UTC.

2022-10-19T19:09:28Z
NotifyTypestring

The event. Valid values:

  • publish: The stream ingest starts.
  • publish_done: The stream ingest is interrupted.
publish_done
NotifyUrlstring

The callback URL.

http://xx.xx.xx.xx/callbacks
StreamNamestring

The name of the live stream.

stream
PageNuminteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
RequestIdstring

The request ID.

F675E4B4-125D-1533-901B-11A724644285
TotalNuminteger

The total number of entries that meet the specified conditions.

20
TotalPageinteger

The total number of pages.

20

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedSpecified parameter StartTime is not valid.-
400InvalidEndTime.MalformedSpecified parameter EndTime is not valid.-
400InvalidParamParameter invalid.Illegal input parameters
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.-
400Duration.ExceedStartTime needs to be within the last 7 days.-
500InternalErrorThe request processing has failed due to backend service exception.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-14The Error code has changedView Change Details