Cloud CDN API, REST: OriginGroup.Update

Field

Description

folderId

string

Required field. ID of the folder that the origin group belongs to.

The maximum string length in characters is 50.

originGroupId

string (int64)

ID of the origin group.

Value must be greater than 0.

groupName

string

Name of the origin group.

useNext

boolean

This option have two possible values:
True - The option is active. In case the origin responds with 4XX or 5XX
codes, use the next origin from the list.
False - The option is disabled.

origins[]

OriginParams

List of origins: IP addresses or Domain names of your origins and the port
(if custom).

Field

Description

source

string

Source: IP address or Domain name of your origin and the port (if custom).

enabled

boolean

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 origins. False - The origin is disabled
and the CDN is not using it to pull content.

backup

boolean

backup option has two possible values:
True - The option is active. The origin will not be used until one of
active origins become unavailable.
False - The option is disabled.

meta

OriginMeta

Set up origin of the content.

Field

Description

common

OriginNamedMeta

A server with a domain name linked to it

Includes only one of the fields common, bucket, website, balancer.

Type of the origin.

bucket

OriginNamedMeta

An Object Storage bucket not configured as a static site hosting.

Includes only one of the fields common, bucket, website, balancer.

Type of the origin.

website

OriginNamedMeta

An Object Storage bucket configured as a static site hosting.

Includes only one of the fields common, bucket, website, balancer.

Type of the origin.

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.

Includes only one of the fields common, bucket, website, balancer.

Type of the origin.

Field

Description

name

string

Name of the origin.

Field

Description

id

string

ID of the origin.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

object

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.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, 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.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.