tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateSecurityGroupPolicies

Last updated: 2023-07-11 17:48:33

1. API Description

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

This API is used to create security group policies (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` polices,
    • `Protocol`: Allows `TCP`, `UDP`, `ICMP`, `ICMPV6`, `GRE` and `ALL`.
    • `CidrBlock`: For the classic network, the `CidrBlock` can contain private IPs of Tencent Cloud resources that are not under your account. It does not mean that you can access these devices. The network isolation policies between tenants take priority over the private network policies in security groups.
    • `Ipv6CidrBlock`: For the classic network, `Ipv6CidrBlock` can contain private IPv6 addresses of Tencent Cloud resources that are not under your account. It does not mean that you can 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 to create policies.
    • `Port`: A single port (“80”) or a port range ("8000-8010"). This parameter is only available when `Protocol` is `TCP` or `UDP`.
    • `Action`: `ACCEPT` or `DROP`.
    • CidrBlock, Ipv6CidrBlock, SecurityGroupId, and AddressTemplate are mutually exclusive. Protocol + Port and ServiceTemplate are mutually exclusive. IPv6CidrBlock and ICMP are mutually exclusive; to use them, enter ICMPV6.
    • You can only create policies in one direction in each request. To specify the `PolicyIndex` parameter, use the same index number in policies. If you want to insert a rule before the first rule, enter 0; if you want to add a rule after the last rule, leave it empty.

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: CreateSecurityGroupPolicies.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
SecurityGroupId Yes String The security group instance ID, such as sg-33ocnj9n. This can be obtained through DescribeSecurityGroups.
SecurityGroupPolicySet Yes SecurityGroupPolicySet Security group policy set.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adds inbound policies to a security group

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateSecurityGroupPolicies
&Version=2017-03-12
&SecurityGroupId=sg-ohuuioma
&SecurityGroupPolicySet.Version=21
&SecurityGroupPolicySet.Ingress.0.PolicyIndex=1
&SecurityGroupPolicySet.Ingress.0.ServiceTemplate.ServiceId=ppm-f5n1f8da
&SecurityGroupPolicySet.Ingress.0.AddressTemplate.AddressId=ipm-2uw6ujo6
&SecurityGroupPolicySet.Ingress.0.Action=accept
&SecurityGroupPolicySet.Ingress.0.PolicyDescription=TestPolicy
&SecurityGroupPolicySet.Ingress.1.PolicyIndex=1
&SecurityGroupPolicySet.Ingress.1.ServiceTemplate.ServiceId=ppm-f5n1f8da
&SecurityGroupPolicySet.Ingress.1.AddressTemplate.AddressId=ipm-2uw6ujo6
&SecurityGroupPolicySet.Ingress.1.Action=accept
&SecurityGroupPolicySet.Ingress.1.PolicyDescription=Test
&<Common request parameter>

Output Example

{
    "Response": {}
}

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 A parameter error occurred.
InvalidParameter.Coexist The parameters cannot be specified at the same time.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Empty Missing parameters.
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.
LimitExceeded.SecurityGroupPolicySet The number of security group rules exceeds the upper limit.
ResourceNotFound The resource does not exist.
UnknownParameter.WithGuess Unknown parameter. Try similar parameters.
UnsupportedOperation.ClbPolicyExceedLimit Reached the upper limit of security group policies of the load balancer.
UnsupportedOperation.ClbPolicyLimit Public network CLB does not support this policy.
UnsupportedOperation.DuplicatePolicy The security group policies are repeated.
UnsupportedOperation.LockedResources
UnsupportedOperation.VersionMismatch The specified version number of the security group policy is inconsistent with the latest version.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy