Contact UsGet started

Cloud CDN API, gRPC: OriginService.Update

Written by
Updated at November 26, 2024

Updates the specified origin from the origin group.

Changes may take up to 15 minutes to apply. Afterwards, it is recommended to purge cache of the resources that
use the origin via a CacheService.Purge request.

gRPC request

rpc Update (UpdateOriginRequest) returns (operation.Operation)

UpdateOriginRequest

{
  "folder_id": "string",
  "origin_id": "int64",
  "source": "string",
  "enabled": "bool",
  "backup": "bool",
  "meta": {
    // Includes only one of the fields `common`, `bucket`, `website`, `balancer`
    "common": {
      "name": "string"
    },
    "bucket": {
      "name": "string"
    },
    "website": {
      "name": "string"
    },
    "balancer": {
      "id": "string"
    }
    // end of the list of possible fields
  }
}

Field

Description

folder_id

string

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

origin_id

int64

ID of the origin.

source

string

IP address or Domain name of your origin and the port (if custom).
Used if meta variant is common.
Required.

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

Required.

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.

Required.

meta

OriginMeta

Set up type of the origin.

OriginMeta

Origin type. For details about the concept, see documentation.

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.

OriginNamedMeta

Origin info. For details about the concept, see documentation.

Field

Description

name

string

Name of the origin.

OriginBalancerMeta

Application Load Balancer origin info. For details about the concept, see documentation.

Field

Description

id

string

ID of the origin.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "origin_id": "int64",
    "origin_group_id": "int64"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "int64",
    "origin_group_id": "int64",
    "source": "string",
    "enabled": "bool",
    "backup": "bool",
    "meta": {
      // Includes only one of the fields `common`, `bucket`, `website`, `balancer`
      "common": {
        "name": "string"
      },
      "bucket": {
        "name": "string"
      },
      "website": {
        "name": "string"
      },
      "balancer": {
        "id": "string"
      }
      // end of the list of possible fields
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see 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

UpdateOriginMetadata

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

google.rpc.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

Origin

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.

UpdateOriginMetadata

Field

Description

origin_id

int64

ID of the origin.

origin_group_id

int64

Parent origins group ID.

Origin

An origin. For details about the concept, see documentation.

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

Origin type. For details about the concept, see documentation.

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.

OriginNamedMeta

Origin info. For details about the concept, see documentation.

Field

Description

name

string

Name of the origin.

OriginBalancerMeta

Application Load Balancer origin info. For details about the concept, see documentation.

Field

Description

id

string

ID of the origin.
Previous
Create
Next
Delete