ReplaceSecurityGroupPolicies

Last updated: 2023-08-23 14:11:16

1. API Description

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

This API is used to batch modify security group policies.
Policies to modify must be in the same direction. PolicyIndex must be specified.

A maximum of 20 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: ReplaceSecurityGroupPolicies.
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 the `DescribeSecurityGroups` API.
SecurityGroupPolicySet	Yes	SecurityGroupPolicySet	Security group policy set object.
OriginalSecurityGroupPolicySet	No	SecurityGroupPolicySet	(Optional) The old policy set of the security group, which is used for log records.

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 Batch modifying security group policies

This example shows you how to batch modify security group policies.

Input Example

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

{
    "SecurityGroupId": "sg-12345678",
    "SecurityGroupPolicySet": {
        "Ingress": [
            {
                "PolicyIndex": "3",
                "Protocol": "tcp",
                "PolicyDescription": "TestPolicy",
                "Action": "ACCEPT",
                "CidrBlock": "20.0.0.0/16",
                "Port": "22"
            },
            {
                "PolicyIndex": "4",
                "Protocol": "tcp",
                "PolicyDescription": "TestPolicy2",
                "Action": "DROP",
                "CidrBlock": "30.0.0.0/16",
                "Port": "22"
            }
        ],
        "Version": "20"
    }
}

Output Example

{
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"
    }
}

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

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.

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.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.
ResourceNotFound	The resource does not exist.
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.

tencent cloud

Recent Pages