Querying Referer Validation ACLs
Function
This API is used to query referer validation ACLs.
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:getRefererChain
Read
-
-
-
-
URI
GET /v1/{project_id}/guard/referer-chain
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
| 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
| 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
| Parameter | Type | Description |
|---|---|---|
| domain | String | Definition Domain name. Range Length: 1 to 255 characters |
| guard_switch | String | Definition Referer validation switch. Range |
| referer_config_empty | String | Definition Whether the referer header is included. guard_switch is set to true. Range |
| referer_white_list | String | Definition Whether it is a referer whitelist. guard_switch is set to true. Range |
| referer_auth_list | Array of strings | Definition Domain name list. Each domain name is a regular expression. guard_switch is set to true. Range Array length: 1 to 1000 |
Status code: 400
| 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.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot