Querying Referer Validation ACLs
Function
Queries referer validation ACLs.
Calling Method
For details, see Calling APIs.
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 |
Streaming domain name |
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 |
Domain name |
|
guard_switch |
String |
Whether to enable referer validation. true: enable; false: disable. |
|
referer_config_empty |
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 |
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 |
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. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
