Help Center/ Live/ Cloud Live API Reference/ Authentication Management/ Configuring a Referer Validation ACL
Updated on 2025-11-06 GMT+08:00
View PDF

Configuring a Referer Validation ACL

Function

You can configure a referer validation access control list (ACL), based on which Live will identify and filter access requests of users. Only qualified users can access the content.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    live:domain:updateRefererChain

    Write

    -

    -

    -

    -

URI

PUT /v1/{project_id}/guard/referer-chain

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Domain name

guard_switch

Yes

String

Whether to enable referer validation. true: enable; false: disable.

referer_config_empty

No

String

Whether the referer header is included. true: included; false: not included. This parameter is mandatory when guard_switch is set to true.

referer_white_list

No

String

Whether it is a referer whitelist. true: whitelist; false: blacklist. This parameter is mandatory when guard_switch is set to true.

referer_auth_list

No

Array of strings

Domain name list. Each domain name is a regular expression. A maximum of 100 domain names can be included and separated by semicolons (;). This parameter is mandatory when guard_switch is set to true.

Response Parameters

Status code: 200

Referer validation ACL configured.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

PUT https://{endpoint}/v1/{project_id}/guard/referer-chain

{
  "domain" : "play.example.huawei.com",
  "guard_switch" : "true",
  "referer_config_empty" : "true",
  "referer_white_list" : "false",
  "referer_auth_list" : [ "^http://test.*com$", "abc.com" ]
}

Example Responses

Status code: 400

Configuring the referer validation ACL failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code

Description

200

Referer validation ACL configured.

400

Configuring the referer validation ACL failed.

Error Codes

See Error Codes.