Cloud CDN API, gRPC: OriginGroupService.Create

Written by

Yandex Cloud

Updated at October 17, 2024

gRPC request
CreateOriginGroupRequest
OriginParams
OriginMeta
OriginNamedMeta
OriginBalancerMeta
operation.Operation
CreateOriginGroupMetadata
OriginGroup
Origin
OriginMeta
OriginNamedMeta
OriginBalancerMeta

Creates origin group.

gRPC request

rpc Create (CreateOriginGroupRequest) returns (operation.Operation)

CreateOriginGroupRequest

{
  "folderId": "string",
  "name": "string",
  "useNext": "google.protobuf.BoolValue",
  "origins": [
    {
      "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
folderId	string Required field. ID of the folder that the origin group belongs to.
name	string Name of the origin group.
useNext	google.protobuf.BoolValue This option have two possible conditions: 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. default value is true
origins[]	OriginParams List of origins: IP addresses or Domain names of your origins and the port (if custom).

OriginParams

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

Field	Description
source	string Source: IP address or Domain name of your origin and the port (if custom).
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 origins. False - The origin is disabled and the CDN is not using it to pull content.
backup	bool 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.

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

string

ID of the origin.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "originGroupId": "int64"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "int64",
    "folderId": "string",
    "name": "string",
    "useNext": "bool",
    "origins": [
      {
        "id": "int64",
        "originGroupId": "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.
createdAt	google.protobuf.Timestamp Creation timestamp.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	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	CreateOriginGroupMetadata 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	OriginGroup 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.

CreateOriginGroupMetadata

Field

Description

originGroupId

int64

ID of created origin group.

OriginGroup

Origin group parameters. For details about the concept, see documentation.

Field	Description
id	int64 ID of the origin group. Generated at creation time.
folderId	string ID of the folder that the origin group belongs to.
name	string Name of the origin group.
useNext	bool This option have two possible conditions: 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[]	Origin List of origins.

Origin

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

Field	Description
id	int64 ID of the origin.
originGroupId	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

string

ID of the origin.

Cloud CDN API, gRPC: OriginGroupService.Create

gRPC requestgRPC request

CreateOriginGroupRequestCreateOriginGroupRequest

OriginParamsOriginParams

OriginMetaOriginMeta

OriginNamedMetaOriginNamedMeta

OriginBalancerMetaOriginBalancerMeta

operation.Operationoperation.Operation

CreateOriginGroupMetadataCreateOriginGroupMetadata

OriginGroupOriginGroup

OriginOrigin

OriginMetaOriginMeta

OriginNamedMetaOriginNamedMeta

OriginBalancerMetaOriginBalancerMeta

Was the article helpful?

gRPC request

CreateOriginGroupRequest

OriginParams

OriginMeta

OriginNamedMeta

OriginBalancerMeta

operation.Operation

CreateOriginGroupMetadata

OriginGroup

Origin

OriginMeta

OriginNamedMeta

OriginBalancerMeta