Help Center/ Live/ Cloud Live API Reference/ Authentication Management/ Querying Referer Validation ACLs
Updated on 2026-04-22 GMT+08:00
View PDF

Querying Referer Validation ACLs

Function

This API is used to query referer validation ACLs.

Calling Method

For details, see Calling APIs.

URI

GET /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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Definition

Streaming domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

domain

String

Definition

Domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

guard_switch

String

Definition

Referer validation switch.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default value:

false

referer_config_empty

String

Definition

Whether the referer header is included.

Constraints

This parameter is mandatory when guard_switch is set to true.

Range

  • true: included

  • false: not included

Default value:

false

referer_white_list

String

Definition

Whether it is a referer whitelist.

Constraints

This parameter is mandatory when guard_switch is set to true.

Range

  • true: whitelist

  • false: blacklist

Default value:

true

referer_auth_list

Array of strings

Definition

Domain name list. Each domain name is a regular expression.

Constraints

A maximum of 1,000 domain names can be included. Use semicolons (;) to separate them. This parameter is mandatory when guard_switch is set to true.

Range

Array length: 1 to 1000

Default Value

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://{endpoint}/v1/{project_id}/guard/referer-chain?domain=play.example.huawei.com

Example Responses

Status code: 200

Referer validation ACLs queried.

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

Status code: 400

Querying referer validation ACLs failed.

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

Status Codes

Status Code

Description

200

Referer validation ACLs queried.

400

Querying referer validation ACLs failed.

Error Codes

See Error Codes.

Parent Topic: Authentication Management