All Products
Search
Document Center

ApsaraVideo Live:ListEventSubEvent

Last Updated:Dec 05, 2024

Queries callback records.

Operation description

  • The maximum time range to query is seven days.
  • The minimum time granularity to query is 1 minute.
  • You can query data in the last seven days.

QPS limit

You can call this operation up to 50 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:ListEventSubEventlist
*Rtc
acs:live::{#accountId}:rtc/{#AppId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The application ID.

9qb1****
SubscribeIdstringNo

The subscription ID. You can obtain the ID from the response to the CreateEventSub operation.

ad53276431c****
StartTimelongYes

The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.

1698195600
EndTimelongYes

The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.

1698201013
PageSizelongYes

The number of callback records to return on each page. Valid values: 1 to 100.

10
PageNolongYes

The page number.

20

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CC8CB656-A7BA-1811-9D6B-4CC187E988BD
Countlong

The total number of callback records returned on the current page.

1
HasMoreboolean

Indicates whether the current page is followed by a page.

false
Logsarray<object>

The callback records.

logsobject
AppIdstring

The application ID.

9qb1****
SubIdstring

The subscription ID.

ad53276431c****
MessageIdstring

The ID of the callback record.

875d5266cbabb1834cc84a105cf6****
Datastring

The details about the callback.

{\"MsgId\":\"875d5266cbabb1834cc84a105cf68454\",\"MsgTimestamp\":1697545591,\"SubscribeId\":\"09be0d2254cb5a89f4cbd86403ec5343\",\"AppId\":\"xxx\",\"ChannelId\":\"9099\",\"Contents\":[{\"Event\":\"UserEvent\",\"UserEvent\":{\"UserId\":\"linux_test\",\"EventTag\":\"Leave\",\"SessionId\":\"je7y2sBZJZQ0VBJZrh4LnBkxvGH2WyVs\",\"Timestamp\":1697545591,\"ChannelProfile\":\"interactive_live\",\"US\":5068748604047364,\"Reason\":1,\"Role\":1,\"TerminalType\":6,\"UserType\":2}}]}
Costinteger

The callback duration. Unit: milliseconds.

22
Timestring

The time when the callback was generated.

2023-10-17 20:26:31.988
Urlstring

The callback URL.

http://****.com/callback
Codeinteger

The HTTP status code. A value of 200 indicates that the callback was successful.

200

Examples

Sample success responses

JSONformat

{
  "RequestId": "CC8CB656-A7BA-1811-9D6B-4CC187E988BD",
  "Count": 1,
  "HasMore": false,
  "Logs": [
    {
      "AppId": "9qb1****",
      "SubId": "ad53276431c****",
      "MessageId": "875d5266cbabb1834cc84a105cf6****",
      "Data": "{\\\"MsgId\\\":\\\"875d5266cbabb1834cc84a105cf68454\\\",\\\"MsgTimestamp\\\":1697545591,\\\"SubscribeId\\\":\\\"09be0d2254cb5a89f4cbd86403ec5343\\\",\\\"AppId\\\":\\\"xxx\\\",\\\"ChannelId\\\":\\\"9099\\\",\\\"Contents\\\":[{\\\"Event\\\":\\\"UserEvent\\\",\\\"UserEvent\\\":{\\\"UserId\\\":\\\"linux_test\\\",\\\"EventTag\\\":\\\"Leave\\\",\\\"SessionId\\\":\\\"je7y2sBZJZQ0VBJZrh4LnBkxvGH2WyVs\\\",\\\"Timestamp\\\":1697545591,\\\"ChannelProfile\\\":\\\"interactive_live\\\",\\\"US\\\":5068748604047364,\\\"Reason\\\":1,\\\"Role\\\":1,\\\"TerminalType\\\":6,\\\"UserType\\\":2}}]}",
      "Cost": 22,
      "Time": "2023-10-17 20:26:31.988",
      "Url": "http://****.com/callback",
      "Code": 200
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InputInvalid%s.Illegal input parameters
403NoAuth%s.No permission
404ResourceNotExist%s.The requested resource does not exist, please check and try again
500ServerError%s.Unknown error, please try again later or submit a ticket for consultation.

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

Change history

Change timeSummary of changesOperation
No change history