Last updated: 2021-06-04 11:52:28

1. API Description

Domain name for API request:

This API is used to query referer allowlist/blocklist configuration of a live streaming domain name.
Referer information is included in HTTP requests. After you enable referer configuration, live streams using RTMP or WebRTC for playback will not authenticate the referer and can be played back normally. To make the referer configuration effective, the HTTP-FLV or HLS protocol is recommended for playback.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeLiveDomainReferer.
Version Yes String Common parameter. The value used for this API: 2018-08-01.
Region No String Common parameter. This parameter is not required for this API.
DomainName Yes String Playback domain name

3. Output Parameters

Parameter Name Type Description
RefererAuthConfig RefererAuthConfig Referer allowlist/blocklist configuration of a domain name
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "RefererAuthConfig": {
      "DomainName": "",
      "Enable": 1,
      "Type": 0,
      "AllowEmpty": 1,
      "Rules": ";"
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InternalError.ConnectDbError Database connection error.
InternalError.DBError DB execution error.
InternalError.DomainNotExist The domain name does not exist.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
MissingParameter Parameter missing.
ResourceNotFound.DomainNotExist The domain name does not exist or is not matched.