Domain name for API request: live.tencentcloudapi.com.
This API is used to configure referer allowlist/blocklist 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.
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 Params. The value used for this API: ModifyLiveDomainReferer. |
Version | Yes | String | Common Params. The value used for this API: 2018-08-01. |
Region | No | String | Common Params. This parameter is not required for this API. |
DomainName | Yes | String | Playback domain name |
Enable | Yes | Integer | Whether to enable referer allowlist/blocklist authentication for the current domain name |
Type | Yes | Integer | List type. Valid values: 0 (blocklist), 1 (allowlist) |
AllowEmpty | Yes | Integer | Whether to allow empty referer. Valid values: 0 (no), 1 (yes) |
Rules | Yes | String | Referer list. Separate items in it with semicolons (;). |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://live.tencentcloudapi.com/?Action=ModifyLiveDomainReferer
&DomainName=5000.liveplay.myqcloud.com
&Enable=1
&Type=0
&AllowEmpty=1
&Rules=aaa.com;bbb.com
&<Common request parameters>
{
"Response": {
"RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
ResourceNotFound.ForbidService | You are blocked. |
ResourceNotFound.FreezeService | Service suspended. |
ResourceNotFound.StopService | The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first. |
ResourceNotFound.UserDisableService | You disabled the service. |
Was this page helpful?