Querying a Referer List
Function
This API is used to query a referer list.
URI
GET /v1.0/cdn/domains/{domain_id}/referer
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Specifies the acceleration domain name ID. For details, see Querying Details About a Domain Name. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project that the resource belongs to. This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects. This parameter is mandatory when you use an IAM user to call this API. Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. 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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
referer |
RefererRsp object |
Specifies the referer settings. |
Parameter |
Type |
Description |
---|---|---|
referer_type |
Integer |
Specifies the type of the referer filtering rule. Possible values: 0 (no referer filtering), 1 (blacklist), and 2 (whitelist). Default value: 0. |
referer_list |
String |
Specifies the referer validation configuration. Multiple IP addresses or domain names are supported and they must be separated by semicolons (;). This parameter is mandatory when referer validation is enabled. |
include_empty |
Boolean |
Specifies whether a blank referer is included in the blacklist or whitelist. If you configure a referer blacklist and enable this function, requests with no referers are not allowed. If you configure a referer whitelist and enable this function, requests with no referers are allowed. By default, blank referers are not included. |
Example Requests
GET https://cdn.myhuaweicloud.com/v1.0/cdn/domains/ff8080***********************d71/referer?enterprise_project_id=0
Example Responses
Status code: 200
OK
{ "referer" : { "referer_type" : 1, "referer_list" : "www.example1.com;www.example2.com", "include_empty" : false } }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot