Cloud CDN API, REST: OriginGroup methods
Origin Groups management service.
JSON Representation
{
"id": "string",
"folderId": "string",
"name": "string",
"useNext": true,
"origins": [
{
"id": "string",
"originGroupId": "string",
"source": "string",
"enabled": true,
"backup": true,
"meta": {
// `origins[].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`origins[].meta`
}
}
]
}
Field | Description |
---|---|
id | string (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 | boolean (boolean) 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[] | object List of origins. |
origins[]. id |
string (int64) ID of the origin. |
origins[]. originGroupId |
string (int64) ID of the parent origin group. |
origins[]. source |
string IP address or Domain name of your origin and the port (if custom). Used if meta variant is |
origins[]. enabled |
boolean (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 origin. False - The origin is disabled and the CDN is not using it to pull content. |
origins[]. backup |
boolean (boolean) Specifies whether the origin is used in its origin group as backup. A backup origin is used when one of active origins becomes unavailable. |
origins[]. meta |
object Set up origin of the content. Origin type. For details about the concept, see documentation. |
origins[]. meta. common |
object A server with a domain name linked to it origins[].meta includes only one of the fields common , bucket , website , balancer |
origins[]. meta. common. name |
string Name of the origin. |
origins[]. meta. bucket |
object An Object Storage bucket not configured as a static site hosting. origins[].meta includes only one of the fields common , bucket , website , balancer |
origins[]. meta. bucket. name |
string Name of the origin. |
origins[]. meta. website |
object An Object Storage bucket configured as a static site hosting. origins[].meta includes only one of the fields common , bucket , website , balancer |
origins[]. meta. website. name |
string Name of the origin. |
origins[]. meta. balancer |
object 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. origins[].meta includes only one of the fields common , bucket , website , balancer |
origins[]. meta. balancer. id |
string ID of the origin. |
Methods
Method | Description |
---|---|
create | Creates origin group. |
delete | Deletes origin group with specified origin group id. |
get | Gets origin group with specified origin group id. |
list | Lists origins of origin group. |
update | Updates the specified origin group. |