All Products
Search

This Product

    Edge Security Acceleration:ListSiteFunctions

    Document Center

    Edge Security Acceleration:ListSiteFunctions

    Last Updated:Aug 18, 2026

    Queries the feature configurations of a site. You can query all feature configurations of a site or specify FunctionName to query a specific feature configuration.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    esa:ListSiteFunctions

    none

    *Site

    acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SiteId

    integer

    Yes

    The site ID. You can call the ListSites operation to obtain the site ID.

    340035003106221
    FunctionName

    string

    No

    The function name of the feature.

    CacheRules
    ConfigId

    integer

    No

    The configuration ID.

    352816096987136
    ConfigType

    string

    No

    The configuration type. You can use this parameter to query global configurations or rule configurations. Valid values:

    rule
    RuleName

    string

    No

    The rule name. Filters the rule that matches the specified name. This parameter takes effect only when FunctionName is specified.

    test
    PageNumber

    integer

    No

    The page number. Default value: 1.

    1
    PageSize

    integer

    No

    The number of entries per page. Maximum value: 500. Default value: 500.

    20
    SiteVersion

    integer

    No

    The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    04F0F334-1335-436C-A1D7-6C044FE73368
    Configs

    object

    The response body configurations.

    CacheRules

    array<object>

    The cache rules.

    object

    The cache rules.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq \"video.example.com\")
    BypassCache

    string

    The bypass cache mode. Valid values:

    • cache_all: all requests are cached.

    • bypass_all: all requests bypass the cache.

    cache_all
    BrowserCacheMode

    string

    The browser cache mode. Valid values:

    • no_cache: no caching.

    • follow_origin: follows the origin server cache policy.

    • override_origin: overrides the origin server cache policy.

    follow_origin
    BrowserCacheTtl

    string

    The browser cache expiration time, in seconds.

    300
    EdgeCacheMode

    string

    The edge cache mode. Valid values:

    • follow_origin: follows the origin server cache policy (if present). Otherwise, uses the default cache policy.

    • no_cache: no caching.

    • override_origin: overrides the origin server cache policy.

    • follow_origin_bypass: follows the origin server cache policy (if present). Otherwise, does not cache.

    follow_origin
    EdgeCacheTtl

    string

    The edge cache expiration time, in seconds.

    300
    EdgeStatusCodeCacheTtl

    string

    The status code cache expiration time, in seconds.

    300
    SortQueryStringForCache

    string

    Specifies whether to sort query strings. Valid values:

    • on: enabled.

    • off: disabled.

    on
    QueryStringMode

    string

    The query string processing mode when generating cache keys. Valid values:

    • ignore_all: ignores all query strings.

    • exclude_query_string: removes specified query strings.

    • reserve_all: retains all query strings. This is the default value.

    • include_query_string: retains specified query strings.

    reserve_all
    QueryString

    string

    The query strings to retain or remove. Multiple values are supported and separated by spaces.

    example
    IncludeHeader

    string

    The header names and their values to include when generating cache keys. Multiple values are supported and separated by spaces.

    example
    IncludeCookie

    string

    The cookie names and their values to include when generating cache keys. Multiple values are supported and separated by spaces.

    cookie_exapmle
    AdditionalCacheablePorts

    string

    The ports on which caching is enabled. Valid values: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, and 2096.

    8880
    CheckPresenceHeader

    string

    Checks whether a header exists when generating cache keys. If the header exists, the header name (case-insensitive) is added to the cache key. Multiple header names are supported and separated by spaces.

    headername
    CheckPresenceCookie

    string

    Checks whether a cookie exists when generating cache keys. If the cookie exists, the cookie name (case-insensitive) is added to the cache key. Multiple cookie names are supported and separated by spaces.

    cookiename
    UserDeviceType

    string

    Specifies whether to include the type of the client when generating cache keys. Valid values:

    • on: enabled.

    • off: shutdown.

    on
    UserGeo

    string

    Specifies whether to include the client geographic location when generating cache keys. Valid values:

    • on: enabled.

    • off: disabled.

    on
    UserLanguage

    string

    Specifies whether to include the client language type when generating cache keys. Valid values:

    • on: enabled.

    • off: disabled.

    on
    ServeStale

    string

    Specifies whether to serve stale cache. When enabled, the edge node can respond to user requests with cached expired content when the origin server is unavailable. Valid values:

    • on: enabled.

    • off: disabled.

    on
    CacheDeceptionArmor

    string

    Specifies whether to enable cache deception armor. This feature protects against web cache deception attacks by caching only content that passes validation. Valid values:

    • on: enabled.

    • off: disabled.

    on
    CacheReserveEligibility

    string

    The cache reserve eligibility. Controls whether requests bypass the cache reserve node during back-to-origin. Valid values:

    • bypass_cache_reserve: requests bypass cache reserve.

    • eligible_for_cache_reserve: requests are eligible for cache reserve.

    bypass_cache_reserve
    PostCache

    string

    The POST cache switch.

    on
    PostBodySizeLimit

    string

    The body size limit, in KB. Supports body sizes from 1 to 8 KB. If left empty, the default value of 8 KB is used.

    1
    PostBodyCacheKey

    string

    The cache key processing mode.

    ignore
    RewriteUrlRules

    array<object>

    The URL rewrite rules.

    object

    The URL rewrite rules.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    RewriteUriType

    string

    The path rewrite type. Valid values:

    • static: static mode.

    static
    Uri

    string

    The target URI after rewriting.

    /image.example.com/index.html
    RewriteQueryStringType

    string

    The query string rewrite type. Valid values:

    • static: static mode.

    static
    QueryString

    string

    The query string after rewriting.

    example=123
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq \"video.example.com\")
    HttpRequestHeaderModificationRules

    array<object>

    The request header modification rules.

    array<object>

    The request header modification rules.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    RequestHeaderModification

    array<object>

    The request header modifications. Supports add, delete, and modify operations.

    [{"operation":"add","name":"header_example_add","value":"value_exapme_add"},{"operation":"del","name":"header_example_delete","value":"value_exapme_delete"},{"operation":"modify","name":"header_example_update","value":"value_exapme_example"}]

    object

    The request header modifications. Supports add, delete, and modify operations.

    Operation

    string

    The operation type. Valid values:

    • add: adds a header.

    • del: deletes a header.

    • modify: modifies a header.

    add
    Name

    string

    The request header name.

    headername
    Value

    string

    The request header value.

    headervalue
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq \"video.example.com\")
    HttpResponseHeaderModificationRules

    array<object>

    The response header modification rules.

    array<object>

    The response header modification rules.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    ResponseHeaderModification

    array<object>

    The response header modifications. Supports add, delete, and modify operations.

    [{"operation":"add","name":"header_example_add","value":"value_exapme_add"},{"operation":"del","name":"header_example_delete","value":"value_exapme_delete"},{"operation":"modify","name":"header_example_update","value":"value_exapme_example"}]

    object

    The response header modifications. Supports add, delete, and modify operations.

    Operation

    string

    The operation type. Valid values:

    • add: adds a header.

    • del: deletes a header.

    • modify: modifies a header.

    add
    Name

    string

    The response header name.

    headername
    Value

    string

    The response header value.

    headervalue
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq \"video.example.com\")
    HttpIncomingRequestHeaderModificationRules

    array<object>

    The inbound request header modification rules.

    array<object>

    The inbound request header modification rules.

    ConfigId

    integer

    The configuration ID.

    430893999331328
    Sequence

    string

    The rule execution order.

    1
    RequestHeaderModification

    array<object>

    The request header modifications. Supports add, delete, and modify operations.

    object

    The request header modifications. Supports add, delete, and modify operations.

    Operation

    string

    The operation type. Valid values:

    • add: adds a header.

    • del: deletes a header.

    • modify: modifies a header.

    add
    Name

    string

    The request header name.

    headername
    Value

    string

    The request header value.

    headervalue
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    http.host eq "videoo.example.com"
    HttpIncomingResponseHeaderModificationRules

    array<object>

    The rules for modifying inbound response headers.

    array<object>

    The rules for modifying inbound response headers.

    ConfigId

    integer

    The configuration ID.

    430893999331328
    Sequence

    string

    The rule execution order.

    1
    ResponseHeaderModification

    array<object>

    The response header modifications. Supports add, delete, and modify operations.

    object

    The response header modifications. Supports add, delete, and modify operations.

    Operation

    string

    The operation type. Valid values:

    • add: adds a header.

    • del: deletes a header.

    • modify: modifies a header.

    add
    Name

    string

    The response header name.

    headername
    Value

    string

    The response header value.

    headervalue
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq "video.example.com")

    ManagedTransforms

    array<object>

    The managed transforms.

    object

    The managed transforms.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    AddClientGeolocationHeaders

    string

    Specifies whether to add visitor geolocation headers. Valid values:

    • on: enabled.

    • off: disabled.

    on
    AddRealClientIpHeader

    string

    Specifies whether to add the "ali-real-client-ip" header that contains the real client IP address. Valid values:

    • on: enabled.

    • off: disabled.

    on
    RedirectRules

    array<object>

    The redirect rules.

    object

    The redirect rules.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq \"video.example.com\")
    Type

    string

    The redirect type. Valid values:

    • static: static mode.

    static
    TargetUrl

    string

    The target URL after redirection.

    http://www.exapmle.com/index.html
    StatusCode

    string

    The response status code used by the edge node when responding with the redirect address to the client. Valid values:

    • 301

    • 302

    • 303

    • 307

    • 308

    301
    ReserveQueryString

    string

    Specifies whether to preserve the query string. Valid values:

    • on: enabled.

    • off: disabled.

    on
    CompressionRules

    array<object>

    The compression rules.

    object

    The compression rules.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq \"video.example.com\")
    Gzip

    string

    Specifies whether to enable Gzip compression. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Brotli

    string

    Specifies whether to enable Brotli compression. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Zstd

    string

    Specifies whether to enable Zstd compression. Valid values:

    • on: enabled.

    • off: disabled.

    on
    OriginRules

    array<object>

    The back-to-origin rules.

    object

    The back-to-origin rules.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq \"video.example.com\")
    OriginHost

    string

    The HOST header carried in the back-to-origin request.

    origin.example.com
    OriginHttpPort

    string

    The origin server port used when fetching content over HTTP.

    8080
    OriginScheme

    string

    The protocol used for back-to-origin requests. Valid values:

    • http: uses HTTP for back-to-origin.

    • https: uses HTTPS for back-to-origin.

    • follow: follows the client protocol for back-to-origin.

    http
    OriginSni

    string

    The SNI carried in the back-to-origin request.

    origin.example.com
    DnsRecord

    string

    The overridden DNS resolution record for back-to-origin requests.

    test.example.com
    OriginHttpsPort

    string

    The origin server port used when fetching content over HTTPS.

    4433
    Range

    string

    Specifies whether to use range-based origin fetch for file downloads. Valid values:

    • on: enabled.

    • off: disabled.

    • force: forced.

    on
    OriginMtls

    string

    Specifies whether to enable mTLS for back-to-origin. Valid values:

    • on: enabled.

    • off: disabled.

    on
    OriginVerify

    string

    Specifies whether to enable origin server certificate verification. Valid values:

    • on: enabled.

    • off: disabled.

    on
    RangeChunkSize

    string

    The range chunk size. Valid values:

    • 512KB

    • 1MB

    • 2MB

    • 4MB

    512KB
    OriginReadTimeout

    string

    The origin read timeout, in seconds.

    300
    ImageTransform

    array<object>

    The image transformation configuration.

    object

    The image transformation configuration.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    Enable

    string

    Specifies whether to enable image transformation. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    off
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq "video.example.com")

    AutoWebp

    string

    The adaptive WebP setting.

    on
    AutoAvif

    string

    The adaptive AVIF setting.

    on
    TieredCache

    array<object>

    The tiered cache configuration.

    object

    The tiered cache configuration.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    CacheArchitectureMode

    string

    The tiered cache architecture mode. Valid values:

    • edge: edge cache layer.

    • edge_smart: edge cache layer + smart cache layer.

    • edge_regional: edge cache layer + regional cache layer.

    • edge_regional_smart: edge cache layer + regional cache layer + smart cache layer.

    edge_smart
    CacheReserve

    array<object>

    The cache reserve configuration.

    object

    The cache reserve configuration.

    ConfigId

    integer

    The configuration ID.

    392382988376064
    Enable

    string

    Specifies whether to enable cache reserve. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    on
    InstanceId

    string

    The cache reserve instance ID.

    cr_hk_123456789
    Ipv6

    array<object>

    The IPv6 configuration.

    object

    The IPv6 configuration.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    Enable

    string

    Specifies whether to enable IPv6. Enabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    SitePause

    array<object>

    Site acceleration pause. Temporarily pauses the proxy acceleration feature for the entire site. When enabled, all DNS records directly return record values to the client.

    Valid values:

    • off :

      off

    • on :

      on

    object

    Site acceleration pause.

    ConfigId

    integer

    The configuration ID.

    302426190190592
    Sequence

    string

    The rule execution order.

    1
    Paused

    string

    Temporarily pauses the proxy acceleration feature for the entire site. When enabled, all DNS records directly return record values to clients. Valid values:

    • true: site acceleration is paused.

    • false: site acceleration is active.

    false
    CacheTags

    array<object>

    The cache tag configuration. When using the purge-by-cache-tag feature, specifies the CacheTag name carried in the origin server response.

    object

    The cache tag configuration.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    TagName

    string

    The custom CacheTag name.

    example
    CaseInsensitive

    string

    Specifies whether to ignore case. Valid values:

    • on: enabled.

    • off: disabled.

    on
    SeoBypass

    array<object>

    The search engine crawler bypass configuration.

    object

    The search engine crawler bypass configuration.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    Enable

    string

    The feature switch. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    on
    DevelopmentMode

    array<object>

    The development mode configuration.

    object

    The development mode configuration.

    ConfigId

    integer

    The configuration ID.

    352816096987136
    Sequence

    string

    The rule execution order.

    1
    Enable

    string

    The feature switch. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    on
    SiteNameExclusive

    array<object>

    Site name exclusive. When enabled, other accounts cannot create sites or subsites with the same name as the current site.

    object

    Site name exclusive.

    ConfigId

    integer

    The configuration ID.

    380858020294656
    Sequence

    string

    The rule execution order.

    0
    Enable

    string

    The feature switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    CnameFlattening

    array<object>

    The CNAME flattening configuration.

    object

    The CNAME flattening configuration.

    ConfigId

    integer

    The configuration ID.

    245523334529026
    Sequence

    string

    The rule execution order.

    0
    FlattenMode

    string

    The flattening mode. Valid values:

    • flatten_all: flattens all records.

    • flatten_at_root: flattens only the root domain. This is the default value.

    flatten_all
    CrossBorderOptimization

    array<object>

    The Chinese mainland network optimization configuration.

    object

    The Chinese mainland network optimization configuration.

    ConfigId

    integer

    The configuration ID.

    245523334529026
    Sequence

    string

    The rule execution order.

    1
    Enable

    string

    Specifies whether to enable Chinese mainland network access optimization. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    on
    HttpsBasicConfiguration

    array<object>

    The HTTPS basic configuration.

    object

    The HTTPS basic configuration.

    ConfigId

    integer

    The configuration ID.

    391380266602496
    Sequence

    string

    The rule execution order.

    1
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The matching rule content.

    (http.host eq \"video.example.com\")
    Https

    string

    Specifies whether to enable HTTPS. Enabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Tls10

    string

    Specifies whether to enable TLS 1.0. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Tls11

    string

    Specifies whether to enable TLS 1.1. Enabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Tls12

    string

    Specifies whether to enable TLS 1.2. Enabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Tls13

    string

    Specifies whether to enable TLS 1.3. Enabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    CiphersuiteGroup

    string

    The cipher suite group. All cipher suites are enabled by default. Valid values:

    • all: all cipher suites.

    • strict: strong cipher suites.

    • custom: custom cipher suites.

    Valid values:

    • all :

      all

    • custom :

      custom

    • strict :

      strict

    all
    Ciphersuite

    string

    The custom cipher suites. Specifies the specific encryption algorithms selected when CiphersuiteGroup is set to custom.

    TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
    OcspStapling

    string

    Specifies whether to enable OCSP stapling. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Http2

    string

    Specifies whether to enable HTTP/2. Enabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Http3

    string

    Specifies whether to enable HTTP/3. Enabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    HttpsApplicationConfiguration

    array<object>

    The HTTPS application configuration.

    object

    The HTTPS application configuration.

    ConfigId

    integer

    The configuration ID.

    391240445274112
    Sequence

    string

    The rule execution order.

    1
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Rule

    string

    The rule content.

    (http.host eq \"video.example.com\")
    HttpsForce

    string

    Specifies whether to enable forced HTTPS. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    HttpsForceCode

    string

    The status code used for forced HTTPS redirect. Valid values:

    • 301

    • 302

    • 307

    • 308

    Valid values:

    • 301 :

      301

    • 302 :

      302

    • 307 :

      307

    • 308 :

      308

    301
    AltSvc

    string

    The Alt-Svc feature switch. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    AltSvcClear

    string

    Specifies whether the Alt-Svc header includes the clear parameter. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    AltSvcPersist

    string

    Specifies whether the Alt-Svc header includes the persist parameter. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    AltSvcMa

    string

    The Alt-Svc validity period, in seconds. Default value: 86400.

    86400
    Hsts

    string

    Specifies whether to enable HSTS. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    HstsMaxAge

    string

    The HSTS expiration time, in seconds.

    3600
    HstsIncludeSubdomains

    string

    Specifies whether to include subdomains in HSTS. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    HstsPreload

    string

    Specifies whether to enable HSTS preload. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    NetworkOptimization

    array<object>

    The network optimization configuration.

    object

    The network optimization configuration.

    ConfigId

    integer

    The configuration ID.

    395901755670528
    Sequence

    string

    The rule execution order.

    1
    RuleName

    string

    The rule name.

    rule_example

    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Rule

    string

    The rule content.

    (http.host eq \"video.example.com\")
    SmartRouting

    string

    Specifies whether to enable smart routing. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Http2Origin

    string

    Specifies whether to enable HTTP/2 back-to-origin. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Websocket

    string

    Specifies whether to enable WebSocket. Enabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    Grpc

    string

    Specifies whether to enable gRPC. Disabled by default. Valid values:

    • on: enabled.

    • off: disabled.

    Valid values:

    • off :

      off

    • on :

      on

    on
    UploadMaxFilesize

    string

    The maximum upload file size, in MB. Valid values: 100 to 500.

    300
    VideoProcessing

    array<object>

    The video processing configurations.

    object

    The video processing configurations.

    ConfigId

    integer

    The configuration ID.

    455153377667072
    Sequence

    string

    The rule execution order.

    1
    RuleName

    string

    The rule name.

    rule_example
    RuleEnable

    string

    The rule switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content.

    (http.host eq "video.example.com")

    VideoSeekEnable

    string

    The video seeking switch. Valid values:

    • on: enabled.

    • off: disabled.

    on
    FlvVideoSeekMode

    string

    The FLV seeking mode. Valid values:

    • by_byte: seeks by byte.

    • by_time: seeks by time.

    by_time
    Mp4SeekStart

    string

    The custom MP4 start parameter.

    m_start
    Mp4SeekEnd

    string

    The custom MP4 end parameter.

    m_end
    FlvSeekStart

    string

    The custom FLV start parameter.

    f_start
    FlvSeekEnd

    string

    The custom FLV end parameter.

    f_end
    CustomResponseCode

    array<object>

    The custom response code configurations.

    object

    The custom response code configurations.

    ConfigId

    integer

    The configuration ID.

    457325144242176
    Sequence

    string

    The rule execution order. A smaller value indicates a higher priority.

    1
    RuleName

    string

    The rule name. This parameter is not required when adding a global configuration.

    rule_example
    RuleEnable

    string

    The rule switch. This parameter is not required when adding a global configuration. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content. Uses conditional expressions to match user requests. This parameter is not required when adding a global configuration. Two scenarios are supported:

    • Match all incoming requests: set the value to true.

    • Match specified requests: set the value to a custom expression, such as (http.host eq "video.example.com").

    (http.host eq "video.example.com")

    ReturnCode

    string

    The response code.

    200
    PageId

    string

    The response page.

    1
    ErrorPagesRedirects

    array<object>

    The error code redirect rules.

    array<object>

    The error code redirect rules.

    ConfigId

    integer

    The configuration ID.

    473117342636032
    Sequence

    string

    The rule execution order. A smaller value indicates a higher priority.

    1
    RuleName

    string

    The rule name. This parameter is not required when adding a global configuration.

    rule_example
    RuleEnable

    string

    The rule switch. This parameter is not required when adding a global configuration. Valid values:

    • on: enabled.

    • off: disabled.

    on
    Rule

    string

    The rule content. Uses conditional expressions to match user requests. This parameter is not required when adding a global configuration. Two scenarios are supported:

    • Match all incoming requests: set the value to true.

    • Match specified requests: set the value to a custom expression, such as (http.host eq "video.example.com").

    (http.host eq "video.example.com")
    ErrorPagesRedirect

    array<object>

    The error page redirect configuration.

    object

    The error page redirect configuration.

    StatusCode

    string

    The response status code used by the edge node when responding with the redirect address to the client. Valid values:

    • 400

    • 403

    • 404

    • 405

    • 414

    • 416

    • 500

    • 501

    • 502

    • 503

    • 504

    400
    TargetURL

    string

    The target URL after redirection.

    http://example.com/test
    MarkdownForAgent

    array<object>

    object

    ConfigId

    integer

    Sequence

    string

    Enable

    string

    RuleName

    string

    RuleEnable

    string

    Rule

    string

    PageNumber

    integer

    The current page number.

    1
    PageSize

    integer

    The page size.

    10
    TotalCount

    integer

    The total number of records.

    16
    TotalPage

    integer

    The total number of pages.

    2

    Examples

    Success response

    JSON format

    {
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Configs": {
    "CacheRules": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")",
        "BypassCache": "cache_all",
        "BrowserCacheMode": "follow_origin",
        "BrowserCacheTtl": "300",
        "EdgeCacheMode": "follow_origin",
        "EdgeCacheTtl": "300",
        "EdgeStatusCodeCacheTtl": "300",
        "SortQueryStringForCache": "on",
        "QueryStringMode": "reserve_all",
        "QueryString": "example",
        "IncludeHeader": "example",
        "IncludeCookie": "cookie_exapmle",
        "AdditionalCacheablePorts": "8880",
        "CheckPresenceHeader": "headername",
        "CheckPresenceCookie": "cookiename",
        "UserDeviceType": "on",
        "UserGeo": "on",
        "UserLanguage": "on",
        "ServeStale": "on",
        "CacheDeceptionArmor": "on",
        "CacheReserveEligibility": "bypass_cache_reserve",
        "PostCache": "on",
        "PostBodySizeLimit": "1",
        "PostBodyCacheKey": "ignore"
      }
    ],
    "RewriteUrlRules": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "RewriteUriType": "static",
        "Uri": "/image.example.com/index.html",
        "RewriteQueryStringType": "static",
        "QueryString": "example=123",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")"
      }
    ],
    "HttpRequestHeaderModificationRules": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "RequestHeaderModification": [
          {
            "Operation": "add",
            "Name": "headername",
            "Value": "headervalue"
          }
        ],
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")"
      }
    ],
    "HttpResponseHeaderModificationRules": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "ResponseHeaderModification": [
          {
            "Operation": "add",
            "Name": "headername",
            "Value": "headervalue"
          }
        ],
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")"
      }
    ],
    "HttpIncomingRequestHeaderModificationRules": [
      {
        "ConfigId": 430893999331328,
        "Sequence": "1",
        "RequestHeaderModification": [
          {
            "Operation": "add",
            "Name": "headername",
            "Value": "headervalue"
          }
        ],
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "http.host eq \"videoo.example.com\""
      }
    ],
    "HttpIncomingResponseHeaderModificationRules": [
      {
        "ConfigId": 430893999331328,
        "Sequence": "1",
        "ResponseHeaderModification": [
          {
            "Operation": "add",
            "Name": "headername",
            "Value": "headervalue"
          }
        ],
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \"video.example.com\")\n"
      }
    ],
    "ManagedTransforms": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "AddClientGeolocationHeaders": "on",
        "AddRealClientIpHeader": "on"
      }
    ],
    "RedirectRules": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")",
        "Type": "static",
        "TargetUrl": "http://www.exapmle.com/index.html",
        "StatusCode": "301",
        "ReserveQueryString": "on"
      }
    ],
    "CompressionRules": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")",
        "Gzip": "on",
        "Brotli": "on",
        "Zstd": "on"
      }
    ],
    "OriginRules": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")",
        "OriginHost": "origin.example.com",
        "OriginHttpPort": "8080",
        "OriginScheme": "http",
        "OriginSni": "origin.example.com",
        "DnsRecord": "test.example.com",
        "OriginHttpsPort": "4433",
        "Range": "on",
        "OriginMtls": "on",
        "OriginVerify": "on",
        "RangeChunkSize": "512KB",
        "OriginReadTimeout": "300"
      }
    ],
    "ImageTransform": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "Enable": "off",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \"video.example.com\")\n",
        "AutoWebp": "on",
        "AutoAvif": "on"
      }
    ],
    "TieredCache": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "CacheArchitectureMode": "edge_smart"
      }
    ],
    "CacheReserve": [
      {
        "ConfigId": 392382988376064,
        "Enable": "on",
        "InstanceId": "cr_hk_123456789"
      }
    ],
    "Ipv6": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "Enable": "on"
      }
    ],
    "SitePause": [
      {
        "ConfigId": 302426190190592,
        "Sequence": "1",
        "Paused": "false"
      }
    ],
    "CacheTags": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "TagName": "example",
        "CaseInsensitive": "on"
      }
    ],
    "SeoBypass": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "Enable": "on"
      }
    ],
    "DevelopmentMode": [
      {
        "ConfigId": 352816096987136,
        "Sequence": "1",
        "Enable": "on"
      }
    ],
    "SiteNameExclusive": [
      {
        "ConfigId": 380858020294656,
        "Sequence": "0",
        "Enable": "on"
      }
    ],
    "CnameFlattening": [
      {
        "ConfigId": 245523334529026,
        "Sequence": "0",
        "FlattenMode": "flatten_all"
      }
    ],
    "CrossBorderOptimization": [
      {
        "ConfigId": 245523334529026,
        "Sequence": "1",
        "Enable": "on"
      }
    ],
    "HttpsBasicConfiguration": [
      {
        "ConfigId": 391380266602496,
        "Sequence": "1",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")",
        "Https": "on",
        "Tls10": "on",
        "Tls11": "on",
        "Tls12": "on",
        "Tls13": "on",
        "CiphersuiteGroup": "all",
        "Ciphersuite": "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256",
        "OcspStapling": "on",
        "Http2": "on",
        "Http3": "on"
      }
    ],
    "HttpsApplicationConfiguration": [
      {
        "ConfigId": 391240445274112,
        "Sequence": "1",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")",
        "HttpsForce": "on",
        "HttpsForceCode": "301",
        "AltSvc": "on",
        "AltSvcClear": "on",
        "AltSvcPersist": "on",
        "AltSvcMa": "86400",
        "Hsts": "on",
        "HstsMaxAge": "3600",
        "HstsIncludeSubdomains": "on",
        "HstsPreload": "on"
      }
    ],
    "NetworkOptimization": [
      {
        "ConfigId": 395901755670528,
        "Sequence": "1",
        "RuleName": "rule_example\n",
        "RuleEnable": "on",
        "Rule": "(http.host eq \\\"video.example.com\\\")",
        "SmartRouting": "on",
        "Http2Origin": "on",
        "Websocket": "on",
        "Grpc": "on",
        "UploadMaxFilesize": "300"
      }
    ],
    "VideoProcessing": [
      {
        "ConfigId": 455153377667072,
        "Sequence": "1",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \"video.example.com\")\n",
        "VideoSeekEnable": "on",
        "FlvVideoSeekMode": "by_time",
        "Mp4SeekStart": "m_start",
        "Mp4SeekEnd": "m_end",
        "FlvSeekStart": "f_start",
        "FlvSeekEnd": "f_end"
      }
    ],
    "CustomResponseCode": [
      {
        "ConfigId": 457325144242176,
        "Sequence": "1",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \"video.example.com\")\n",
        "ReturnCode": "200",
        "PageId": "1"
      }
    ],
    "ErrorPagesRedirects": [
      {
        "ConfigId": 473117342636032,
        "Sequence": "1",
        "RuleName": "rule_example",
        "RuleEnable": "on",
        "Rule": "(http.host eq \"video.example.com\")",
        "ErrorPagesRedirect": [
          {
            "StatusCode": "400",
            "TargetURL": "http://example.com/test"
          }
        ]
      }
    ],
    "MarkdownForAgent": [
      {
        "ConfigId": 0,
        "Sequence": "",
        "Enable": "",
        "RuleName": "",
        "RuleEnable": "",
        "Rule": ""
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 16,
  "TotalPage": 2
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InternalException Failed to call the service. Try again later or contact technical support. Failed to call the service. Try again later or contact technical support.
    400 InvalidParameter.FunctionName The specified feature does not exist. Specify a valid feature name based on the related documentation. The specified feature does not exist. Specify a valid feature name based on the related documentation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.