Cloud CDN API, gRPC: OriginGroupService
Origin Groups management service.
Call | Description |
---|---|
Get | Gets origin group with specified origin group id. |
List | Lists origins of origin group. |
Create | Creates origin group. |
Update | Updates the specified origin group. |
Delete | Deletes origin group with specified origin group id. |
Calls OriginGroupService
Get
Gets origin group with specified origin group id.
rpc Get (GetOriginGroupRequest) returns (OriginGroup)
GetOriginGroupRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder that the origin group belongs to. The maximum string length in characters is 50. |
origin_group_id | int64 ID of the origin group to return. To get a origin group ID, make a OriginGroupService.List request. Value must be greater than 0. |
OriginGroup
Field | Description |
---|---|
id | int64 ID of the origin group. Generated at creation time. |
folder_id | string ID of the folder that the origin group belongs to. |
name | string Name of the origin group. |
use_next | 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
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. |
List
Lists origins of origin group.
rpc List (ListOriginGroupsRequest) returns (ListOriginGroupsResponse)
ListOriginGroupsRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder that the origin group belongs to.. 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 ListOriginGroupsResponse.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 ListOriginGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
ListOriginGroupsResponse
Field | Description |
---|---|
origin_groups[] | OriginGroup List of all Origin Groups associated with folder. |
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 ListOriginGroupsRequest.page_size, use the next_page_token as the value for the ListOriginGroupsRequest.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. |
OriginGroup
Field | Description |
---|---|
id | int64 ID of the origin group. Generated at creation time. |
folder_id | string ID of the folder that the origin group belongs to. |
name | string Name of the origin group. |
use_next | 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
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. |
Create
Creates origin group.
rpc Create (CreateOriginGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateOriginGroupMetadata
Operation.response:OriginGroup
CreateOriginGroupRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder that the origin group belongs to. The maximum string length in characters is 50. |
name | string Name of the origin group. |
use_next | 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
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
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. |
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. |
CreateOriginGroupMetadata
Field | Description |
---|---|
origin_group_id | int64 ID of created origin group. Value must be greater than 0. |
OriginGroup
Field | Description |
---|---|
id | int64 ID of the origin group. Generated at creation time. |
folder_id | string ID of the folder that the origin group belongs to. |
name | string Name of the origin group. |
use_next | 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
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. |
Update
Updates the specified 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 group via a CacheService.Purge request.
rpc Update (UpdateOriginGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateOriginGroupMetadata
Operation.response:OriginGroup
UpdateOriginGroupRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder that the origin group belongs to. The maximum string length in characters is 50. |
origin_group_id | int64 ID of the origin group. Value must be greater than 0. |
group_name | google.protobuf.StringValue Name of the origin group. |
use_next | google.protobuf.BoolValue 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). |
OriginParams
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
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. |
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. |
UpdateOriginGroupMetadata
Field | Description |
---|---|
origin_group_id | int64 ID of the origin group. Value must be greater than 0. |
OriginGroup
Field | Description |
---|---|
id | int64 ID of the origin group. Generated at creation time. |
folder_id | string ID of the folder that the origin group belongs to. |
name | string Name of the origin group. |
use_next | 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
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. |
Delete
Deletes origin group with specified origin group id.
rpc Delete (DeleteOriginGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteOriginGroupMetadata
Operation.response:google.protobuf.Empty
DeleteOriginGroupRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder that the origin group belongs to. The maximum string length in characters is 50. |
origin_group_id | int64 ID of the origin group. 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. |
DeleteOriginGroupMetadata
Field | Description |
---|---|
origin_group_id | int64 ID of the origin group. Value must be greater than 0. |