Cloud CDN API, gRPC: ResourceService
- Calls ResourceService
- Get
- GetResourceRequest
- Resource
- ResourceOptions
- BoolOption
- StringOption
- Int64Option
- StringsListOption
- StringsMapOption
- CachingTimes
- EdgeCacheSettings
- StringVariableMapOption
- OneofString
- QueryParamsOptions
- RedirectOptions
- HostOptions
- CompressionOptions
- RewriteOption
- SecureKeyOption
- IPAddressACLOption
- SSLCertificate
- SSLCertificateData
- SSLCertificateCMData
- List
- ListResourcesRequest
- ListResourcesResponse
- Resource
- ResourceOptions
- BoolOption
- StringOption
- Int64Option
- StringsListOption
- StringsMapOption
- CachingTimes
- EdgeCacheSettings
- StringVariableMapOption
- OneofString
- QueryParamsOptions
- RedirectOptions
- HostOptions
- CompressionOptions
- RewriteOption
- SecureKeyOption
- IPAddressACLOption
- SSLCertificate
- SSLCertificateData
- SSLCertificateCMData
- Create
- CreateResourceRequest
- Origin
- Origin
- OriginMeta
- OriginNamedMeta
- OriginBalancerMeta
- SecondaryHostnames
- ResourceOptions
- BoolOption
- StringOption
- Int64Option
- StringsListOption
- StringsMapOption
- CachingTimes
- EdgeCacheSettings
- StringVariableMapOption
- OneofString
- QueryParamsOptions
- RedirectOptions
- HostOptions
- CompressionOptions
- RewriteOption
- SecureKeyOption
- IPAddressACLOption
- SSLTargetCertificate
- SSLCertificateData
- SSLCertificateCMData
- ResourceOriginParams
- Operation
- CreateResourceMetadata
- Resource
- SSLCertificate
- Update
- UpdateResourceRequest
- SecondaryHostnames
- ResourceOptions
- BoolOption
- StringOption
- Int64Option
- StringsListOption
- StringsMapOption
- CachingTimes
- EdgeCacheSettings
- StringVariableMapOption
- OneofString
- QueryParamsOptions
- RedirectOptions
- HostOptions
- CompressionOptions
- RewriteOption
- SecureKeyOption
- IPAddressACLOption
- SSLTargetCertificate
- SSLCertificateData
- SSLCertificateCMData
- Operation
- UpdateResourceMetadata
- Resource
- SSLCertificate
- Delete
- GetProviderCName
Provider's resources management service.
Call | Description |
---|---|
Get | Get client's CDN resource by resource id. |
List | Lists CDN resources. |
Create | Creates a CDN resource in the specified folder. |
Update | Updates the specified CDN resource. |
Delete | Deletes client's CDN resource. |
GetProviderCName | Get Provider's CNAME (edge endpoint) bind to specified folder id. |
Calls ResourceService
Get
Get client's CDN resource by resource id.
rpc Get (GetResourceRequest) returns (Resource)
GetResourceRequest
Field | Description |
---|---|
resource_id | string Required. ID of the requested resource. The maximum string length in characters is 50. |
Resource
Field | Description |
---|---|
id | string ID of the resource. |
folder_id | string Folder id. |
cname | string CDN endpoint CNAME, must be unique among resources. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
active | bool Flag to create Resource either in active or disabled state. True - the content from CDN is available to clients. False - the content from CDN isn't available to clients. |
options | ResourceOptions Resource settings and options to tune CDN edge behavior. |
secondary_hostnames[] | string List of secondary hostname strings. |
origin_group_id | int64 ID of the origin group. |
origin_group_name | string Name of the origin group. |
origin_protocol | enum OriginProtocol Specify the protocol schema to be used in communication with origin.
|
ssl_certificate | SSLCertificate SSL certificate options. |
labels | map<string,string> Labels of the resource. |
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. |
SSLCertificate
Field | Description |
---|---|
type | enum SSLCertificateType Type of the certificate.
|
status | enum SSLCertificateStatus Active status.
|
data | SSLCertificateData Certificate data. |
SSLCertificateData
Field | Description |
---|---|
ssl_certificate_data_variant | oneof: cm |
cm | SSLCertificateCMData Custom (add your SSL certificate by uploading the certificate in PEM format and your private key). |
SSLCertificateCMData
Field | Description |
---|---|
id | string ID of the custom certificate. |
List
Lists CDN resources.
rpc List (ListResourcesRequest) returns (ListResourcesResponse)
ListResourcesRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to request listing for. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListResourcesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListResourcesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
ListResourcesResponse
Field | Description |
---|---|
resources[] | Resource List of the resources |
next_page_token | stringnext_page_token token allows you to get the next page of results for list requests. If the number of results is larger than ListResourcesRequest.page_size, use the next_page_token as the value for the ListResourcesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Resource
Field | Description |
---|---|
id | string ID of the resource. |
folder_id | string Folder id. |
cname | string CDN endpoint CNAME, must be unique among resources. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
active | bool Flag to create Resource either in active or disabled state. True - the content from CDN is available to clients. False - the content from CDN isn't available to clients. |
options | ResourceOptions Resource settings and options to tune CDN edge behavior. |
secondary_hostnames[] | string List of secondary hostname strings. |
origin_group_id | int64 ID of the origin group. |
origin_group_name | string Name of the origin group. |
origin_protocol | enum OriginProtocol Specify the protocol schema to be used in communication with origin.
|
ssl_certificate | SSLCertificate SSL certificate options. |
labels | map<string,string> Labels of the resource. |
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. |
SSLCertificate
Field | Description |
---|---|
type | enum SSLCertificateType Type of the certificate.
|
status | enum SSLCertificateStatus Active status.
|
data | SSLCertificateData Certificate data. |
SSLCertificateData
Field | Description |
---|---|
ssl_certificate_data_variant | oneof: cm |
cm | SSLCertificateCMData Custom (add your SSL certificate by uploading the certificate in PEM format and your private key). |
SSLCertificateCMData
Field | Description |
---|---|
id | string ID of the custom certificate. |
Create
Creates a CDN resource in the specified folder.
Creation may take up to 15 minutes.
rpc Create (CreateResourceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateResourceMetadata
Operation.response:Resource
CreateResourceRequest
Field | Description |
---|---|
folder_id | string Required. ID of the to bind with new resource. The maximum string length in characters is 50. |
cname | string Required. CDN endpoint CNAME, must be unique among clients's resources. |
origin | Origin Required. Specify the origins to be used for CDN resources requests. |
secondary_hostnames | SecondaryHostnames List of additional CNAMEs. |
origin_protocol | enum OriginProtocol Specify the protocol schema to be used in communication with origin.
|
active | google.protobuf.BoolValue Flag to create Resource either in active or disabled state. In active state Origins payload could be transmitted from CDN CNAME requests. Default value: true |
options | ResourceOptions Resource settings and options to tune CDN edge behavior. Most is unset. |
ssl_certificate | SSLTargetCertificate SSL Certificate options. |
labels | map<string,string> Labels of the resource. |
Origin
Field | Description |
---|---|
origin_variant | oneof: origin_group_id , origin_source or origin_source_params |
origin_group_id | int64 ID of pre-created origin group. |
origin_source | string Create new Origins group with single source, it's id will be returned in result. |
origin_source_params | ResourceOriginParams Set up resource origin parameters. |
Origin
Field | Description |
---|---|
id | int64 ID of the origin. |
origin_group_id | int64 ID of the parent origin group. |
source | string IP address or Domain name of your origin and the port (if custom). Used if meta variant is common . |
enabled | bool The setting allows to enable or disable an Origin source in the Origins group. It has two possible values: True - The origin is enabled and used as a source for the CDN. An origins group must contain at least one enabled origin. False - The origin is disabled and the CDN is not using it to pull content. |
backup | bool Specifies whether the origin is used in its origin group as backup. A backup origin is used when one of active origins becomes unavailable. |
meta | OriginMeta Set up origin of the content. |
OriginMeta
Field | Description |
---|---|
origin_meta_variant | oneof: common , bucket , website or balancer Type of the origin. |
common | OriginNamedMeta A server with a domain name linked to it |
bucket | OriginNamedMeta An Object Storage bucket not configured as a static site hosting. |
website | OriginNamedMeta An Object Storage bucket configured as a static site hosting. |
balancer | OriginBalancerMeta An L7 load balancer from Application Load Balancer. CDN servers will access the load balancer at one of its IP addresses that must be selected in the origin settings. |
OriginNamedMeta
Field | Description |
---|---|
name | string Name of the origin. |
OriginBalancerMeta
Field | Description |
---|---|
id | string ID of the origin. |
SecondaryHostnames
Field | Description |
---|---|
values[] | string List of secondary hostname values. |
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. |
SSLTargetCertificate
Field | Description |
---|---|
type | enum SSLCertificateType Type of the certificate.
|
data | SSLCertificateData Certificate data. |
SSLCertificateData
Field | Description |
---|---|
ssl_certificate_data_variant | oneof: cm |
cm | SSLCertificateCMData Custom (add your SSL certificate by uploading the certificate in PEM format and your private key). |
SSLCertificateCMData
Field | Description |
---|---|
id | string ID of the custom certificate. |
ResourceOriginParams
Field | Description |
---|---|
source | string Source of the content. |
meta | OriginMeta Set up type of the origin. |
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. |
CreateResourceMetadata
Field | Description |
---|---|
resource_id | string Required. ID of created resource. The maximum string length in characters is 50. |
Resource
Field | Description |
---|---|
id | string ID of the resource. |
folder_id | string Folder id. |
cname | string CDN endpoint CNAME, must be unique among resources. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
active | bool Flag to create Resource either in active or disabled state. True - the content from CDN is available to clients. False - the content from CDN isn't available to clients. |
options | ResourceOptions Resource settings and options to tune CDN edge behavior. |
secondary_hostnames[] | string List of secondary hostname strings. |
origin_group_id | int64 ID of the origin group. |
origin_group_name | string Name of the origin group. |
origin_protocol | enum OriginProtocol Specify the protocol schema to be used in communication with origin.
|
ssl_certificate | SSLCertificate SSL certificate options. |
labels | map<string,string> Labels of the resource. |
SSLCertificate
Field | Description |
---|---|
type | enum SSLCertificateType Type of the certificate.
|
status | enum SSLCertificateStatus Active status.
|
data | SSLCertificateData Certificate data. |
Update
Updates the specified CDN resource.
The method implements patch behaviour, i.e. only the fields specified in the request are updated in the resource.
Changes may take up to 15 minutes to apply. Afterwards, it is recommended to purge the resource's cache via a CacheService.Purge request.
rpc Update (UpdateResourceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateResourceMetadata
Operation.response:Resource
UpdateResourceRequest
Field | Description |
---|---|
resource_id | string Required. ID of updated resource. The maximum string length in characters is 50. |
origin_group_id | google.protobuf.Int64Value ID of updated origin group. |
secondary_hostnames | SecondaryHostnames List of additional CNAMEs. |
options | ResourceOptions Resource settings and options to tune CDN edge behavior. |
origin_protocol | enum OriginProtocol Specify the protocol schema to be used in communication with origin.
|
active | google.protobuf.BoolValue Flag to create Resource either in active or disabled state. In active state Origins payload could be transmitted from CDN CNAME requests. Default value: true |
ssl_certificate | SSLTargetCertificate SSL Certificate options. |
labels | map<string,string> Resource labels. At some point will be needed for granular detailing. |
SecondaryHostnames
Field | Description |
---|---|
values[] | string List of secondary hostname values. |
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. |
SSLTargetCertificate
Field | Description |
---|---|
type | enum SSLCertificateType Type of the certificate.
|
data | SSLCertificateData Certificate data. |
SSLCertificateData
Field | Description |
---|---|
ssl_certificate_data_variant | oneof: cm |
cm | SSLCertificateCMData Custom (add your SSL certificate by uploading the certificate in PEM format and your private key). |
SSLCertificateCMData
Field | Description |
---|---|
id | string ID of the custom certificate. |
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. |
UpdateResourceMetadata
Field | Description |
---|---|
resource_id | string Required. ID of updated resource. The maximum string length in characters is 50. |
Resource
Field | Description |
---|---|
id | string ID of the resource. |
folder_id | string Folder id. |
cname | string CDN endpoint CNAME, must be unique among resources. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
active | bool Flag to create Resource either in active or disabled state. True - the content from CDN is available to clients. False - the content from CDN isn't available to clients. |
options | ResourceOptions Resource settings and options to tune CDN edge behavior. |
secondary_hostnames[] | string List of secondary hostname strings. |
origin_group_id | int64 ID of the origin group. |
origin_group_name | string Name of the origin group. |
origin_protocol | enum OriginProtocol Specify the protocol schema to be used in communication with origin.
|
ssl_certificate | SSLCertificate SSL certificate options. |
labels | map<string,string> Labels of the resource. |
SSLCertificate
Field | Description |
---|---|
type | enum SSLCertificateType Type of the certificate.
|
status | enum SSLCertificateStatus Active status.
|
data | SSLCertificateData Certificate data. |
Delete
Deletes client's CDN resource.
rpc Delete (DeleteResourceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteResourceMetadata
Operation.response:google.protobuf.Empty
DeleteResourceRequest
Field | Description |
---|---|
resource_id | string Required. ID of resource to delete. The maximum string length in characters is 50. |
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. |
DeleteResourceMetadata
Field | Description |
---|---|
resource_id | string ID of deleted resource. |
GetProviderCName
Get Provider's CNAME (edge endpoint) bind to specified folder id. Returns UNIMPLEMENTED error, if provider doesn't support CNAME request.
rpc GetProviderCName (GetProviderCNameRequest) returns (GetProviderCNameResponse)
GetProviderCNameRequest
Field | Description |
---|---|
folder_id | string Required. Folder ID to get provider's CNAME. The maximum string length in characters is 50. |
GetProviderCNameResponse
Field | Description |
---|---|
cname | string Provider's CNAME. |
folder_id | string ID of the folder that the provider belongs to. |