Cloud CDN API, gRPC: ResourceRulesService.List

Written by

Yandex Cloud

Updated at October 17, 2024

gRPC request
ListResourceRulesRequest
ListResourceRulesResponse
Rule
ResourceOptions
BoolOption
EdgeCacheSettings
CachingTimes
Int64Option
StringsListOption
QueryParamsOptions
CompressionOptions
RedirectOptions
HostOptions
StringOption
StringsMapOption
RewriteOption
SecureKeyOption
IPAddressACLOption

List all rules for specified resource.

gRPC request

rpc List (ListResourceRulesRequest) returns (ListResourceRulesResponse)

ListResourceRulesRequest

{
  "resourceId": "string"
}

Field

Description

resourceId

string

Required field. ID of resource.

ListResourceRulesResponse

{
  "rules": [
    {
      "id": "int64",
      "name": "string",
      "rulePattern": "string",
      "options": {
        "disableCache": {
          "enabled": "bool",
          "value": "bool"
        },
        "edgeCacheSettings": {
          "enabled": "bool",
          // Includes only one of the fields `value`, `defaultValue`
          "value": {
            "simpleValue": "int64",
            "customValues": "int64"
          },
          "defaultValue": "int64"
          // end of the list of possible fields
        },
        "browserCacheSettings": {
          "enabled": "bool",
          "value": "int64"
        },
        "cacheHttpHeaders": {
          "enabled": "bool",
          "value": [
            "string"
          ]
        },
        "queryParamsOptions": {
          // Includes only one of the fields `ignoreQueryString`, `queryParamsWhitelist`, `queryParamsBlacklist`
          "ignoreQueryString": {
            "enabled": "bool",
            "value": "bool"
          },
          "queryParamsWhitelist": {
            "enabled": "bool",
            "value": [
              "string"
            ]
          },
          "queryParamsBlacklist": {
            "enabled": "bool",
            "value": [
              "string"
            ]
          }
          // end of the list of possible fields
        },
        "slice": {
          "enabled": "bool",
          "value": "bool"
        },
        "compressionOptions": {
          // Includes only one of the fields `fetchCompressed`, `gzipOn`, `brotliCompression`
          "fetchCompressed": {
            "enabled": "bool",
            "value": "bool"
          },
          "gzipOn": {
            "enabled": "bool",
            "value": "bool"
          },
          "brotliCompression": {
            "enabled": "bool",
            "value": [
              "string"
            ]
          }
          // end of the list of possible fields
        },
        "redirectOptions": {
          // Includes only one of the fields `redirectHttpToHttps`, `redirectHttpsToHttp`
          "redirectHttpToHttps": {
            "enabled": "bool",
            "value": "bool"
          },
          "redirectHttpsToHttp": {
            "enabled": "bool",
            "value": "bool"
          }
          // end of the list of possible fields
        },
        "hostOptions": {
          // Includes only one of the fields `host`, `forwardHostHeader`
          "host": {
            "enabled": "bool",
            "value": "string"
          },
          "forwardHostHeader": {
            "enabled": "bool",
            "value": "bool"
          }
          // end of the list of possible fields
        },
        "staticHeaders": {
          "enabled": "bool",
          "value": "string"
        },
        "cors": {
          "enabled": "bool",
          "value": [
            "string"
          ]
        },
        "stale": {
          "enabled": "bool",
          "value": [
            "string"
          ]
        },
        "allowedHttpMethods": {
          "enabled": "bool",
          "value": [
            "string"
          ]
        },
        "proxyCacheMethodsSet": {
          "enabled": "bool",
          "value": "bool"
        },
        "disableProxyForceRanges": {
          "enabled": "bool",
          "value": "bool"
        },
        "staticRequestHeaders": {
          "enabled": "bool",
          "value": "string"
        },
        "customServerName": {
          "enabled": "bool",
          "value": "string"
        },
        "ignoreCookie": {
          "enabled": "bool",
          "value": "bool"
        },
        "rewrite": {
          "enabled": "bool",
          "body": "string",
          "flag": "RewriteFlag"
        },
        "secureKey": {
          "enabled": "bool",
          "key": "string",
          "type": "SecureKeyURLType"
        },
        "ipAddressAcl": {
          "enabled": "bool",
          "policyType": "PolicyType",
          "exceptedValues": [
            "string"
          ]
        }
      }
    }
  ]
}

Field

Description

rules[]

Rule

List of the resource rules.

Rule

Resource rule.

Field	Description
id	int64 Rule ID.
name	string Required field. Rule name.
rulePattern	string Required field. Rule pattern. Must be a valid regular expression.
options	ResourceOptions

ResourceOptions

A major set of various resource options.

Field	Description
disableCache	BoolOption Set up a cache status.
edgeCacheSettings	EdgeCacheSettings Set up EdgeCacheSettings.
browserCacheSettings	Int64Option Using Int64Option. Set up a cache period for the end-users browser. Content will be cached due to origin settings. If there are no cache settings on your origin, the content will not be cached. The list of HTTP response codes that can be cached in browsers: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308. Other response codes will not be cached. The default value is 4 days.
cacheHttpHeaders	StringsListOption List HTTP headers that must be included in responses to clients.
queryParamsOptions	QueryParamsOptions Set up QueryParamsOptions.
slice	BoolOption Files larger than 10 MB will be requested and cached in parts (no larger than 10 MB each part). It reduces time to first byte. The origin must support HTTP Range requests. By default the option is disabled.
compressionOptions	CompressionOptions Set up compression variant.
redirectOptions	RedirectOptions Set up redirects.
hostOptions	HostOptions Set up host parameters.
staticHeaders	StringsMapOption Set up static headers that CDN servers send in responses to clients.
cors	StringsListOption Parameter that lets browsers get access to selected resources from a domain different to a domain from which the request is received. Read more.
stale	StringsListOption List of errors which instruct CDN servers to serve stale content to clients. Possible values: `error`, `http_403`, `http_404`, `http_429`, `http_500`, `http_502`, `http_503`, `http_504`, `invalid_header`, `timeout`, `updating`.
allowedHttpMethods	StringsListOption HTTP methods for your CDN content. By default the following methods are allowed: GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS. In case some methods are not allowed to the user, they will get the 405 (Method Not Allowed) response. If the method is not supported, the user gets the 501 (Not Implemented) response.
proxyCacheMethodsSet	BoolOption Allows caching for GET, HEAD and POST requests.
disableProxyForceRanges	BoolOption Disabling proxy force ranges.
staticRequestHeaders	StringsMapOption Set up custom headers that CDN servers send in requests to origins. The Header name field can contain letters (A-Z, a-z), numbers (0-9), dashes (-) and underscores (). The Value field can contain letters (A-Z, a-z), numbers (0-9), dashes (-), underscores (), slashes (/), colons (:), equal (=), dots (.), and spaces.
customServerName	StringOption Wildcard additional CNAME. If a resource has a wildcard additional CNAME, you can use your own certificate for content delivery via HTTPS. Read-only.
ignoreCookie	BoolOption Using BoolOption for ignoring cookie.
rewrite	RewriteOption Changing or redirecting query paths.
secureKey	SecureKeyOption Secure token to protect contect and limit access by IP addresses and time limits.
ipAddressAcl	IPAddressACLOption Manage the state of the IP access policy option. The option controls access to content from the specified IP addresses.

BoolOption

Set up bool values.

Field

Description

enabled

bool

True - the option is enabled and its value is applied to the resource.
False - the option is disabled and its default value is used for the resource.

value

bool

Value of the option.

EdgeCacheSettings

A set of the edge cache parameters.

Field	Description
enabled	bool True - the option is enabled and its `values_variant` is applied to the resource. False - the option is disabled and its default value is used for the resource.
value	CachingTimes Value of the option. Includes only one of the fields `value`, `defaultValue`.
defaultValue	int64 Content will be cached according to origin cache settings. The value applies for a response with codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308 if an origin server does not have caching HTTP headers. Responses with other codes will not be cached. Includes only one of the fields `value`, `defaultValue`.

CachingTimes

A set of the caching response time parameters.

Field

Description

simpleValue

int64

Caching time for a response with codes 200, 206, 301, 302.
Responses with codes 4xx, 5xx will not be cached. Use 0s disable to caching.
Use customValues field to specify a custom caching time for a response with specific codes.

customValues

int64

Caching time for a response with specific codes. These settings have a higher priority than the value field.
Response code (304, 404 for example). Use any to specify caching time for all response codes.
Caching time in seconds (0s, 600s for example). Use 0s to disable caching for a specific response code.

Int64Option

A set of the numeric parameters.

Field

Description

enabled

bool

True - the option is enabled and its value is applied to the resource.
False - the option is disabled and its default value is used for the resource.

value

int64

Value of the option.

StringsListOption

A set of the string list parameters.

Field

Description

enabled

bool

True - the option is enabled and its value is applied to the resource.
False - the option is disabled and its default value is used for the resource.

value[]

string

Value of the option.

QueryParamsOptions

A set of the query parameters.

Field	Description
ignoreQueryString	BoolOption Using BoolOption. Selected by default. Files with different query parameters are cached as objects with the same key regardless of the parameter value. Includes only one of the fields `ignoreQueryString`, `queryParamsWhitelist`, `queryParamsBlacklist`.
queryParamsWhitelist	StringsListOption Ignore All Except. Files with the specified query parameters are cached as objects with different keys, files with other parameters are cached as objects with the same key. Includes only one of the fields `ignoreQueryString`, `queryParamsWhitelist`, `queryParamsBlacklist`.
queryParamsBlacklist	StringsListOption Ignore only. Files with the specified query parameters are cached as objects with the same key, files with other parameters are cached as objects with different keys. Includes only one of the fields `ignoreQueryString`, `queryParamsWhitelist`, `queryParamsBlacklist`.

CompressionOptions

A set of the compression variant parameters.

Field	Description
fetchCompressed	BoolOption The Fetch compressed option helps you to reduce the bandwidth between origin and CDN servers. Also, content delivery speed becomes higher because of reducing the time for compressing files in a CDN. Includes only one of the fields `fetchCompressed`, `gzipOn`, `brotliCompression`.
gzipOn	BoolOption Using BoolOption. GZip compression at CDN servers reduces file size by 70% and can be as high as 90%. Includes only one of the fields `fetchCompressed`, `gzipOn`, `brotliCompression`.
brotliCompression	StringsListOption The option allows to compress content with brotli on the CDN's end. Compression is performed on the Origin Shielding. If a pre-cache server doesn't active for a resource, compression does not occur even if the option is enabled. Specify the content-type for each type of content you wish to have compressed. CDN servers will request only uncompressed content from the origin. Includes only one of the fields `fetchCompressed`, `gzipOn`, `brotliCompression`.

RedirectOptions

A set of the redirect parameters.

Field

Description

redirectHttpToHttps

BoolOption

Using BoolOption. Set up a redirect from HTTPS to HTTP.

Includes only one of the fields redirectHttpToHttps, redirectHttpsToHttp.

redirectHttpsToHttp

BoolOption

Using BoolOption. Set up a redirect from HTTP to HTTPS.

Includes only one of the fields redirectHttpToHttps, redirectHttpsToHttp.

HostOptions

A set of the host parameters.

Field

Description

host

StringOption

Custom value for the Host header.

Your server must be able to process requests with the chosen header.

Default value (if StringOption.enabled is false) is Resource.cname.

Includes only one of the fields host, forwardHostHeader.

forwardHostHeader

BoolOption

Using BoolOption. Choose the Forward Host header option if is important to send in the request to the Origin
the same Host header as was sent in the request to CDN server.

Includes only one of the fields host, forwardHostHeader.

StringOption

A set of the string parameters.

Field

Description

enabled

bool

True - the option is enabled and its value is applied to the resource.
False - the option is disabled and its default value is used for the resource.

value

string

Value of the option.

StringsMapOption

A set of the strings map parameters.

Field

Description

enabled

bool

True - the option is enabled and its value is applied to the resource.
False - the option is disabled and its default value is used for the resource.

value

string

Value of the option.

RewriteOption

An option for changing or redirecting query paths.

Field	Description
enabled	bool True - the option is enabled and its `flag` is applied to the resource. False - the option is disabled and its default value of the `flag` is used for the resource.
body	string Pattern for rewrite. The value must have the following format: `<source path> <destination path>`, where both paths are regular expressions which use at least one group. E.g., `/foo/(.*) /bar/$1`.
flag	enum RewriteFlag Break flag is applied to the option by default. It is not shown in the field. `REWRITE_FLAG_UNSPECIFIED` `LAST`: Stops processing of the current set of ngx_http_rewrite_module directives and starts a search for a new location matching changed URI. `BREAK`: Stops processing of the current set of the Rewrite option. `REDIRECT`: Returns a temporary redirect with the 302 code; It is used when a replacement string does not start with "http://", "https://", or "$scheme". `PERMANENT`: Returns a permanent redirect with the 301 code.

SecureKeyOption

Field	Description
enabled	bool True - the option is enabled and its flag is applied to the resource. False - the option is disabled and its default value of the flag is used for the resource.
key	string The key for the URL signing.
type	enum SecureKeyURLType The type of the URL signing. The URL could be available for all IP addresses or for the only one IP. `SECURE_KEY_URL_TYPE_UNSPECIFIED` `ENABLE_IP_SIGNING`: Use scpecific IP address in URL signing. URL will be availible only for this IP. `DISABLE_IP_SIGNING`: Sign URL without using IP address. URL will be available for all IP addresses.

IPAddressACLOption

Field	Description
enabled	bool True - the option is enabled and its flag is applied to the resource. False - the option is disabled and its default value of the flag is used for the resource.
policyType	enum PolicyType The policy type. One of allow or deny value. `POLICY_TYPE_UNSPECIFIED` `POLICY_TYPE_ALLOW`: Allow access to all IP addresses except the ones specified in the excepted_values field. `POLICY_TYPE_DENY`: Block access to all IP addresses except the ones specified in the excepted_values field.
exceptedValues[]	string The list of IP addresses to be allowed or denied.

Cloud CDN API, gRPC: ResourceRulesService.List

gRPC requestgRPC request

ListResourceRulesRequestListResourceRulesRequest

ListResourceRulesResponseListResourceRulesResponse

RuleRule

ResourceOptionsResourceOptions

BoolOptionBoolOption

EdgeCacheSettingsEdgeCacheSettings

CachingTimesCachingTimes

Int64OptionInt64Option

StringsListOptionStringsListOption

QueryParamsOptionsQueryParamsOptions

CompressionOptionsCompressionOptions

RedirectOptionsRedirectOptions

HostOptionsHostOptions

StringOptionStringOption

StringsMapOptionStringsMapOption

RewriteOptionRewriteOption

SecureKeyOptionSecureKeyOption

IPAddressACLOptionIPAddressACLOption

Was the article helpful?

gRPC request

ListResourceRulesRequest

ListResourceRulesResponse

Rule

ResourceOptions

BoolOption

EdgeCacheSettings

CachingTimes

Int64Option

StringsListOption

QueryParamsOptions

CompressionOptions

RedirectOptions

HostOptions

StringOption

StringsMapOption

RewriteOption

SecureKeyOption

IPAddressACLOption