Help Center/ Content Delivery Network/ API Reference/ API/ Domain Name Configuration/ Querying Domain Name Configuration

Updated on 2025-08-19 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Domain Name Configuration

Function

This API is used to query the domain name configuration. You can query the service type, service area, remarks, IPv6, origin protocol, origin URL rewriting, advanced origin, range request, redirect from origin, ETag verification, origin response timeout, origin request header, HTTPS, TLS version, force redirect, HSTS, HTTP/2, OCSP stapling, QUIC, cache rule, status code cache TTL, referer validation, IP ACL, User-Agent ACL, token authentication, remote authentication, IP access frequency, HTTP header, custom error page, smart compression, request rate limiting, WebSocket, video seek, origin SNI, access URL rewriting, browser cache TTL, geo-blocking settings, and client certificate settings.

A single tenant can call this API 300 times per minute.

Calling Method

For details, see Calling APIs.

URI

GET /v1.1/cdn/configuration/domains/{domain_name}/configs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_name	Yes	String	Definition Acceleration domain name. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID. Obtain the enterprise project ID by calling the ListEnterpriseProject API of EPS. Constraints This parameter indicates the ID of the enterprise project to which the resource to be queried belongs. It is valid only when the enterprise project function is enabled. The value all indicates all projects. Range N/A Default Value N/A
show_special_configs	No	String	Definition Whether to display special configuration. Constraints N/A Range auth_key: used to query the values of the primary and secondary authentication keys. Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
configs	ConfigsGetBody object	Configuration items.

**Table 5** ConfigsGetBody
Parameter	Type	Description
business_type	String	Service type: web: website acceleration. download: file download acceleration. video: on-demand service acceleration. wholesite: whole site acceleration.
service_area	String	Service area. mainland_china: Chinese mainland. global: global. outside_mainland_china: outside the Chinese mainland.
remark	String	Domain name remarks.
origin_request_header	Array of OriginRequestHeader objects	Origin request header settings.
http_response_header	Array of HttpResponseHeader objects	HTTP header settings.
url_auth	UrlAuthGetBody object	Response body for querying token authentication settings.
https	HttpGetBody object	Response body for querying certificate settings.
sources	Array of SourcesConfigResponseBody objects	Origin server settings.
origin_protocol	String	Origin protocol. Possible values: follow (same as user requests), http (HTTP, default value), and https (HTTPS).
origin_follow302_status	String	Redirect from origin. Possible values: on (enabled) and off (disabled).
cache_rules	Array of CacheRules objects	Cache rules.
ip_filter	IpFilter object	Definition IP access control list (ACL), which blocks or allows access from specific IP addresses. Constraints N/A
referer	RefererConfig object	Definition Referrer whitelist or whitelist, which identifies and filters user identities to control access. Constraints N/A
force_redirect	ForceRedirectConfig object	Definition This parameter is used to force clients to use HTTPS or HTTP when accessing CDN PoPs. Constraints N/A
compress	Compress object	Definition Smart compression. CDN can compress static content on websites by reducing file size. This speeds up file transfer and saves a lot of bandwidth. Constraints N/A
cache_url_parameter_filter	CacheUrlParameterFilterGetBody object	Response body for querying the settings of caching URL parameters. NOTE: This old parameter will be deprecated recently.
ipv6_accelerate	Integer	IPv6 settings. Possible values: 1 (enabled) and 0 (disabled).
error_code_cache	Array of ErrorCodeCache objects	Status code cache TTL.
origin_range_status	String	Range requests. Possible values: on (enabled) and off (disabled).
user_agent_filter	UserAgentFilter object	Definition User-Agent ACL, which filters out requests from specific proxies. Constraints N/A
origin_request_url_rewrite	Array of OriginRequestUrlRewrite objects	Origin request URL rewriting.
flexible_origin	Array of flexibleOrigins objects	Advanced origins.
slice_etag_status	String	Whether ETag is verified during origin pull. Possible values: on (yes) and off (no).
origin_receive_timeout	Integer	Origin response timeout, in seconds.
remote_auth	commonRemoteAuth object	Definition Remote authentication. CDN can forward user requests to the authentication server you specify and determine whether to return requested content to users based on the server response. Constraints N/A
websocket	webSocketSeek object	Definition Whether to allow clients to access CDN PoPs using WebSocket. NOTE: WebSocket works only for resources whose TTL is set to 0, TTL source is set to CDN, and forcible cache is enabled. Constraints Only domain names for whole site acceleration support this configuration item. WebSocket and HTTP/2 are incompatible and cannot be both enabled.
video_seek	videoSeek object	Definition Video seek settings. Users can seek to any position in a video without affecting the playback effect. Constraints You have configured a cache rule for FLV and MP4 files and ignored all URL parameters in user requests. Time-based FLV seek is valid only when video seek is enabled.
request_limit_rules	Array of RequestLimitRules objects	Definition Request rate limiting settings. Constraints N/A
ip_frequency_limit	IpFrequencyLimitQuery object	IP access frequency.
hsts	HstsQuery object	HSTS settings. HSTS forces clients (such as browsers) to use HTTPS to access your server, improving access security.
quic	Quic object	Definition QUIC. Using QUIC to access CDN PoPs improves transmission security, reduces transmission and connection latency, and prevents network congestion. Constraints N/A
error_code_redirect_rules	Array of ErrorCodeRedirectRules objects	Custom error page.
sni	Sni object	Definition Origin SNI. If your origin server IP address is bound to multiple domain names and CDN visits the origin server using HTTPS, specify the domain name to be visited by CDN during handshake. Constraints N/A
request_url_rewrite	Array of RequestUrlRewrite objects	Access URL rewriting.
browser_cache_rules	Array of BrowserCacheRules objects	Browser cache TTL.
access_area_filter	Array of AccessAreaFilter objects	Definition Geo-blocking, which prevents users in certain geographical locations from accessing your content. NOTE: IP addresses belong to carriers and change irregularly. Although Huawei Cloud periodically updates the IP address library, the update may be delayed. As a result, some access control functions may occasionally block or allow requests, or client requests may not be scheduled to the optimal PoP. Constraints N/A
client_cert	ClientCert object	Definition Client certificate, which enforces mutual certificate authentication between clients and CDN PoPs, securing website communication. Constraints N/A

**Table 6** OriginRequestHeader
Parameter	Type	Description
name	String	Definition Name of an origin request header. Constraints N/A Range Enter 1 to 100 characters. Use only letters, digits, and hyphens (-). Start with a letter. Default Value N/A
value	String	Definition Value of the origin request header. Constraints N/A Range Enter 1 to 1,000 characters. Use only letters, digits, and the following special characters: .-_#!&+\|^~'"/:;,=@?<> This parameter is optional when the header is to be deleted. Chinese characters are not allowed. Variables, such as $client_ip* and $remote_port, are not allowed. Default Value N/A
action	String	Definition Operation type of the origin request header. Constraints A request header field can only be deleted or set. When action is set to set, if the header does not exist in the original origin request, it is added. If it exists, it is modified. Range delete set Default Value N/A

**Table 7** HttpResponseHeader
Parameter	Type	Description
name	String	Definition Name of an HTTP response header. Constraints N/A Range Enter 1 to 100 characters. Use only letters, digits, and hyphens (-). Start with a letter. Default Value N/A
value	String	Definition Value of the HTTP response header. Constraints N/A Range Enter 1 to 1,000 characters. Use only letters, digits, and the following special characters: .-_#!&+\|^~'"/:;,=@?<> This parameter is optional when the header is to be deleted. Default Value* N/A
action	String	Definition Operation type of the HTTP response header. Constraints A response header field can only be deleted or set. When action is set to set, if the header does not exist in the original HTTP response, it is added. If it exists, it is modified. Range set delete Default Value N/A

**Table 8** UrlAuthGetBody
Parameter	Type	Description
status	String	Whether token authentication is enabled. Possible values: on (enabled) and off (disabled).
type	String	Signing method. type_a: method A. type_b: method B. type_c1: method C1. type_c2: method C2.
expire_time	Integer	Expiration time, in seconds.
sign_method	String	Encryption algorithm.
match_type	String	Authentication scope.
inherit_config	InheritConfigQuery object	Authentication inheritance. Authentication parameters are added to TS and MP4 files under M3U8/MPD index files, so that the files can be played after authentication succeeds.
key	String	Signing key.
backup_key	String	Secondary key.
sign_arg	String	Authentication parameters.
time_format	String	Time format. dec: decimal. hex: hexadecimal.
time_arg	String	Time parameter.

**Table 9** InheritConfigQuery
Parameter	Type	Description
status	String	Whether authentication inheritance is enabled. The options are on (enabled) and off (disabled).
inherit_type	String	Authentication inheritance settings. The value can be m3u8, mpd, or m3u8,mpd.
inherit_time_type	String	Time type of the files that inherits authentication settings. sys_time: current system time. parent_url_time: time when a user accesses the M3U8/MPD file.

**Table 10** HttpGetBody
Parameter	Type	Description
https_status	String	Whether HTTPS is enabled. Possible values: on (enabled) and off (disabled).
certificate_type	String	Certificate type. server: international certificate. server_sm: Chinese (SM2) certificate.
certificate_source	Integer	Certificate source. 1: Huawei-managed certificate; 0: your own certificate. 2: SCM certificate.
scm_certificate_id	String	SCM certificate ID.
certificate_name	String	Certificate name.
certificate_value	String	Content of the certificate used by the HTTPS protocol. The value must be PEM encoded.
expire_time	Long	Certificate expiration time. NOTE: The value is in UTC format.
enc_certificate_value	String	Encryption Chinese (SM2) certificate. The value must be PEM encoded.
certificates	Array of CertificatesGetBody objects	Response body for querying dual-certificate settings.
http2_status	String	Whether HTTP/2 is used. Possible values: on (yes) and off (no).
tls_version	String	TLS.
ocsp_stapling_status	String	Whether OCSP stapling is enabled. Possible values: on (yes) and off (no).

**Table 11** CertificatesGetBody
Parameter	Type	Description
certificate_source	Integer	Certificate source. 0: your own certificate. 2: SCM certificate.
scm_certificate_id	String	SCM certificate ID.
certificate_type	String	Certificate type. server: international certificate; server_sm: Chinese (SM2) certificate.
certificate_name	String	Certificate name.
certificate_value	String	Content of the certificate used by the HTTPS protocol. The value must be PEM encoded.
enc_certificate_value	String	Encryption Chinese (SM2) certificate. The value must be PEM encoded.
expire_time	Long	Certificate expiration time. NOTE: The value is in UTC format.

**Table 12** SourcesConfigResponseBody
Parameter	Type	Description
origin_type	String	Origin server type. ipaddr: IP address. domain: origin server domain name. obs_bucket: OBS bucket domain name. third_bucket: third-party bucket. To use this type of origin servers, submit a service ticket.
origin_addr	String	IP address or domain name of the origin server.
priority	Integer	Origin server priority. Possible values: 70 (primary) and 30 (standby).
weight	Integer	Weight. The value ranges from 1 to 100.
obs_web_hosting_status	String	Whether static website hosting is enabled for the OBS bucket. This parameter is mandatory when the origin server type is obs_bucket. Possible values: off (disabled) and on (enabled).
http_port	Integer	HTTP port. Default value: 80. The port number ranges from 1 to 65535.
https_port	Integer	HTTPS port. Default value: 443. The port number ranges from 1 to 65535.
host_name	String	Host header. The default value is the acceleration domain name.
obs_bucket_type	String	OBS bucket type. private: private bucket (Users except those authorized by the bucket ACL do not have the permission to access the bucket.) public: public bucket (Any user can read objects in the bucket.)
bucket_access_key	String	Access key of the third-party bucket. NOTE: This parameter is mandatory when the origin server is a third-party bucket.
bucket_secret_key	String	Secret key of the third-party bucket. NOTE: This parameter is mandatory when the origin server is a third-party bucket.
bucket_region	String	Region of the third-party bucket. NOTE: This parameter is mandatory when the origin server is a third-party bucket.
bucket_name	String	Name of the third-party bucket. NOTE: This parameter is mandatory when the origin server is a third-party bucket.

**Table 13** CacheRules
Parameter	Type	Description
match_type	String	Definition Match type. Constraints N/A Range all: all files. file_extension: file name extension. catalog: directory. full_path: full path. home_page: homepage. Default Value N/A
match_value	String	Definition Cache rule match content. Constraints When match_type is set to all, this parameter is left blank. When match_type is set to file_extension, the value of this parameter is a list of up to 100 file types with up to 1,000 characters. A file type starts with a period (.). File types are separated by commas (,) or semicolons (;). Example: .jpg,.zip,.exe. When match_type is set to catalog, the value of this parameter is a list of up to 20 directories with up to 255 characters. A directory starts with a slash (/). Directories are separated by commas (,) or semicolons (;). Example: /test/folder01,/test/folder02. When match_type is set to full_path, the value of this parameter is a full path. A full path starts with a slash (/) and supports wildcard characters (). A cache rule can contain only one full path, for example, /test/index.html* or */test/.jpg*. / is not allowed. When match_type is set to home_page, this parameter is left blank. Range N/A Default Value N/A
ttl	Integer	Definition TTL of a resource cached on CDN PoPs. Constraints Up to 365 days. Range N/A Default Value 0
ttl_unit	String	Definition Unit of the cache TTL. Constraints N/A Range s: second. m: minute. h: hour. d: day. Default Value N/A
priority	Integer	Definition Cache rule priority. A larger value indicates a higher priority. Constraints The priority of a rule must be unique. Range 1 to 100. Default Value N/A
follow_origin	String	Definition Source of the cache TTL, that is, whether CDN PoPs use the cache TTL set on the origin server or that set in cache rules on CDN. Constraints N/A Range on: CDN PoPs use the TTL set on the origin server. off: CDN PoPs use the TTL set in cache rules. min_ttl: CDN PoPs use the shorter TTL between the TTL set on the origin server and that in cache rules. Default Value off
force_cache	String	Definition Forcible cache. Specify whether CDN PoP cache ignores the no-cache, private, and no-store fields in the Cache-Control response header sent from the origin server. Constraints Forcible cache is used together with cache TTL source. For details about the restrictions and configuration effect, see section "PoP Cache Rules" in the User Guide of CDN. Range on: enabled. off: disabled. Default Value off
url_parameter_type	String	Definition URL parameter filtering. Constraints N/A Range del_params: Ignore specific URL parameters. reserve_params: Retain specific URL parameters. ignore_url_params: Ignore all URL parameters. full_url: Retain all URL parameters. Default Value full_url
url_parameter_value	String	Definition URL parameters. Constraints Enter up to 30 parameters. Separate parameters by commas (,) or semicolons (;). This parameter is mandatory when url_parameter_type is set to del_params or reserve_params. Range N/A Default Value N/A

**Table 14** IpFilter
Parameter	Type	Description
type	String	Definition IP ACL type. Constraints N/A Range off: The IP ACL is disabled. black: IP address blacklist. white: IP address whitelist. Default Value N/A
value	String	Definition IP ACL. NOTE: IPv6 is supported. IP addresses and CIDR blocks in the IP address/Subnet mask format are supported. Constraints This parameter is optional when type is set to off. Separate rules by commas (,). Enter up to 500 rules. Duplicate IP addresses and CIDR blocks will be removed. Wildcards are not supported, for example, 192.168.0.. Range* N/A Default Value N/A

**Table 15** RefererConfig
Parameter	Type	Description
type	String	Definition Type of the referer blacklist or whitelist. Constraints N/A Range off: The referer blacklist/whitelist is disabled. black: referer blacklist. white: referer whitelist. Default Value N/A
value	String	Definition Domain names or IP addresses. NOTE: Domain name and IP address can be entered together. Wildcard domain names and domain names with port numbers are supported. Constraints Separate domain names and IP addresses by commas (,). Enter up to 1,000 domain names and IP addresses. A port ranges from 1 to 65535. Range N/A Default Value N/A
include_empty	Boolean	Definition Whether blank referers are included. NOTE: A referer blacklist including blank referers indicates that requests without any referers are not allowed to access. A referer whitelist including blank referers indicates that requests without any referers are allowed to access. Constraints N/A Range true: Blank referers are included. false: Blank referers are not included. Default Value false

**Table 16** ForceRedirectConfig
Parameter	Type	Description
status	String	Definition Force redirect status. Constraints N/A Range on: enabled. off: disabled. Default Value N/A
type	String	Definition Protocol to which requests are forcibly redirected. Constraints If force redirect to HTTPS is enabled, an HTTPS certificate must be configured. Otherwise, the access will fail. Range http: force redirect to HTTP. https: force redirect to HTTPS. Default Value N/A
redirect_code	Integer	Definition Redirect status code. Constraints N/A Range 301 302 307 Default Value N/A

**Table 17** Compress
Parameter	Type	Description
status	String	Definition Smart compression status. Constraints N/A Range on: enabled. off: disabled. Default Value N/A
type	String	Definition Smart compression type. Constraints If multiple smart compression types are configured, Brotli compression is used first. Range Separate smart compression types by commas (,). gzip: gzip compression. br: Brotli compression. Default Value N/A
file_type	String	Definition Types of files to compress. Constraints N/A Range Enter up to 2,000 characters. Enter up to 50 characters for each type. Separate types by commas (,). Default Value The default value is .js,.html,.css,.xml,.json,.shtml,.htm when smart compression is used for the first time. When this function is used again and this value is left empty, the result of the previous setting is used.
compress_min_length	Integer	Definition Minimum size of files to be compressed. Constraints CDN compresses files between 0 MB and 30 MB if no specific file size is set. Range 0 MB to 30 MB. The unit is byte. Default Value N/A
compress_max_length	Integer	Definition Maximum size of files to be compressed. Constraints CDN compresses files between 0 MB and 30 MB if no specific file size is set. Range 0 MB to 30 MB. The unit is byte. Default Value N/A

**Table 18** CacheUrlParameterFilterGetBody
Parameter	Type	Description
type	String	Operation type of caching URL parameters. full_url: Cache all URL parameters. ignore_url_params: Ignore all URL parameters. del_params: Ignore specific URL parameters. reserve_params: Retain specific URL parameters. NOTE: The following parameters of this API are adjusted: Replaced del_args with del_params. Replaced reserve_args with reserve_params.
value	String	Parameter value.

**Table 19** ErrorCodeCache
Parameter	Type	Description
code	Integer	Definition Error codes to cache. Constraints N/A Range 3xx: 301 and 302. 4xx: 400, 403, 404, 405, 407, 414, 416, and 451. 5xx: 500, 501, 502, 503, 504, 509, and 514. Default Value N/A
ttl	Integer	Definition Error code cache TTL. Constraints N/A Range 0 to 31,536,000, in seconds. NOTE: The cache TTL of 3XX status codes ranges from 0s to 20s. Default Value N/A

**Table 20** UserAgentFilter
Parameter	Type	Description
type	String	Definition User-Agent ACL type. Constraints N/A Range off: The User-Agent ACL is disabled. black: User-Agent blacklist. white: User-Agent whitelist. Default Value N/A
value	String	Definition User-Agent ACL content. NOTE: This old parameter will be deprecated recently. Use ua_list to set a User-Agent ACL. Constraints This parameter is optional when type is set to off. Configure up to 50 rules. Separate rules by commas (,). Range Enter up to 200 characters for each rule. Use only letters, digits, spaces, and the following special characters: .-_();,/'#!@$^&+=~?"[]{}:% Default Value* N/A
include_empty	Boolean	Definition Whether blank user agents are included. NOTE: A blacklist including blank user agents indicates that requests without any user agents are not allowed to access. A whitelist including blank user agents indicates that requests without any user agents are allowed to access. Constraints N/A Range true: Blank user agents are included. false: Blank user agents are not included. Default Value false for blacklists. true for whitelists.
ua_list	Array of strings	Definition User-Agent ACL. Constraints This parameter is optional when type is set to off. Configure up to 50 rules. Enter up to 200 characters for each rule. When ua_list and value are both set, ua_list is used.

**Table 21** OriginRequestUrlRewrite
Parameter	Type	Description
priority	Integer	Definition Priority of a URL rewrite rule. NOTE: A larger value indicates a higher priority. CDN executes the URL rewrite rule with a higher priority. Constraints The priority of a rule must be unique. The priority cannot be empty. Range 1 to 100. Default Value N/A
match_type	String	Definition Match type. Constraints N/A Range all: all files. file_path: URI path. wildcard: wildcard. full_path: full path. Default Value N/A
source_url	String	Definition URI to rewrite. Constraints If the match mode is set to all files, this parameter cannot be configured. Range Enter 1 to 512 characters. Wildcards () are supported. Example, /test//.mp4. A URI starts with a slash (/) and does not contain http://, https://, or the domain name. Default Value* N/A
target_url	String	Definition URI after rewrite. Constraints Range Enter 1 to 256 characters. A URI starts with a slash (/) and does not contain http://, https://, or the domain name. NOTE: The nth wildcard () field can be captured by $n, where n = 1, 2, 3, .... Example: /newtest/$1/$2.jpg. Default Value* N/A

**Table 22** flexibleOrigins
Parameter	Type	Description
match_type	String	Definition URI match mode. Constraints N/A Range file_extension: file name extension. file_path: directory. Default Value N/A
match_pattern	String	Definition URI match rule. Constraints When match_type is set to file_extension: All file types are supported. Start a file type with a period (.). Separate file types by semicolons (;). Enter up to 20 file types. When match_type is set to file_path: Start a directory with a slash (/). Separate directories by semicolons (;). Enter up to 20 directories. NOTE: File types are case-sensitive. Range 1 to 512 characters. Default Value N/A
priority	Integer	Definition Priority. NOTE: A larger value indicates a higher priority. Constraints N/A Range 1 to 100. Default Value N/A
back_sources	Array of backSources objects	Definition Origin server accessed by CDN PoPs for origin pull when a client request matches this rule. Constraints Only one origin server in each rule. Range N/A Default Value N/A

**Table 23** backSources
Parameter	Type	Description
sources_type	String	Definition Origin server type. Constraints N/A Range ipaddr: IP address. domain: origin server domain name. obs_bucket: OBS bucket domain name. Default Value N/A
ip_or_domain	String	Definition IP address or domain name of the origin server. Constraints N/A Range N/A Default Value N/A
obs_bucket_type	String	Definition OBS bucket type. Constraints N/A Range private: private bucket. public: public bucket. Default Value public
http_port	Integer	Definition HTTP port. Constraints N/A Range 1 to 65,535. Default Value 80
https_port	Integer	Definition HTTPS port. Constraints N/A Range 1 to 65,535. Default Value 443

**Table 24** commonRemoteAuth
Parameter	Type	Description
remote_authentication	String	Definition Whether to enable remote authentication. Constraints N/A Range on: enabled. off: disabled. Default Value N/A
remote_auth_rules	RemoteAuthRule object	Definition Remote authentication settings. Constraints N/A

**Table 25** RemoteAuthRule
Parameter	Type	Description
auth_server	String	Definition Address of a reachable authentication server. Constraints The address must contain http:// or https://. It cannot be a local address such as localhost or 127.0.0.1. It cannot be an acceleration domain name added on CDN. Range N/A Default Value N/A
request_method	String	Definition Request method supported by the authentication server. Constraints N/A Range GET POST HEAD Default Value N/A
file_type_setting	String	Definition Range of files to authenticate. Constraints N/A Range all: all files. specific_file: files of the specified types. Example: jpg\|MP4. NOTE: File types are case-insensitive. For example, jpg and JPG indicate the same file type. File types are separated by vertical bars (\|). Default Value N/A
specified_file_type	String	Definition Types of files to authenticate. Constraints This parameter is mandatory when file_type_setting is set to specific_file. In other cases, it is left blank. Separate file types by vertical bars (\|). Example: jpg\|mp4. This parameter is verified only when it is mandatory. Range Enter 1 to 512 characters. Use only letters and digits. Default Value N/A
reserve_args_setting	String	Definition Whether to retain or ignore parameters for authentication. Constraints N/A Range reserve_all_args: Retain all URL parameters. reserve_specific_args: Retain specific URL parameters. ignore_all_args: Ignore all URL parameters. Default Value N/A
reserve_args	String	Definition Parameters. Constraints This parameter is mandatory when reserve_args_setting is set to reserve_specific_args. In other cases, this parameter is left blank. Separate parameters by vertical bars (\|). Example: key1\|key2. Range N/A Default Value N/A
add_custom_args_rules	Array of customArgs objects	Definition Parameters to be added when CDN PoPs forward user requests to the remote authentication server. Constraints N/A Range N/A Default Value N/A
reserve_headers_setting	String	Definition Whether to retain or ignore request headers when CDN PoPs forward user requests to the remote authentication server. Constraints N/A Range reserve_all_headers: Retain all request headers. reserve_specific_headers: Retain specific request headers. ignore_all_headers: Ignore all request headers. Default Value N/A
add_custom_headers_rules	Array of customArgs objects	Definition Request headers to authenticate. Constraints N/A Range N/A Default Value N/A
auth_success_status	String	Definition Status code returned by the remote authentication server to CDN PoPs when authentication is successful. Constraints N/A Range 2xx 3xx Default Value N/A
auth_failed_status	String	Definition Status code returned by the remote authentication server to CDN PoPs when authentication fails. Constraints N/A Range 4xx 5xx Default Value N/A
response_status	String	Definition Status code returned by CDN PoPs to users when authentication fails. Constraints N/A Range 2xx 3xx 4xx 5xx Default Value N/A
timeout	Integer	Definition Authentication timeout interval, that is, the interval from the time when a CDN PoP forwards an authentication request to the time when the CDN PoP receives the result returned by the remote authentication server. Constraints N/A Range 0 or 50 to 3,000, in milliseconds. Default Value N/A
timeout_action	String	Definition Method used by CDN PoPs to process a user request after authentication times out. Constraints N/A Range pass: The user request will be accepted and the requested resource will be returned. forbid: The user request will be rejected and the configured custom response status code will be returned. Default Value N/A
reserve_headers	String	Definition Request headers to retain. Constraints This parameter is mandatory when reserve_headers_setting is set to reserve_specific_headers. In other cases, this parameter is left blank. Separate request headers by vertical bars (\|). Example: key1\|key2. Range N/A Default Value N/A

**Table 26** customArgs
Parameter	Type	Description
type	String	Definition Parameter type. Constraints N/A Range custom_var: custom. nginx_preset_var: preset variable. Default Value N/A
key	String	Definition Parameter name. Constraints N/A Range Enter 1 to 256 characters. Use only letters, digits, and the following special characters: ._-#%\|+^@?= Default Value* N/A
value	String	Definition Parameter value. Constraints N/A Range When type is set to custom_var, enter 1 to 256 characters and use only letters, digits, and the following special characters: ._-#%\|+^@?= When type* is set to nginx_preset_var, the value can only be set to $http_host, $http_user_agent, $http_referer, $http_x_forwarded_for, $http_content_type, $remote_addr, $scheme, $server_protocol, $request_uri, $uri, $args, and $request_method. Default Value N/A

**Table 27** webSocketSeek
Parameter	Type	Description
status	String	Definition Whether to enable the WebSocket protocol. Constraints N/A Range on: enabled. off: disabled. Default Value N/A
timeout	Integer	Definition Duration for keeping a connection open. Constraints N/A Range 1 to 300, in seconds. This parameter is mandatory when status is set to on. Default Value N/A

**Table 28** videoSeek
Parameter	Type	Description
enable_video_seek	Boolean	Definition Video seek status. Constraints When this parameter is set to false, the API for querying domain name configuration does not return the video seek settings. Range true: enabled. false: disabled. Default Value N/A
enable_flv_by_time_seek	Boolean	Definition Time-based FLV seek status. Constraints N/A Range true: enabled. false: disabled. Default Value N/A
start_parameter	String	Definition Start parameter of video playback in URLs requested by users. Constraints N/A Range Enter 1 to 64 characters. Use only letters, digits, and underscores (_). Default Value N/A
end_parameter	String	Definition End parameter of video playback in URLs requested by users. Constraints N/A Range Enter 1 to 64 characters. Use only letters, digits, and underscores (_). Default Value N/A

**Table 29** RequestLimitRules
Parameter	Type	Description
status	String	Definition Whether to enable request rate limiting. NOTE: This parameter is used in earlier APIs and will be deprecated. The value can only be on. off is invalid. Constraints If request_limit_rules is left empty, request rate limiting is disabled. Range on Default Value N/A
priority	Integer	Definition Priority. NOTE: A larger value indicates a higher priority. Constraints The priority of a rule must be unique. Range 1 to 100. Default Value N/A
match_type	String	Definition Match type. Constraints N/A Range all: all files. catalog: directory. Default Value N/A
match_value	String	Definition Match type value. Constraints When match_type is set to all, leave this parameter empty. When match_type is set to catalog, the value is a directory address starting with a slash (/), for example, /test. This parameter is mandatory when match_type is set to catalog. Range N/A Default Value N/A
type	String	Definition Rate limit mode. Constraints Currently, only rate limit by traffic is supported. This parameter can only be set to size. Range N/A Default Value N/A
limit_rate_after	Long	Definition Rate limit condition. NOTE: For example, type=size,limit_rate_after=50 indicates that the speed is limited to the value of limit_rate_value after 50 bytes are transmitted. Constraints N/A Range 0 to 1,073,741,824, in bytes. Default Value N/A
limit_rate_value	Integer	Definition Rate limit, that is, the maximum access speed after the rate limit is reached. Constraints N/A Range 0 to 104,857,600, in bit/s. Default Value N/A
limit_time	String	Definition Periods when the rate is limited. Constraints Periods are in the 24-hour clock. Period format: HHMM-HHMM (in UTC+08:00). Separate periods by commas (,). Example: 0100-0200,2200-2300. Enter up to 10 periods. Range N/A Default Value 0000-2400

**Table 30** IpFrequencyLimitQuery
Parameter	Type	Description
status	String	Status. The options are on (enabled) and off (disabled).
qps	Integer	Access threshold, in times/second.

**Table 31** HstsQuery
Parameter	Type	Description
status	String	Status. The options are on (enabled) and off (disabled).
max_age	Integer	Expiration time, that is, the TTL of the response header Strict-Transport-Security on the client. Unit: second.
include_subdomains	String	Whether subdomain names are included. The options are on (included) and off (not included).

**Table 32** Quic
Parameter	Type	Description
status	String	Definition QUIC status. Constraints N/A Range on: enabled. off: disabled. Default Value N/A

**Table 33** ErrorCodeRedirectRules
Parameter	Type	Description
error_code	Integer	Definition Redirection error code. Constraints N/A Range 4xx: 400, 403, 404, 405, 414, 416, and 451. 5xx: 500, 501, 502, 503, and 504. Default Value N/A
target_code	Integer	Definition Redirection status code. Constraints N/A Range 301 302 Default Value N/A
target_link	String	Definition Destination URL. Constraints Start with http:// or https://. Range N/A Default Value N/A

**Table 34** Sni
Parameter	Type	Description
status	String	Definition Whether to enable origin SNI. Constraints N/A Range on: enabled. off: disabled. Default Value N/A
server_name	String	Definition SNI domain name used for HTTPS handshake during CDN PoP origin pull. Constraints This parameter is mandatory when origin SNI is enabled. Range Use only letters, digits, hyphens (-), and periods (.). Default Value

**Table 35** RequestUrlRewrite
Parameter	Type	Description
condition	UrlRewriteCondition object	Definition Match condition. Constraints N/A Range N/A Default Value N/A
redirect_status_code	Integer	Definition Redirection status code. Constraints N/A Range 301 302 303 307 Default Value N/A
redirect_url	String	Definition Redirection URL. Constraints A target URL starts with a slash (/) and does not contain http://, https://, or the domain name. Example: /test/index.html. When the match type is set to full path, the wildcard () can be captured by $1. For example, if the content is /test/.jpg and the redirection URL is /newtest/$1.jpg, when a user requests /test/11.jpg, $1 is replaced by 11, so the requested URL after redirection is /newtest/11.jpg. Range N/A Default Value** N/A
redirect_host	String	Definition Domain name to which client requests are redirected. Constraints N/A Range Enter 1 to 255 characters. Start with http:// or https://. Default Value Acceleration domain name.
execution_mode	String	Definition Action. Constraints N/A Range redirect: If the requested URL matches this rule, the request is redirected to the target URL. After this rule is executed, if other rules exist, CDN continues to execute these rules. break: If the requested URL matches this rule, the request is redirected to the target URL. After this rule is executed, CDN does not execute any other rules and returns status code 200. You cannot set the redirection host or status code. Default Value N/A

**Table 36** UrlRewriteCondition
Parameter	Type	Description
match_type	String	Definition Match type. Constraints N/A Range catalog: The rule is executed for files in the specified directory. full_path: The rule is executed for the file of the specified path. Default Value N/A
match_value	String	Definition Match content. Constraints When match_type is set to catalog, the value of this parameter is a list of up to 20 directories. A directory starts with a slash (/). Directories are separated by commas (,). Example: /test/folder01,/test/folder02. When match_type is set to full_path, the value of this parameter is a full path. A full path starts with a slash (/) and supports wildcard characters (). A rule can contain only one full path. Example: /test/index.html* or */test/.jpg. Range N/A Default Value** N/A
priority	Integer	Definition Priority of the access URL rewrite rule. NOTE: A larger value indicates a higher priority. Constraints The priority of a rule must be unique. Range 1 to 100. Default Value N/A

**Table 37** BrowserCacheRules
Parameter	Type	Description
condition	BrowserCacheRulesCondition object	Definition Match condition. Constraints N/A Range N/A Default Value N/A
cache_type	String	Definition Cache effective type. Constraints N/A Range follow_origin: The cache policy of the origin server, that is, the setting of the Cache-Control header, is used. ttl: The TTL set in this rule is used. never: Browsers do not cache the resources. Default Value N/A
ttl	Integer	Definition Cache TTL. Constraints Up to 365 days. Mandatory when the cache effective type is set to ttl. Range N/A Default Value N/A
ttl_unit	String	Definition Unit of the cache TTL. Constraints Mandatory when the cache effective type is set to ttl. Range s: second. m: minute. h: hour. d: day. Default Value N/A

**Table 38** BrowserCacheRulesCondition
Parameter	Type	Description
match_type	String	Definition Match type. Constraints N/A Range all: all files. file_extension: file name extension. catalog: directory. full_path: full path. home_page: homepage. Default Value N/A
match_value	String	Definition Cache content based on the cache rule. Constraints When match_type is set to all, this parameter is left blank. When match_type is set to file_extension, the value of this parameter is a list of up to 20 file types. A file type starts with a period (.). File types are separated by commas (,). Example: .jpg,.zip,.exe. When match_type is set to catalog, the value of this parameter is a list of up to 20 directories. A directory starts with a slash (/). Directories are separated by commas (,). Example: /test/folder01,/test/folder02. When match_type is set to full_path, the value of this parameter is a full path. A full path starts with a slash (/) and supports wildcard characters (), but cannot end with a wildcard (). A wildcard () can only follow the last slash (/). A rule can contain only one full path. Example: /test/index.html* or */test/.jpg. When match_type is set to home_page, this parameter is left blank. Range N/A Default Value** N/A
priority	Integer	Definition Priority of the browser cache rule. A larger value indicates a higher priority. Constraints The priority of a rule must be unique. Range N/A Default Value 1 to 100.

**Table 39** AccessAreaFilter
Parameter	Type	Description
type	String	Definition Rule type. Constraints N/A Range black: blacklist. Users in regions specified in the blacklist cannot access resources and status code 403 is returned. white: whitelist. Only users in regions specified in the whitelist can access resources. Status code 403 is returned for other users. Default Value N/A
content_type	String	Definition Content type. Constraints N/A Range all: The rule takes effect for all files. file_directory: The rule takes effect for resources in the specified directory. file_path: The rule takes effect for resources corresponding to the path. Default Value N/A
content_value	String	Definition Rule. Constraints When content_type is set to all, this parameter is empty or not passed. When content_type is set to file_directory, the value is a list of up to 100 directories. A directory starts with a slash (/). Multiple directories are separated by commas (,). Example: /test/folder01,/test/folder02. When content_type is set to file_path, the value is a list of up to 100 file paths. A path starts with a slash (/) or wildcard (). Up to two wildcards () are allowed and they cannot be consecutive. Multiple paths are separated by commas (,). Example: /test/a.txt,/test/b.txt. Each whitelist or blacklist rule must be unique. You can configure only one rule for all files. Range N/A Default Value N/A
area	String	Definition Regions to which the rule applies. Constraints Separate regions by commas (,). Example: CN_IN,AF,IE,EG,AU (Chinese mainland, Afghanistan, Ireland, Egypt, and Australia). For details about the location codes, see section "Appendix" > "Geographical Location Codes". Range N/A Default Value N/A
exception_ip	String	Definition Exception IP addresses excluded from this rule. Constraints N/A Range N/A Default Value N/A

**Table 40** ClientCert
Parameter	Type	Description
status	String	Definition Client certificate status. Constraints N/A Range on: enabled. off: disabled. Default Value N/A
trusted_cert	String	Definition Content of the client CA certificate. Constraints Only the PEM format is supported. Range N/A Default Value N/A
hosts	String	Definition Domain names specified in the client CA certificate. Constraints Leave this parameter blank to allow all requests from clients that hold the CA certificate. Add up to 100 domain names. Separate domain names by commas (,) or vertical bars (\|). Range N/A Default Value N/A

Example Requests

GET https://cdn.myhuaweicloud.com/v1.1/cdn/configuration/domains/www.example.com/configs

Example Responses

Status code: 200

Success response.

{
  "configs" : {
    "origin_request_header" : [ ],
    "http_response_header" : [ ],
    "https" : {
      "https_status" : "off"
    },
    "url_auth" : {
      "status" : "off"
    },
    "compress" : {
      "status" : "off"
    },
    "force_redirect" : {
      "status" : "on",
      "type" : "http"
    },
    "origin_protocol" : "follow",
    "referer" : {
      "type" : "string",
      "value" : "string",
      "include_empty" : true
    },
    "ip_filter" : {
      "type" : "string",
      "value" : "string"
    },
    "origin_follow302_status" : "off",
    "cache_rules" : [ {
      "match_type" : "string",
      "match_value" : "string",
      "ttl" : 0,
      "ttl_unit" : "string",
      "priority" : 0,
      "follow_origin" : "string",
      "url_parameter_type" : "string",
      "url_parameter_value" : "string"
    } ],
    "sources" : [ {
      "origin_addr" : "www.example.com",
      "origin_type" : "domain",
      "priority" : 70,
      "http_port" : 80,
      "https_port" : 443
    } ],
    "cache_url_parameter_filter" : {
      "type" : "del_params",
      "value" : "key1;key2"
    },
    "flexible_origin" : [ {
      "priority" : 1,
      "match_type" : "/test",
      "match_pattern" : "file_path",
      "back_sources" : [ {
        "sources_type" : "domain",
        "ip_or_domain" : "www.example.com",
        "obs_bucket_type" : "public"
      } ]
    } ],
    "slice_etag_status" : "off",
    "ipv6_accelerate" : 1,
    "origin_receive_timeout" : 30,
    "remote_auth" : {
      "remote_authentication" : "on",
      "remote_auth_rules" : {
        "auth_server" : "https://1.1.1.1",
        "request_method" : "GET",
        "file_type_setting" : "all",
        "reserve_args_setting" : "reserve_all_args",
        "reserve_args" : "string",
        "specified_file_type" : "string",
        "reserve_headers_setting" : "reserve_specific_headers",
        "auth_success_status" : "200",
        "auth_failed_status" : "403",
        "response_status" : "403",
        "timeout" : 500,
        "timeout_action" : "pass",
        "reserve_headers" : "sf",
        "add_custom_args_rules" : [ {
          "type" : "nginx_preset_var",
          "key" : "http_host",
          "value" : "$http_host"
        } ],
        "add_custom_headers_rules" : [ {
          "type" : "nginx_preset_var",
          "key" : "http_host",
          "value" : "$http_host"
        } ]
      }
    },
    "websocket" : {
      "status" : "off",
      "timeout" : 60
    },
    "video_seek" : {
      "enable_video_seek" : true,
      "enable_flv_by_time_seek" : true,
      "start_parameter" : "start",
      "end_parameter" : "end"
    },
    "request_limit_rules" : [ {
      "status" : "on",
      "type" : "size",
      "limit_rate_after" : 1024,
      "limit_rate_value" : 50
    } ],
    "sni" : {
      "status" : "on",
      "server_name" : "test.example.com"
    },
    "request_url_rewrite" : [ {
      "condition" : {
        "match_type" : "full_path",
        "match_value" : "/test/*.jpg",
        "priority" : 10
      },
      "redirect_status_code" : 301,
      "redirect_url" : "/test/index.html",
      "execution_mode" : "redirect"
    } ],
    "browser_cache_rules" : [ {
      "condition" : {
        "match_type" : "full_path",
        "match_value" : "/test/*.jpg",
        "priority" : 10
      },
      "cache_type" : "ttl",
      "ttl" : 20,
      "ttl_unit" : "h"
    } ],
    "access_area_filter" : [ {
      "type" : "black",
      "content_type" : "all",
      "area" : "CN_IN,AU",
      "exception_ip" : "0.0.0.0"
    } ],
    "client_cert" : {
      "status" : "on",
      "trusted_cert" : "certificate_example",
      "hosts" : "www.example.com"
    }
  }
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cdn.v2.region.CdnRegion;
import com.huaweicloud.sdk.cdn.v2.*;
import com.huaweicloud.sdk.cdn.v2.model.*;


public class ShowDomainFullConfigSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CdnClient client = CdnClient.newBuilder()
                .withCredential(auth)
                .withRegion(CdnRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowDomainFullConfigRequest request = new ShowDomainFullConfigRequest();
        request.withDomainName("{domain_name}");
        try {
            ShowDomainFullConfigResponse response = client.showDomainFullConfig(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcdn.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = CdnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CdnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowDomainFullConfigRequest()
        request.domain_name = "{domain_name}"
        response = client.show_domain_full_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cdn.NewCdnClient(
        cdn.CdnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowDomainFullConfigRequest{}
	request.DomainName = "{domain_name}"
	response, err := client.ShowDomainFullConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     