All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveRecordNotifyConfig

更新時間:Nov 21, 2024

Queries the configuration of callbacks for live stream recording under a domain name.

Operation description

Obtain the main streaming domain, and then call this operation to query the configuration of callbacks for live stream recording under the domain name.

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

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The main streaming domain.

example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

5056369B-D337-499E-B8B7-B761BD37B08A
LiveRecordNotifyConfigobject

The configuration of callbacks for live stream recording.

NeedStatusNotifyboolean

Indicates whether recording status callbacks are enabled. Valid values:

  • true
  • false (default)
false
OnDemandUrlstring

The callback URL for on-demand recording.

http://guide.aliyundoc.com/ondemandcallback.action
DomainNamestring

The main streaming domain.

example.com
NotifyUrlstring

The recording callback URL.

http://learn.aliyundoc.com/examplecallback.action

Examples

Sample success responses

JSONformat

{
  "RequestId": "5056369B-D337-499E-B8B7-B761BD37B08A",
  "LiveRecordNotifyConfig": {
    "NeedStatusNotify": false,
    "OnDemandUrl": "http://guide.aliyundoc.com/ondemandcallback.action",
    "DomainName": "example.com",
    "NotifyUrl": "http://learn.aliyundoc.com/examplecallback.action"
  }
}

Error codes

HTTP status codeError codeError message
404InvalidConfig.NotFoundConfig does not exist.

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