Cloud CDN API, REST: OriginGroup.List

Статья создана

Обновлена 26 ноября 2024 г.

HTTP request
Query parameters
Response
OriginGroup
Origin
OriginMeta
OriginNamedMeta
OriginBalancerMeta

Lists origins of origin group.

HTTP request

GET https://cdn.api.cloud.yandex.net/cdn/v1/originGroups

Query parameters

Field	Description
folderId	string Required field. ID of the folder that the origin group belongs to..
pageSize	string (int64) The maximum number of results per page to return. If the number of available results is larger than `pageSize`, the service returns a ListOriginGroupsResponse.nextPageToken that can be used to get the next page of results in subsequent list requests.
pageToken	string Page token. To get the next page of results, set `pageToken` to the ListOriginGroupsResponse.nextPageToken returned by a previous list request.

Response

HTTP Code: 200 - OK

{
  "originGroups": [
    {
      "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
          }
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Field

Description

originGroups[]

OriginGroup

List of all Origin Groups associated with folder.

nextPageToken

string

nextPageToken token allows you to get the next page of results for list requests.
If the number of results is larger than ListOriginGroupsRequest.pageSize, use
the nextPageToken as the value for the ListOriginGroupsRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

OriginGroup

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: 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	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). Used if `meta` variant is `common`.
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 group must contain at least one enabled origin. False - The origin is disabled and the CDN is not using it to pull content.
backup	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.
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, REST: OriginGroup.List

HTTP request

Query parameters

Response

OriginGroup

Origin

OriginMeta

OriginNamedMeta

OriginBalancerMeta

Была ли статья полезна?