tencent cloud

Feedback

ReplaceSecurityGroupPolicy

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

1. API Description

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

This API (ReplaceSecurityGroupPolicy) is used to replace a single security group policy (SecurityGroupPolicy).
Only one policy in a single direction can be replaced in each request, and the PolicyIndex parameter must be specified.

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: ReplaceSecurityGroupPolicy.
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 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 Replacing a single routing policy of a security group

Input Example

https://vpc.tencentcloudapi.com/?Action=ReplaceSecurityGroupPolicy
&SecurityGroupId=sg-ohuuioma
&SecurityGroupPolicySet.Version=20
&SecurityGroupPolicySet.Egress.0.PolicyIndex=2
&SecurityGroupPolicySet.Egress.0.ServiceTemplate.ServiceId=ppm-f5n1f8da
&SecurityGroupPolicySet.Egress.0.ServiceTemplate.ServiceGroupId=ppmg-f5n1f8da
&SecurityGroupPolicySet.Egress.0.AddressTemplate.AddressId=ipm-2uw6ujo6
&SecurityGroupPolicySet.Egress.0.AddressTemplate.AddressGroupId=ipmg-2uw6ujo6
&SecurityGroupPolicySet.Ingress.0.Action=accept
&SecurityGroupPolicySet.Ingress.0.PolicyDescription=TestPolicy
&SecurityGroupPolicySet.Ingress.0.PolicyIndex=2
&SecurityGroupPolicySet.Ingress.0.ServiceTemplate.ServiceId=ppm-f5n1f8da
&SecurityGroupPolicySet.Ingress.0.ServiceTemplate.ServiceGroupId=ppmg-f5n1f8da
&SecurityGroupPolicySet.Ingress.0.AddressTemplate.AddressId=ipm-2uw6ujo6
&SecurityGroupPolicySet.Ingress.0.AddressTemplate.AddressGroupId=ipmg-2uw6ujo6
&<Common request parameters>

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

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.
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.