Связаться с намиПодключиться

Virtual Private Cloud API, REST: SecurityGroup.create

Статья создана
Обновлена 15 мая 2024 г.

Creates a security group in the specified folder and network.

HTTP request

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

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "networkId": "string",
  "ruleSpecs": [
    {
      "description": "string",
      "labels": "object",
      "direction": "string",
      "ports": {
        "fromPort": "string",
        "toPort": "string"
      },

      // `ruleSpecs[]` includes only one of the fields `cidrBlocks`, `securityGroupId`, `predefinedTarget`
      "protocolName": "string",
      "protocolNumber": "string",
      // end of the list of possible fields`ruleSpecs[]`

      "cidrBlocks": {
        "v4CidrBlocks": [
          "string"
        ],
        "v6CidrBlocks": [
          "string"
        ]
      },
      "securityGroupId": "string",
      "predefinedTarget": "string"
    }
  ]
}
Field Description
folderId string

Required. ID of the folder for this request to create a security group in. To get the folder ID, use a list request.

The maximum string length in characters is 50.
name string

Name of the security group. The name must be unique within the folder.

Value must match the regular expression |[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.
description string

Description of the security group.

The maximum string length in characters is 256.
labels object

Resource 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]*.
networkId string

Required. ID of the Network to create security group for.
ruleSpecs[] object

Security rules specifications.
ruleSpecs[].
description		 string

Description of the security rule.

The maximum string length in characters is 256.
ruleSpecs[].
labels		 object

Rule 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]*.
ruleSpecs[].
direction		 string
Required. The direction of network traffic allowed by this rule.
  • INGRESS: Allows ingress traffic.
  • EGRESS: Allows egress traffic.
ruleSpecs[].
ports		 object
The range of ports that allow traffic to pass through. Null value means any port.
ruleSpecs[].
ports.
fromPort		 string (int64)

The lowest port in the range.

Acceptable values are 0 to 65535, inclusive.
ruleSpecs[].
ports.
toPort		 string (int64)

The highest port in the range.

Acceptable values are 0 to 65535, inclusive.
ruleSpecs[].
protocolName		 string
ruleSpecs[] includes only one of the fields protocolName, protocolNumber

Protocol name.
ruleSpecs[].
protocolNumber		 string (int64)
ruleSpecs[] includes only one of the fields protocolName, protocolNumber

Protocol number from IANA protocol numbers.
ruleSpecs[].
cidrBlocks		 object
CIDR blocks to allow to recieve or send traffic.
ruleSpecs[] includes only one of the fields cidrBlocks, securityGroupId, predefinedTarget
ruleSpecs[].
cidrBlocks.
v4CidrBlocks[]		 string

IPv4 CIDR blocks to allow traffic to.
ruleSpecs[].
cidrBlocks.
v6CidrBlocks[]		 string

IPv6 CIDR blocks to allow traffic to.
ruleSpecs[].
securityGroupId		 string
ruleSpecs[] includes only one of the fields cidrBlocks, securityGroupId, predefinedTarget

ID of the security group to add rule to.
ruleSpecs[].
predefinedTarget		 string
ruleSpecs[] includes only one of the fields cidrBlocks, securityGroupId, predefinedTarget

Predefined target. See security groups rules for more information.

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. 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 (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
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.
Предыдущая
Overview
Следующая
delete