Cloud CDN API, REST: OriginGroup.list
Lists origins of origin group.
HTTP request
GET https://cdn.api.cloud.yandex.net/cdn/v1/originGroups
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder that the origin group belongs to.. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"originGroups": [
{
"id": "string",
"folderId": "string",
"name": "string",
"useNext": true,
"origins": [
{
"id": "string",
"originGroupId": "string",
"source": "string",
"enabled": true,
"backup": true,
"meta": {
// `originGroups[].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`originGroups[].origins[].meta`
}
}
]
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
originGroups[] | object List of all Origin Groups associated with folder. |
originGroups[]. id |
string (int64) ID of the origin group. Generated at creation time. |
originGroups[]. folderId |
string ID of the folder that the origin group belongs to. |
originGroups[]. name |
string Name of the origin group. |
originGroups[]. 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. |
originGroups[]. origins[] |
object List of origins. |
originGroups[]. origins[]. id |
string (int64) ID of the origin. |
originGroups[]. origins[]. originGroupId |
string (int64) ID of the parent origin group. |
originGroups[]. origins[]. source |
string IP address or Domain name of your origin and the port (if custom). Used if meta variant is |
originGroups[]. 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. |
originGroups[]. 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. |
originGroups[]. origins[]. meta |
object Set up origin of the content. Origin type. For details about the concept, see documentation. |
originGroups[]. origins[]. meta. common |
object A server with a domain name linked to it originGroups[].origins[].meta includes only one of the fields common , bucket , website , balancer |
originGroups[]. origins[]. meta. common. name |
string Name of the origin. |
originGroups[]. origins[]. meta. bucket |
object An Object Storage bucket not configured as a static site hosting. originGroups[].origins[].meta includes only one of the fields common , bucket , website , balancer |
originGroups[]. origins[]. meta. bucket. name |
string Name of the origin. |
originGroups[]. origins[]. meta. website |
object An Object Storage bucket configured as a static site hosting. originGroups[].origins[].meta includes only one of the fields common , bucket , website , balancer |
originGroups[]. origins[]. meta. website. name |
string Name of the origin. |
originGroups[]. 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. originGroups[].origins[].meta includes only one of the fields common , bucket , website , balancer |
originGroups[]. origins[]. meta. balancer. id |
string ID of the origin. |
nextPageToken | string nextPageToken token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |