tencent cloud

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to create a security group policy (SecurityGroupPolicy).

For parameters of SecurityGroupPolicySet,

• `Version`: the version number of a security group policy, which automatically increases by one each time you update the security policy, to prevent expiration of the updated routing policies. If it is left empty, any conflicts will be ignored.
• When creating the `Egress` and `Ingress` policies,
  • `Protocol`: allows `TCP`, `UDP`, `ICMP`, `ICMPV6`, `GRE`, or `ALL`.
  • `CidrBlock`: a CIDR block in the correct format. In the classic network, if a `CidrBlock` contains private IPs of devices under your account other than CVMs, it does not mean this policy allows you to access these devices. The network isolation policies between tenants take priority over the private network policies in security groups.
  • `Ipv6CidrBlock`: an IPv6 CIDR block in the correct format. In a classic network, if an `Ipv6CidrBlock` contains private IPv6 addresses on Tencent Cloud for devices under your account other than CVMs, it does not mean this policy allows you to access these devices. The network isolation policies between tenants take priority over the private network policies in security groups.
  • `SecurityGroupId`: ID of the security group. It can be the ID of security group to be modified, or the ID of another security group in the same project. All private IPs of all CVMs under the security group will be covered. If this field is used, the policy will automatically change according to the CVM associated with the group ID while being used to match network messages. You don’t need to change it manually.
  • `Port`: a single port number such as 80, or a port range in the format of “8000-8010”. You may use this field only if the `Protocol` field takes the value `TCP` or `UDP`. Otherwise `Protocol` and `Port` are mutually exclusive.
  • `Action`: only allows `ACCEPT` or `DROP`.
  • `CidrBlock`, `Ipv6CidrBlock`, `SecurityGroupId`, and `AddressTemplate` are mutually exclusive. `Protocol` + `Port` and `ServiceTemplate` are mutually exclusive.
  • You can only create policies in one direction in each request. To specify the `PolicyIndex` parameter, use the same index number in policies.

A maximum of 100 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

3. Output Parameters

4. Example

Example1 Adding outbound policies to a security group

Input Example

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSecurityGroupPolicies
<Common request parameters>

{
    "SecurityGroupId": "sg-ohuuioma",
    "SecurityGroupPolicySet": {
        "Ingress": [
            {
                "PolicyIndex": 0,
                "Protocol": "All",
                "PolicyDescription": "Test",
                "AddressTemplate": {
                    "AddressGroupId": "ipmg-o8w64jdg",
                    "AddressId": "ipm-ngk4c2dw"
                },
                "Ipv6CidrBlock": "::/0",
                "SecurityGroupId": "sg-ohuuioma",
                "ModifyTime": "2020-12-03 16:12:15",
                "Action": "accept",
                "ServiceTemplate": {
                    "ServiceGroupId": "sg-ohuuioma",
                    "ServiceId": "ppm-f5n1f8da"
                },
                "CidrBlock": "0.0.0.0/0",
                "Port": "80"
            }
        ],
        "Egress": [
            {
                "PolicyIndex": 0,
                "Protocol": "All",
                "PolicyDescription": "Test",
                "AddressTemplate": {
                    "AddressGroupId": "ipmg-o8w64jdg",
                    "AddressId": "ipm-ngk4c2dw"
                },
                "Ipv6CidrBlock": "::/0",
                "SecurityGroupId": "sg-ohuuioma",
                "ModifyTime": "2020-12-03 16:12:15",
                "Action": "accept",
                "ServiceTemplate": {
                    "ServiceGroupId": "sg-ohuuioma",
                    "ServiceId": "ppm-f5n1f8da"
                },
                "CidrBlock": "0.0.0.0/0",
                "Port": "80"
            }
        ]
    }
}

Output Example

{
  "Response": {
    "RequestId": "53ee3ed3-c9ed-48ba-8a57-8624b9c0d3b8"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.