Cloud CDN API, REST: OriginGroup.Update

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

Обновлена 17 октября 2024 г.

HTTP request
Body parameters
OriginParams
OriginMeta
OriginNamedMeta
OriginBalancerMeta
Response
UpdateOriginGroupMetadata
Status
OriginGroup
Origin
OriginMeta
OriginNamedMeta
OriginBalancerMeta

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.

HTTP request

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

Body parameters

{
  "folderId": "string",
  "originGroupId": "string",
  "groupName": "string",
  "useNext": "boolean",
  "origins": [
    {
      "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
      }
    }
  ]
}

Field	Description
folderId	string Required field. ID of the folder that the origin group belongs to.
originGroupId	string (int64) ID of the origin group.
groupName	string Name of the origin group.
useNext	boolean 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

Origin parameters. For details about the concept, see documentation.

Field	Description
source	string Source: 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 group must contain at least one enabled origins. False - The origin is disabled and the CDN is not using it to pull content.
backup	boolean 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

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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "originGroupId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "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
        }
      }
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean 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	UpdateOriginGroupMetadata 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.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `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.
response	OriginGroup The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `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.

UpdateOriginGroupMetadata

Field

Description

originGroupId

string (int64)

ID of the origin group.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

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.Update

HTTP requestHTTP request

Body parametersBody parameters

OriginParamsOriginParams

OriginMetaOriginMeta

OriginNamedMetaOriginNamedMeta

OriginBalancerMetaOriginBalancerMeta

ResponseResponse

UpdateOriginGroupMetadataUpdateOriginGroupMetadata

StatusStatus

OriginGroupOriginGroup

OriginOrigin

OriginMetaOriginMeta

OriginNamedMetaOriginNamedMeta

OriginBalancerMetaOriginBalancerMeta

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

HTTP request

Body parameters

OriginParams

OriginMeta

OriginNamedMeta

OriginBalancerMeta

Response

UpdateOriginGroupMetadata

Status

OriginGroup

Origin

OriginMeta

OriginNamedMeta

OriginBalancerMeta