Listing Rules in the Rules Engine

Function

This API is used to list rules in the rules engine.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/cdn/configuration/domains/{domain_name}/rules

**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

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
rules	Array of RuleResponse objects	Rule list.

**Table 3** RuleResponse
Parameter	Type	Description
rule_id	String	Rule ID.
name	String	Rule name.
status	String	Rule status. The value can be on (enabled) or off (disabled).
priority	Integer	Rule priority. A larger value indicates a higher priority.
conditions	Conditions object	Definition Conditions for triggering the rule.
actions	Array of Actions objects	Actions to be executed when the rule conditions are met.

**Table 4** Conditions
Parameter	Type	Description
match	Match object	Definition Rule conditions.

**Table 5** Match
Parameter	Type	Description
logic	String	Definition Logical operator. Range and: AND relationship. or: OR relationship.
criteria	Array of Criteria objects	Definition Match condition list.

**Table 6** Criteria
Parameter	Type	Description
match_target_type	String	Definition Match target type. Range scheme: protocol used by a client request. method: request method used by a client request. path: URL requested by a client. arg: query parameters in a request URL. extension: file name extension of content requested by a client. filename: file name of content requested by a client. header: HTTP request headers. clientip: IP address of a client. clientip_version: IP version of a client request. ua: User-Agent of a client request. ngx_variable: Nginx variables.
match_target_name	String	Definition Match target name. Range When the match target type is set to scheme, method, path, extension, filename, or ua, the parameter is left blank. When the match target type is set to arg, the value is the name of a query parameter. It can contain 1 to 100 characters, including letters, digits, hyphens (-), and underscores (_). It must start with a letter. When the match target type is set to header, the value is the name of a request header. It can contain 1 to 100 characters, including letters, digits, hyphens (-), and underscores (_). It must start with a letter. When the match target type is set to clientip, the value is an IP address source. It can be connect (connecting IP) or xff (x-forwarded-for header). When the match target type is set to clientip_version, the value is an IP version source. It can be connect (connecting IP) or xff (x-forwarded-for header). When the match target type is set to ngx_variable, the value is an Nginx variable name. It can be $protocol, $arg_, $http_, $scheme, $uri, $ssl_protocol, $ssl_server_name, $remote_addr, $http2, $request_method, or $sent_http_.
match_type	String	Definition Match algorithm. Range contains: Any condition specified in match_pattern is matched.
match_pattern	Array of strings	Definition Match content. Range When the match target type is set to scheme, the value can be HTTP or HTTPS. When the match target type is set to method, the value can be GET, PUT, POST, DELETE, HEAD, OPTIONS, PATCH, TRACE or CONNECT. When the match target type is set to clientip_version, the value can be IPv4 or IPv6. When the match target type is set to path or ua, the value supports wildcard characters (*).
negate	Boolean	Definition Whether to perform negation. This parameter is used together with match_type. For example, if negate is set to true and match_type is set to contains, the actual service logic is converted to not_contains. Range true: negated. false: not negated.
case_sensitive	Boolean	Definition Case insensitive or not. Range true: case sensitive. false: case-insensitive.
logic	String	Definition Nested condition logic operator. Range and: AND relationship. or: OR relationship.
criteria	Array of Criteria objects	Definition Nested condition list.

**Table 7** Actions
Parameter	Type	Description
flexible_origin	Array of flexibleOriginsEngine objects	Definition Advanced origin rules. CDN can pull content from different origin servers by resource type or path.
origin_request_header	Array of OriginRequestHeader objects	Definition Rewrite the HTTP headers in request URLs during CDN PoP origin pull.
http_response_header	Array of HttpResponseHeader objects	Definition Headers returned by PoPs to clients. CDN includes them in responses to user requests for resources within that domain name.
access_control	AccessControl object	Definition Access control.
request_limit_rule	RequestLimitRulesEngine object	Definition Request rate limiting. This limits the user request rate within a specific range to reduce costs and the risk of burst bandwidth.
origin_request_url_rewrite	OriginRequestUrlRewriteEngine object	Definition Origin request URL rewrite.
cache_rule	CacheRulesEngine object	Definition Parameters used to control the cache TTL of origin server resources on CDN PoPs.
request_url_rewrite	RequestUrlRewriteEngine object	Definition Access URL rewrite rules, which are used to redirect user requests to the URLs of cached content.
browser_cache_rule	BrowserCacheRulesEngine object	Definition Browser cache TTL, during which users can obtain content directly from their browser cache (if available).
error_code_cache	Array of ErrorCodeCacheEngine objects	Definition You can cache error codes returned by the origin server on CDN PoPs. When users request the same resources, CDN directly returns the error codes to the users.

**Table 8** flexibleOriginsEngine
Parameter	Type	Description
sources_type	String	Definition Origin server type. Range ipaddr: origin server IP address. domain: origin server domain name. obs_bucket: OBS bucket domain name. third_bucket: third-party bucket domain name.
ip_or_domain	String	Definition IP address or domain name of the origin server. Range N/A
obs_bucket_type	String	Definition OBS bucket type. Range private: private bucket. public: public bucket.
bucket_access_key	String	Definition Access key of the third-party bucket. Range N/A
bucket_secret_key	String	Definition Secret key of the third-party bucket. Range N/A
bucket_region	String	Definition Region of the third-party bucket. Range N/A
bucket_name	String	Definition Name of the third-party bucket. Range N/A
host_name	String	Definition Host header. Range N/A
origin_protocol	String	Definition Request protocol for CDN origin pull. Range follow: same as user. http: HTTP. https: HTTPS.
http_port	Integer	Definition HTTP port. Range 1 to 65,535.
https_port	Integer	Definition HTTPS port. Range 1 to 65,535.
priority	Integer	Definition Priority. A larger value indicates a higher priority. Range 1 to 100.
weight	Integer	Definition Weight. A larger value indicates that content is pulled from this origin server more frequently. If there are multiple origin servers with the same priority, the weight determines the proportion of content pulled from each origin server. Range 1 to 100.

**Table 9** OriginRequestHeader
Parameter	Type	Description
name	String	Definition Name of an origin request header. Range Enter 1 to 100 characters. Use only letters, digits, and hyphens (-). Start with a letter.
value	String	Definition Value of the origin request header. 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.
action	String	Definition Operation type of the origin request header. 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

**Table 10** HttpResponseHeader
Parameter	Type	Description
name	String	Definition Name of an HTTP response header. Range Enter 1 to 100 characters. Use only letters, digits, and hyphens (-). Start with a letter.
value	String	Definition Value of the HTTP response header. 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.
action	String	Definition Operation type of the HTTP response header. 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

**Table 11** AccessControl
Parameter	Type	Description
type	String	Definition Access control type. Range block: Block. trust: Allow.

**Table 12** RequestLimitRulesEngine
Parameter	Type	Description
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. Range 0 to 1,073,741,824, in bytes.
limit_rate_value	Integer	Definition Rate limit, that is, the maximum access speed after the rate limit is reached. Range 0 to 104,857,600, in bit/s.

**Table 13** OriginRequestUrlRewriteEngine
Parameter	Type	Description
rewrite_type	String	Definition Rewrite method. Range simple: exact. wildcard: capturing. regex: regular expression. (for whitelisted customers only. Submit a service ticket to enable this function.)
source_url	String	Definition URI to rewrite. rewrite_type is set to wildcard or regex. When rewrite_type is set to regex, this parameter must start with ^/. Example: ^/test. 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.
target_url	String	Definition URI after rewrite. 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*.

**Table 14** CacheRulesEngine
Parameter	Type	Description
ttl	Integer	Definition TTL of a resource cached on CDN PoPs. Range N/A
ttl_unit	String	Definition Unit of the cache TTL. Range s: second. m: minute. h: hour. d: day.
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. 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.
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. Range on: enabled. off: disabled.

**Table 15** RequestUrlRewriteEngine
Parameter	Type	Description
redirect_status_code	Integer	Definition Redirection status code. Range 301 302 303 307
redirect_url	String	Definition Redirection URL. 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
redirect_host	String	Definition Domain name to which client requests are redirected. Range Enter 1 to 255 characters. Start with http:// or https://.
execution_mode	String	Definition Action. 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.

**Table 16** BrowserCacheRulesEngine
Parameter	Type	Description
cache_type	String	Definition Cache effective type. 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.
ttl	Integer	Definition Cache TTL. ttl. Range N/A
ttl_unit	String	Definition Unit of the cache TTL. ttl. Range s: second m: minute h: hour d: day

**Table 17** ErrorCodeCacheEngine
Parameter	Type	Description
code	Integer	Definition Error codes to cache. Range 3xx: 301 and 302. 4xx: 400, 403, 404, 405, and 414. 5xx: 501, 502, 503, and 504.
ttl	Integer	Definition Error code cache TTL. Range 0 to 31,536,000, in seconds. NOTE: The cache TTL of 3XX status codes ranges from 0s to 20s.

Example Requests

GET https://cdn.myhuaweicloud.com/v1.0/cdn/configuration/domains/www.example.com/rules

Example Responses

Status code: 200

Request succeeded.

{
  "rules" : [ {
    "rule_id" : "example***********************id",
    "name" : "example",
    "status" : "on",
    "priority" : 1,
    "conditions" : {
      "match" : {
        "logic" : "and",
        "criteria" : [ {
          "match_target_type" : "scheme",
          "match_target_name" : "example",
          "match_type" : "contains",
          "match_pattern" : [ "HTTP" ],
          "negate" : false,
          "case_sensitive" : false
        } ]
      }
    }
  } ]
}

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 ListRuleDetailsSolution {

    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();
        ListRuleDetailsRequest request = new ListRuleDetailsRequest();
        request.withDomainName("{domain_name}");
        try {
            ListRuleDetailsResponse response = client.listRuleDetails(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 = ListRuleDetailsRequest()
        request.domain_name = "{domain_name}"
        response = client.list_rule_details(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, err := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := cdn.CdnClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := cdn.NewCdnClient(hcClient)

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