Cloud CDN API, REST: OriginGroup.Get
Gets origin group with specified origin group id.
HTTP request
GET https://cdn.api.cloud.yandex.net/cdn/v1/originGroups/{originGroupId}
Path parameters
|
Field |
Description |
|
originGroupId |
string (int64) Required field. ID of the origin group to return. To get a origin group ID, make a OriginGroupService.List request. |
Query parameters
|
Field |
Description |
|
folderId |
string Required field. ID of the folder that the origin group belongs to. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"name": "string",
"useNext": "boolean",
"origins": [
{
"id": "string",
"originGroupId": "string",
"source": "string",
"enabled": "boolean",
"backup": "boolean",
"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
},
"providerType": "string"
}
],
"providerType": "string",
"resourcesMetadata": [
{
"id": "string",
"cname": "string"
}
]
}
Origin group parameters. For details about the concept, see documentation.
|
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 This option have two possible conditions: |
|
origins[] |
List of origins. |
|
providerType |
string Type of the CDN provider for this origin group. |
|
resourcesMetadata[] |
List of CDN resources currently using this origin group. |
Origin
An origin. For details about the concept, see documentation.
|
Field |
Description |
|
id |
string (int64) ID of the origin. |
|
originGroupId |
string (int64) ID of the parent origin group. |
|
source |
string 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 |
|
backup |
boolean Specifies whether the origin is used in its origin group as backup. |
|
meta |
Set up origin of the content. |
|
providerType |
string Type of the CDN provider for this origin group. |
OriginMeta
Origin type. For details about the concept, see documentation.
|
Field |
Description |
|
common |
A server with a domain name linked to it Includes only one of the fields Type of the origin. |
|
bucket |
An Object Storage bucket not configured as a static site hosting. Includes only one of the fields Type of the origin. |
|
website |
An Object Storage bucket configured as a static site hosting. Includes only one of the fields Type of the origin. |
|
balancer |
An L7 load balancer from Application Load Balancer. Includes only one of the fields 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. |
ResourceMetadata
Metadata of a CDN resource referencing an origin group.
|
Field |
Description |
|
id |
string ID of the CDN resource using the origin group. |
|
cname |
string CNAME of the CDN resource using the origin group. |