Method create

Written by

HTTP request
Body parameters
Response

Creates an address in the specified folder and network.

HTTP request

POST https://vpc.api.cloud.yandex.net/vpc/v1/addresses

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "externalIpv4AddressSpec": {
    "address": "string",
    "zoneId": "string",
    "requirements": {
      "ddosProtectionProvider": "string",
      "outgoingSmtpCapability": "string"
    }
  }
}

Field	Description
folderId	string Required. ID of the folder to create a address in. To get a folder ID make a list request. The maximum string length in characters is 50.
name	string Name of the address. The name must be unique within the folder. Value must match the regular expression `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
description	string Description of the address. The maximum string length in characters is 256.
labels	object Address labels as `key:value` pairs. No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_0-9a-z]`. The maximum string length in characters for each value is 63. Each value must match the regular expression `[-_0-9a-z]`.
externalIpv4AddressSpec	object
externalIpv4AddressSpec. address	string Value of address.
externalIpv4AddressSpec. zoneId	string Availability zone from which the address will be allocated.
externalIpv4AddressSpec. requirements	object Parameters of the allocated address, for example DDoS Protection.
externalIpv4AddressSpec. requirements. ddosProtectionProvider	string DDoS protection provider ID.
externalIpv4AddressSpec. requirements. outgoingSmtpCapability	string Capability to send SMTP traffic.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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.
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.
done	boolean (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	object 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	object The error result of the operation in case of failure or cancellation. includes only one of the fields `error`, `response` The error result of the operation in case of failure or cancellation.
error. code	integer (int32) Error code. An enum value of google.rpc.Code.
error. message	string An error message.
error. details[]	object A list of messages that carry the error details.
response	object includes only one of the fields `error`, `response` 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.