Cloud CDN API, REST: Origin.Create
Creates origin inside origin group.
HTTP request
POST https://cdn.api.cloud.yandex.net/cdn/v1/origins
Body parameters
{
"folderId": "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
}
}
Field |
Description |
folderId |
string Required field. ID of the folder that the origin belongs to. |
originGroupId |
string (int64)
|
source |
string Required field. 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. Default value: False. |
meta |
Set up origin of the content. |
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. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"originId": "string",
"originGroupId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"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 To work with values in this field, use the APIs described in the |
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 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateOriginMetadata
Field |
Description |
originId |
string (int64) ID of the origin. |
originGroupId |
string (int64) ID pf the parent origins 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. |
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. |
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. |