All Products
Search

This Product

    ApsaraVideo Live:ListRtcMPUEventSubRecord

    Document Center

    ApsaraVideo Live:ListRtcMPUEventSubRecord

    Last Updated:Nov 14, 2024

    Queries subscriptions to mixed-stream relay events.

    Operation description

    Usage notes

    You can call this operation to query subscriptions to mixed-stream relay events within the last 7 days.

    QPS limit

    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. For more information, see QPS limits.

    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:ListRtcMPUEventSubRecordlist
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AppIdstringYes

    The ID of the application.

    Note The ID can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-).
    		yourAppId
    SubIdstringNo

    The ID of the subscription.

    		yourSubId
    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.

    		1970-01-01T00:00:00Z
    EndTimestringYes

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

    		1970-01-01T00:00:00Z
    PageSizeintegerYes

    The number of entries per page. Valid values: 1 to 100.

    		10
    PageNointegerYes

    The page number.

    		20

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		******3B-0E1A-586A-AC29-742247******
    Countlong

    The number of entries per page.

    		1
    HasMoreboolean

    Indicates whether the current page is followed by a page.

    		false
    Logsarray<object>

    The callback records.

    SubInfoobject
    AppIdstring

    The ID of the application.

    		yourAppId
    SubIdstring

    The ID of the subscription.

    		Sub-******9799B2C4500******
    MsgIdstring

    The ID of the callback record.

    		42bba8b5-********-9b501dd6cb6e
    Datastring

    For more information about the callback, see CreateRtcMPUEventSub .

    		{\"EventType\":1,\"MsgId\":\"42bba8b5-94ab-468c-9dae-9b501dd6c***\",\"AppId\":\"rtcdev\",\"SubId\":\"Sub-9799B2C45009799B2C4***\",\"TaskId\":\"mpucallbacktest\",\"CallbackTs\":1712656430***,\"Payload\":{\"DstUrl\":\"rtmp://domain/app/stream?auth\",\"EventTs\":1712656430***,\"EventCode\":1,\"ErrorCode\":0,\"ErrorMessage\":\"\"}}
    Timestring

    The time when the callback was invoked. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

    		1970-01-01T00:00:00Z
    Costlong

    The callback duration. Unit: milliseconds.

    		22
    CallbackUrlstring

    The callback URL.

    		http://testcallback***.com/callback
    HTTPCodestring

    The HTTP status code. 200 indicates that the callback is successful.

    		200

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Count": 1,
  "HasMore": false,
  "Logs": [
    {
      "AppId": "yourAppId",
      "SubId": "Sub-******9799B2C4500******",
      "MsgId": "42bba8b5-********-9b501dd6cb6e",
      "Data": "{\\\"EventType\\\":1,\\\"MsgId\\\":\\\"42bba8b5-94ab-468c-9dae-9b501dd6c***\\\",\\\"AppId\\\":\\\"rtcdev\\\",\\\"SubId\\\":\\\"Sub-9799B2C45009799B2C4***\\\",\\\"TaskId\\\":\\\"mpucallbacktest\\\",\\\"CallbackTs\\\":1712656430***,\\\"Payload\\\":{\\\"DstUrl\\\":\\\"rtmp://domain/app/stream?auth\\\",\\\"EventTs\\\":1712656430***,\\\"EventCode\\\":1,\\\"ErrorCode\\\":0,\\\"ErrorMessage\\\":\\\"\\\"}}",
      "Time": "1970-01-01T00:00:00Z",
      "Cost": 22,
      "CallbackUrl": "http://testcallback***.com/callback",
      "HTTPCode": "200"
    }
  ]
}

    Error codes

    HTTP status codeError codeError message
    400InvalidParam%s
    400InvalidAppId%s
    403OperationDeniedYour account has not enabled the Live service
    403Forbidden%s
    404MissingParam%s
    500InternalErrorInternalError

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

    Change history

    Change timeSummary of changesOperation
    2024-07-04The Error code has changedView Change Details