Cloud CDN API, gRPC: ResourceRulesService
- Calls ResourceRulesService
- List
- ListResourceRulesRequest
- ListResourceRulesResponse
- Rule
- ResourceOptions
- BoolOption
- StringOption
- Int64Option
- StringsListOption
- StringsMapOption
- CachingTimes
- EdgeCacheSettings
- StringVariableMapOption
- OneofString
- QueryParamsOptions
- RedirectOptions
- HostOptions
- CompressionOptions
- RewriteOption
- SecureKeyOption
- IPAddressACLOption
- Create
- CreateResourceRuleRequest
- ResourceOptions
- BoolOption
- StringOption
- Int64Option
- StringsListOption
- StringsMapOption
- CachingTimes
- EdgeCacheSettings
- StringVariableMapOption
- OneofString
- QueryParamsOptions
- RedirectOptions
- HostOptions
- CompressionOptions
- RewriteOption
- SecureKeyOption
- IPAddressACLOption
- Operation
- CreateResourceRuleMetadata
- Rule
- Get
- Update
- UpdateResourceRuleRequest
- ResourceOptions
- BoolOption
- StringOption
- Int64Option
- StringsListOption
- StringsMapOption
- CachingTimes
- EdgeCacheSettings
- StringVariableMapOption
- OneofString
- QueryParamsOptions
- RedirectOptions
- HostOptions
- CompressionOptions
- RewriteOption
- SecureKeyOption
- IPAddressACLOption
- Operation
- UpdateResourceRuleMetadata
- Rule
- Delete
Rules management service.
Used for Resources Rules management.
Call | Description |
---|---|
List | List all rules for specified resource. |
Create | Create new resource rule with specified unique name and rule patter. |
Get | Get specified by id resource rule. |
Update | Update specified by id resource rule. |
Delete | Delete specified by id resource rule. |
Calls ResourceRulesService
List
List all rules for specified resource.
rpc List (ListResourceRulesRequest) returns (ListResourceRulesResponse)
ListResourceRulesRequest
Field | Description |
---|---|
resource_id | string Required. ID of resource. The maximum string length in characters is 50. |
ListResourceRulesResponse
Field | Description |
---|---|
rules[] | Rule List of the resource rules. |
Rule
Field | Description |
---|---|
id | int64 Rule ID. Value must be greater than 0. |
name | string Required. Rule name. The maximum string length in characters is 50. |
rule_pattern | string Required. Rule pattern. Must be a valid regular expression. The maximum string length in characters is 100. |
options | ResourceOptions |
ResourceOptions
Field | Description |
---|---|
disable_cache | BoolOption Set up a cache status. |
edge_cache_settings | EdgeCacheSettings Set up EdgeCacheSettings. |
browser_cache_settings | 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. |
cache_http_headers | StringsListOption List HTTP headers that must be included in responses to clients. |
query_params_options | 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. |
compression_options | CompressionOptions Set up compression variant. |
redirect_options | RedirectOptions Set up redirects. |
host_options | HostOptions Set up host parameters. |
static_headers | 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 . |
allowed_http_methods | 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. |
proxy_cache_methods_set | BoolOption Allows caching for GET, HEAD and POST requests. |
disable_proxy_force_ranges | BoolOption Disabling proxy force ranges. |
static_request_headers | 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. |
custom_server_name | 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. |
ignore_cookie | BoolOption Using BoolOption for ignoring cookie. |
rewrite | RewriteOption Changing or redirecting query paths. |
secure_key | SecureKeyOption Secure token to protect contect and limit access by IP addresses and time limits. |
ip_address_acl | IPAddressACLOption Manage the state of the IP access policy option. The option controls access to content from the specified IP addresses. |
BoolOption
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. |
StringOption
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. |
Int64Option
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
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
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 | map<string,string> Value of the option. |
CachingTimes
Field | Description |
---|---|
simple_value | 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 custom_values field to specify a custom caching time for a response with specific codes. |
custom_values | map<string,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. |
EdgeCacheSettings
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. |
values_variant | oneof: value or default_value |
value | CachingTimes Value of the option. |
default_value | 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. |
StringVariableMapOption
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 | map<string,OneofString> Value of the option. |
OneofString
Field | Description |
---|---|
string_option | oneof: value or values |
value | StringOption Using StringOption to set value. |
values | StringsListOption Using StringsListOption to set values. |
QueryParamsOptions
Field | Description |
---|---|
query_params_variant | oneof: ignore_query_string , query_params_whitelist or query_params_blacklist |
ignore_query_string | BoolOption Using BoolOption. Selected by default. Files with different query parameters are cached as objects with the same key regardless of the parameter value. |
query_params_whitelist | 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. |
query_params_blacklist | 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. |
RedirectOptions
Field | Description |
---|---|
redirect_variant | oneof: redirect_http_to_https or redirect_https_to_http |
redirect_http_to_https | BoolOption Using BoolOption. Set up a redirect from HTTPS to HTTP. |
redirect_https_to_http | BoolOption Using BoolOption. Set up a redirect from HTTP to HTTPS. |
HostOptions
Field | Description |
---|---|
host_variant | oneof: host or forward_host_header |
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. |
forward_host_header | 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. |
CompressionOptions
Field | Description |
---|---|
compression_variant | oneof: fetch_compressed , gzip_on or brotli_compression |
fetch_compressed | 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. |
gzip_on | BoolOption Using BoolOption. GZip compression at CDN servers reduces file size by 70% and can be as high as 90%. |
brotli_compression | 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. |
RewriteOption
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.
|
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.
|
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. |
policy_type | enum PolicyType The policy type. One of allow or deny value.
|
excepted_values[] | string The list of IP addresses to be allowed or denied. |
Create
Create new resource rule with specified unique name and rule patter.
rpc Create (CreateResourceRuleRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateResourceRuleMetadata
Operation.response:Rule
CreateResourceRuleRequest
Field | Description |
---|---|
resource_id | string Required. ID of resource. The maximum string length in characters is 50. |
name | string Required. Name of created resource rule. The maximum string length in characters is 50. |
rule_pattern | string Required. Resource rule pattern. The maximum string length in characters is 100. |
options | ResourceOptions |
ResourceOptions
Field | Description |
---|---|
disable_cache | BoolOption Set up a cache status. |
edge_cache_settings | EdgeCacheSettings Set up EdgeCacheSettings. |
browser_cache_settings | 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. |
cache_http_headers | StringsListOption List HTTP headers that must be included in responses to clients. |
query_params_options | 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. |
compression_options | CompressionOptions Set up compression variant. |
redirect_options | RedirectOptions Set up redirects. |
host_options | HostOptions Set up host parameters. |
static_headers | 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 . |
allowed_http_methods | 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. |
proxy_cache_methods_set | BoolOption Allows caching for GET, HEAD and POST requests. |
disable_proxy_force_ranges | BoolOption Disabling proxy force ranges. |
static_request_headers | 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. |
custom_server_name | 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. |
ignore_cookie | BoolOption Using BoolOption for ignoring cookie. |
rewrite | RewriteOption Changing or redirecting query paths. |
secure_key | SecureKeyOption Secure token to protect contect and limit access by IP addresses and time limits. |
ip_address_acl | IPAddressACLOption Manage the state of the IP access policy option. The option controls access to content from the specified IP addresses. |
BoolOption
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. |
StringOption
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. |
Int64Option
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
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
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 | map<string,string> Value of the option. |
CachingTimes
Field | Description |
---|---|
simple_value | 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 custom_values field to specify a custom caching time for a response with specific codes. |
custom_values | map<string,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. |
EdgeCacheSettings
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. |
values_variant | oneof: value or default_value |
value | CachingTimes Value of the option. |
default_value | 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. |
StringVariableMapOption
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 | map<string,OneofString> Value of the option. |
OneofString
Field | Description |
---|---|
string_option | oneof: value or values |
value | StringOption Using StringOption to set value. |
values | StringsListOption Using StringsListOption to set values. |
QueryParamsOptions
Field | Description |
---|---|
query_params_variant | oneof: ignore_query_string , query_params_whitelist or query_params_blacklist |
ignore_query_string | BoolOption Using BoolOption. Selected by default. Files with different query parameters are cached as objects with the same key regardless of the parameter value. |
query_params_whitelist | 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. |
query_params_blacklist | 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. |
RedirectOptions
Field | Description |
---|---|
redirect_variant | oneof: redirect_http_to_https or redirect_https_to_http |
redirect_http_to_https | BoolOption Using BoolOption. Set up a redirect from HTTPS to HTTP. |
redirect_https_to_http | BoolOption Using BoolOption. Set up a redirect from HTTP to HTTPS. |
HostOptions
Field | Description |
---|---|
host_variant | oneof: host or forward_host_header |
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. |
forward_host_header | 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. |
CompressionOptions
Field | Description |
---|---|
compression_variant | oneof: fetch_compressed , gzip_on or brotli_compression |
fetch_compressed | 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. |
gzip_on | BoolOption Using BoolOption. GZip compression at CDN servers reduces file size by 70% and can be as high as 90%. |
brotli_compression | 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. |
RewriteOption
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.
|
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.
|
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. |
policy_type | enum PolicyType The policy type. One of allow or deny value.
|
excepted_values[] | string The list of IP addresses to be allowed or denied. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateResourceRuleMetadata
Field | Description |
---|---|
resource_id | string Required. ID of resource. The maximum string length in characters is 50. |
rule_id | int64 ID of created resource rule. Value must be greater than 0. |
Rule
Field | Description |
---|---|
id | int64 Rule ID. Value must be greater than 0. |
name | string Required. Rule name. The maximum string length in characters is 50. |
rule_pattern | string Required. Rule pattern. Must be a valid regular expression. The maximum string length in characters is 100. |
options | ResourceOptions |
Get
Get specified by id resource rule.
rpc Get (GetResourceRuleRequest) returns (Rule)
GetResourceRuleRequest
Field | Description |
---|---|
resource_id | string Required. ID of resource. The maximum string length in characters is 50. |
rule_id | int64 ID of the requested resource rule. Value must be greater than 0. |
Rule
Field | Description |
---|---|
id | int64 Rule ID. Value must be greater than 0. |
name | string Required. Rule name. The maximum string length in characters is 50. |
rule_pattern | string Required. Rule pattern. Must be a valid regular expression. The maximum string length in characters is 100. |
options | ResourceOptions |
ResourceOptions
Field | Description |
---|---|
disable_cache | BoolOption Set up a cache status. |
edge_cache_settings | EdgeCacheSettings Set up EdgeCacheSettings. |
browser_cache_settings | 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. |
cache_http_headers | StringsListOption List HTTP headers that must be included in responses to clients. |
query_params_options | 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. |
compression_options | CompressionOptions Set up compression variant. |
redirect_options | RedirectOptions Set up redirects. |
host_options | HostOptions Set up host parameters. |
static_headers | 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 . |
allowed_http_methods | 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. |
proxy_cache_methods_set | BoolOption Allows caching for GET, HEAD and POST requests. |
disable_proxy_force_ranges | BoolOption Disabling proxy force ranges. |
static_request_headers | 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. |
custom_server_name | 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. |
ignore_cookie | BoolOption Using BoolOption for ignoring cookie. |
rewrite | RewriteOption Changing or redirecting query paths. |
secure_key | SecureKeyOption Secure token to protect contect and limit access by IP addresses and time limits. |
ip_address_acl | IPAddressACLOption Manage the state of the IP access policy option. The option controls access to content from the specified IP addresses. |
BoolOption
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. |
StringOption
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. |
Int64Option
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
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
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 | map<string,string> Value of the option. |
CachingTimes
Field | Description |
---|---|
simple_value | 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 custom_values field to specify a custom caching time for a response with specific codes. |
custom_values | map<string,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. |
EdgeCacheSettings
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. |
values_variant | oneof: value or default_value |
value | CachingTimes Value of the option. |
default_value | 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. |
StringVariableMapOption
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 | map<string,OneofString> Value of the option. |
OneofString
Field | Description |
---|---|
string_option | oneof: value or values |
value | StringOption Using StringOption to set value. |
values | StringsListOption Using StringsListOption to set values. |
QueryParamsOptions
Field | Description |
---|---|
query_params_variant | oneof: ignore_query_string , query_params_whitelist or query_params_blacklist |
ignore_query_string | BoolOption Using BoolOption. Selected by default. Files with different query parameters are cached as objects with the same key regardless of the parameter value. |
query_params_whitelist | 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. |
query_params_blacklist | 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. |
RedirectOptions
Field | Description |
---|---|
redirect_variant | oneof: redirect_http_to_https or redirect_https_to_http |
redirect_http_to_https | BoolOption Using BoolOption. Set up a redirect from HTTPS to HTTP. |
redirect_https_to_http | BoolOption Using BoolOption. Set up a redirect from HTTP to HTTPS. |
HostOptions
Field | Description |
---|---|
host_variant | oneof: host or forward_host_header |
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. |
forward_host_header | 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. |
CompressionOptions
Field | Description |
---|---|
compression_variant | oneof: fetch_compressed , gzip_on or brotli_compression |
fetch_compressed | 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. |
gzip_on | BoolOption Using BoolOption. GZip compression at CDN servers reduces file size by 70% and can be as high as 90%. |
brotli_compression | 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. |
RewriteOption
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.
|
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.
|
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. |
policy_type | enum PolicyType The policy type. One of allow or deny value.
|
excepted_values[] | string The list of IP addresses to be allowed or denied. |
Update
Update specified by id resource rule.
rpc Update (UpdateResourceRuleRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateResourceRuleMetadata
Operation.response:Rule
UpdateResourceRuleRequest
Field | Description |
---|---|
resource_id | string Required. ID of resource. The maximum string length in characters is 50. |
rule_id | int64 ID of updated resource rule. Value must be greater than 0. |
name | string Name of updated resource rule. The maximum string length in characters is 50. |
rule_pattern | string Resource rule pattern. The maximum string length in characters is 100. |
options | ResourceOptions |
ResourceOptions
Field | Description |
---|---|
disable_cache | BoolOption Set up a cache status. |
edge_cache_settings | EdgeCacheSettings Set up EdgeCacheSettings. |
browser_cache_settings | 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. |
cache_http_headers | StringsListOption List HTTP headers that must be included in responses to clients. |
query_params_options | 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. |
compression_options | CompressionOptions Set up compression variant. |
redirect_options | RedirectOptions Set up redirects. |
host_options | HostOptions Set up host parameters. |
static_headers | 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 . |
allowed_http_methods | 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. |
proxy_cache_methods_set | BoolOption Allows caching for GET, HEAD and POST requests. |
disable_proxy_force_ranges | BoolOption Disabling proxy force ranges. |
static_request_headers | 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. |
custom_server_name | 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. |
ignore_cookie | BoolOption Using BoolOption for ignoring cookie. |
rewrite | RewriteOption Changing or redirecting query paths. |
secure_key | SecureKeyOption Secure token to protect contect and limit access by IP addresses and time limits. |
ip_address_acl | IPAddressACLOption Manage the state of the IP access policy option. The option controls access to content from the specified IP addresses. |
BoolOption
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. |
StringOption
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. |
Int64Option
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
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
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 | map<string,string> Value of the option. |
CachingTimes
Field | Description |
---|---|
simple_value | 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 custom_values field to specify a custom caching time for a response with specific codes. |
custom_values | map<string,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. |
EdgeCacheSettings
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. |
values_variant | oneof: value or default_value |
value | CachingTimes Value of the option. |
default_value | 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. |
StringVariableMapOption
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 | map<string,OneofString> Value of the option. |
OneofString
Field | Description |
---|---|
string_option | oneof: value or values |
value | StringOption Using StringOption to set value. |
values | StringsListOption Using StringsListOption to set values. |
QueryParamsOptions
Field | Description |
---|---|
query_params_variant | oneof: ignore_query_string , query_params_whitelist or query_params_blacklist |
ignore_query_string | BoolOption Using BoolOption. Selected by default. Files with different query parameters are cached as objects with the same key regardless of the parameter value. |
query_params_whitelist | 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. |
query_params_blacklist | 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. |
RedirectOptions
Field | Description |
---|---|
redirect_variant | oneof: redirect_http_to_https or redirect_https_to_http |
redirect_http_to_https | BoolOption Using BoolOption. Set up a redirect from HTTPS to HTTP. |
redirect_https_to_http | BoolOption Using BoolOption. Set up a redirect from HTTP to HTTPS. |
HostOptions
Field | Description |
---|---|
host_variant | oneof: host or forward_host_header |
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. |
forward_host_header | 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. |
CompressionOptions
Field | Description |
---|---|
compression_variant | oneof: fetch_compressed , gzip_on or brotli_compression |
fetch_compressed | 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. |
gzip_on | BoolOption Using BoolOption. GZip compression at CDN servers reduces file size by 70% and can be as high as 90%. |
brotli_compression | 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. |
RewriteOption
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.
|
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.
|
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. |
policy_type | enum PolicyType The policy type. One of allow or deny value.
|
excepted_values[] | string The list of IP addresses to be allowed or denied. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateResourceRuleMetadata
Field | Description |
---|---|
resource_id | string Required. ID of resource. The maximum string length in characters is 50. |
rule_id | int64 ID of updated resource rule. Value must be greater than 0. |
Rule
Field | Description |
---|---|
id | int64 Rule ID. Value must be greater than 0. |
name | string Required. Rule name. The maximum string length in characters is 50. |
rule_pattern | string Required. Rule pattern. Must be a valid regular expression. The maximum string length in characters is 100. |
options | ResourceOptions |
Delete
Delete specified by id resource rule.
rpc Delete (DeleteResourceRuleRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteResourceRuleMetadata
Operation.response:google.protobuf.Empty
DeleteResourceRuleRequest
Field | Description |
---|---|
resource_id | string Required. ID of resource. The maximum string length in characters is 50. |
rule_id | int64 ID of deleted resource rule. Value must be greater than 0. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteResourceRuleMetadata
Field | Description |
---|---|
resource_id | string Required. ID of resource. The maximum string length in characters is 50. |
rule_id | int64 ID of deleted resource rule. Value must be greater than 0. |