tencent cloud

文档反馈

CreateSecurityGroup

最后更新时间:2022-08-24 17:36:06

1. API Description

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

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

  • Note the maximum number of security groups per project in each region under each account.
  • Both the inbound and outbound rules for a newly created security group are "Deny All" by default. You need to call CreateSecurityGroupPolicies to set security group rules based on your needs.
  • You can bind a tag when creating a security group. The tag list in the response indicates the tags that have been successfully added.

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: CreateSecurityGroup.
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. The default is 0. You can query it on the project management page of the Qcloud console.
Tags.N No Array of Tag Bound tags, such as [{"Key": "city", "Value": "shanghai"}].

3. Output Parameters

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

4. Example

Example1 Creating a security group

Input Example

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

{
    "GroupName": "TestGroup",
    "GroupDescription": "test-group-desc",
    "Tags": [
        {
            "Value": "shanghai",
            "Key": "city"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "SecurityGroup": {
            "SecurityGroupId": "sg-3g7ftkp3",
            "SecurityGroupName": "TestGroup",
            "SecurityGroupDesc": "test-group-desc",
            "ProjectId": "0",
            "TagSet": [
                {
                    "Key": "city",
                    "Value": "shanghai"
                }
            ]
        }
    }
}

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
InvalidParameter A parameter error occurred.
InvalidParameterValue.Duplicate The input parameter already exists.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.TagDuplicateKey Duplicate tag keys.
InvalidParameterValue.TagDuplicateResourceType Duplicate tag resource type.
InvalidParameterValue.TagInvalidKey Invalid tag key.
InvalidParameterValue.TagInvalidKeyLen Invalid tag key length.
InvalidParameterValue.TagInvalidVal Invalid tag key.
InvalidParameterValue.TagKeyNotExists The tag key does not exist.
InvalidParameterValue.TagNotAllocatedQuota Tags are not assigned quotas.
InvalidParameterValue.TagNotExisted The tag and value do not exist.
InvalidParameterValue.TagNotSupportTag Unsupported tag.
InvalidParameterValue.TagResourceFormatError 'The tag resource format error.
InvalidParameterValue.TagTimestampExceeded Exceeded the quota of tag timestamp.
InvalidParameterValue.TagValNotExists The tag value does not exist.
InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
LimitExceeded Quota limit is reached.
LimitExceeded.TagKeyExceeded Reached the upper limit of tag keys.
LimitExceeded.TagKeyPerResourceExceeded Reached the upper limit of tags keys per resource.
LimitExceeded.TagNotEnoughQuota Insufficient tag quota.
LimitExceeded.TagQuota Exceeded the tag quota. Unable to create resources.
LimitExceeded.TagQuotaExceeded Reached the upper limit of tag quota.
LimitExceeded.TagTagsExceeded Reached the number limit of tag keys.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
UnsupportedOperation.TagAllocate Tags are being assigned.
UnsupportedOperation.TagFree Tags are being released.
UnsupportedOperation.TagNotPermit Unauthorized for this tag.
UnsupportedOperation.TagSystemReservedTagKey The specified tag key is reserved for system usage.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持