tencent cloud

All product documents
APIs
DocumentationAPIsVirtual Private CloudSecurity Group APIsCreateSecurityGroupWithPolicies
CreateSecurityGroupWithPolicies
Last updated: 2024-11-25 20:07:53
CreateSecurityGroupWithPolicies
Last updated: 2024-11-25 20:07:53

1. API Description

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

This API is used to create a security group, and add security group policies.

  • For the the upper limit of security groups per project in each region under each account, see here
  • For newly created security groups, the inbound and outbound policies are set to Deny All by default. You need to call CreateSecurityGroupPolicies
    to change it.

Description:

  • Version: The version number of a security group policy. It automatically increments by 1 every time you update the security policy, so to prevent the expiration of the updated policies. If this field is left empty, any conflicts will be ignored.
  • Protocol: Values can be TCP, UDP, ICMP, ICMPV6, GRE, and ALL.
  • CidrBlock: Enter a CIDR block in the correct format. In the classic network, even if the CIDR block specified in CidrBlock contains the Tencent Cloud private IPs not used for CVMs under your Tencent Cloud account, it does not mean this policy allows you to access those resources. The network isolation policies between tenants take priority over the private network policies in security groups.
  • Ipv6CidrBlock: Enter an IPv6 CIDR block in the correct format. In the classic network, even if the CIDR block specified in Ipv6CidrBlock contains the Tencent Cloud private IPv6 addresses not used for CVMs under your Tencent Cloud account, it does not mean this policy allows you to access those resources. 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 a 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: Enter a single port number (such as 80), or a port range (such as 8000-8010). Port is only applicable when Protocol is TCP or UDP. If Protocol is not TCP or UDP, Protocol and Port cannot be both specified.
  • Action: Values can be ACCEPT or DROP.
  • CidrBlock, Ipv6CidrBlock, SecurityGroupId, and AddressTemplate are exclusive to one another. "Protocol + Port" and ServiceTemplate are mutually exclusive.
  • Only policies in one direction can be created in each request. If you need to specify the PolicyIndex parameter, the indexes of policies must be consistent.

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateSecurityGroupWithPolicies.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
GroupName Yes String Security group can be named freely, but cannot exceed 60 characters.
GroupDescription Yes String The remarks for the security group. The maximum length is 100 characters.
ProjectId No String Project ID. Default value: 0. You can query it on the project management page of the Tencent Cloud console.
SecurityGroupPolicySet No SecurityGroupPolicySet Security group policy set.

3. Output Parameters

Parameter Name Type Description
SecurityGroup SecurityGroup Security group object.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a security group

Input Example

https://vpc.intl.tencentcloudapi.com/?Action=CreateSecurityGroupWithPolicies
&Version=2017-03-12
&GroupName=TestGroup
&GroupDescription=test-group-desc
&<Common request parameters>

Output Example

{
    "Response": {
        "SecurityGroup": {
            "SecurityGroupId": "sg-12345678",
            "SecurityGroupName": "TestGroup",
            "SecurityGroupDesc": "test-group-desc",
            "ProjectId": "0"
        }
    }
}

Example2 Creating security groups and the rules

Input Example

https://vpc.intl.tencentcloudapi.com/?Action=CreateSecurityGroupWithPolicies
&Version=2017-03-12
&GroupName=TestGroup
&GroupDescription=test-group-desc
&SecurityGroupPolicySet.Egress.0.PolicyIndex=0
&SecurityGroupPolicySet.Egress.0.ServiceTemplate.ServiceId=ppm-f5n1f8da
&SecurityGroupPolicySet.Egress.0.AddressTemplate.AddressId=ipm-2uw6ujo6
&SecurityGroupPolicySet.Egress.0.Action=accept
&SecurityGroupPolicySet.Egress.0.PolicyDescription=TestPolicy
&SecurityGroupPolicySet.Egress.1.PolicyIndex=1
&SecurityGroupPolicySet.Egress.1.ServiceTemplate.ServiceId=ppm-f5n1f8da
&SecurityGroupPolicySet.Egress.1.AddressTemplate.AddressId=ipm-2uw6ujo6
&SecurityGroupPolicySet.Egress.1.Action=accept
&SecurityGroupPolicySet.Egress.1.PolicyDescription=Test
&<Common request parameters>

Output Example

{
    "Response": {
        "SecurityGroup": {
            "SecurityGroupId": "sg-12345678",
            "SecurityGroupName": "TestGroup",
            "SecurityGroupDesc": "test-group-desc",
            "ProjectId": "0"
        }
    }
}

5. Developer Resources

SDK

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

Command Line Interface

6. Error Code

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

Error Code Description
InternalError.ModuleError Internal module error
InvalidParameter.Coexist The parameters cannot be specified at the same time.
InvalidParameterValue The parameter value is invalid.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.MemberApprovalApplicationIdMismatch
InvalidParameterValue.MemberApprovalApplicationNotApproved
InvalidParameterValue.MemberApprovalApplicationRejected
InvalidParameterValue.MemberApprovalApplicationStarted
InvalidParameterValue.Range The parameter value is not in the specified range.
InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
LimitExceeded Quota limit is reached.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
UnknownParameter.WithGuess Unknown parameter. Try similar parameters.
UnsupportedOperation.LockedResources
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon