RevokeSecurityGroup

Last Updated: Mar 30, 2018

Description

Deletes an inbound rule from a security group. This action withdraws the access policy of the inbound traffic from the instances that are in a specified security group to other devices. We define the beginning of the traffic as the source, and the terminal of the traffic as the destination. For more information, see AuthorizeSecurityGroup.

Use the following two sets of parameters to delete a security group rule. If one rule does not exist according to these two sets of parameters, the RevokeSecurityGroup fails.

  • To withdraw the access policy of an IP address range, for example, Request example 1: IpProtocol, PortRange, (Optional) SourcePortRange, NicType, Policy, DestCiderIp, (Optional)SourceCidrIp.

  • To withdraw the access policy of instances that are in another security group, for example, Request example 2: IpProtocol, PortRange, (Optional)SourcePortRange, NicType, Policy, (Optional) DestCiderIp, DestGroupOwnerAccount, and DestGroupId.

Request parameters

Name Type Required Description
Action String Yes The name of this interface. Value: RevokeSecurityGroup.
RegionId String Yes The ID of the region to which the source security group belongs. For more information, see Regions and zones, or call DescribeRegions to obtain the latest region list.
SecurityGroupId String Yes The destination security group ID.
IpProtocol String Yes The transport layer protocol. Optional values:
  • icmp
  • gre
  • tcp
  • udp
  • all
These values are case-insensitive.
PortRange String Yes The range of destination port relevant to the transport layer protocol. Optional values:
  • For TCP/UDP protocol, [1, 65535]. You can use a forward slash (/) to separate the port range, expected sample: 1/200, incorrect sample: 200/1.
  • For ICMP protocol, -1/-1.
  • For GRE protocol, -1/-1.
  • For all the protocols, -1/-1.
SourcePortRange String Yes The range of source port relevant to the transport layer protocol. Optional values:
  • For TCP/UDP protocol, [1, 65535]. You can use a forward slash (/) to separate the port range, expected sample: 1/200, incorrect sample: 200/1.
  • For ICMP protocol, -1/-1.
  • For GRE protocol, -1/-1.
  • For all the protocols, -1/-1.
NicType String No The network type. Optional values:
  • internet
  • intranet
In mutual security group authorization, DestGroupId is specified, while DestCidrIp is not specified, you must specify the NicType as intranet.
Default value: internet.
Policy String No The access permission. Optional values:
  • accept: Allows the access.
  • drop: Declines the access, and sends no response to the source device.
Default value: accept.
SourceCidrIp String No The source IP address range. Only CIDR and IPv4 format are supported.
Default value: 0.0.0.0/0.
DestCidrIp String No The destination IP address range. Only CIDR and IPv4 format are supported.
Default value: 0.0.0.0/0.
SourceGroupId String No The source security group ID. Either the SourceGroupId or DestCidrIp parameter must be set. If both are set, SourceCidrIp is authorized by default. If SourceGroupId is specified and SourceCidrIp is not specified, NicType must be set to intranet.
SourceGroupOwnerId String No The Alibaba Cloud account of the source security group. If the SourceGroupOwnerAccount and SourceGroupOwnerId are not set, access policy withdrawal is performed for security groups of the same account. If SourceCidrIp is already set, the SourceGroupOwnerAccount is invalid.
SourceGroupOwnerId String No The Alibaba Cloud account ID of the source security group. If the SourceGroupOwnerAccount and SourceGroupOwnerId are not set, access policy withdrawal is performed for security groups of the same account. If SourceCidrIp is already set, the SourceGroupOwnerId is invalid.
Priority String No The priority of the inbound rule. Value range: [1, 100].
Default value: 1.

Response parameters

For more information about all the common response parameters, see Common parameters.

Examples

Request example

  1. https://ecs.aliyuncs.com/?Action=RevokeSecurityGroup
  2. &SecurityGroupId=C0003E8B-B930-4F59-ADC0-0E209A9012B0
  3. &SourceGroupId=sg-F876FF7BA
  4. &SourceGroupOwnerAccount=test@aliyun.com
  5. &IpProtocol=tcp
  6. &PortRange=1/65535
  7. &Priority=1
  8. &<Common Request Parameters>

Response example

XML format

  1. <RevokeSecurityGroupResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
  3. </RevokeSecurityGroupResponse>

JSON format

  1. {
  2. "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
  3. }

Error codes

Error code Error message HTTP status code Meaning
InvalidIpPortRange.Malformed The specified parameter “PortRange” is not valid. 400 The specified PortRange is invalid.
InvalidIpProtocol.ValueNotSupported The specified IpProtocol does not exist. 400 The specified IpProtocol does not exist.
InvalidNicType.ValueNotSupported The specified NicType does not exist. 400 The specified NicType does not exist.
InvalidPolicy.Malformed The specified parameter “Policy” is not valid. 400 The specified Policy is invalid.
InvalidSourceCidrIp.Malformed The specified parameter “SourceCidrIp” is not valid. 400 The specified SourceCidrIp is invalid.
InvalidSourceGroupId.Mismatch Specified security group and source group are not in the same VPC. 400 The network type of the specified destination security group is VPC, so the source security group must be VPC-connected.
MissingParameter The input parameter “SourceGroupId” or “SourceCidrIp” cannot be both blank. 400 Either the SourceGroupId or SourceCidrIp must be specified.
InvalidGroupAuthItem.NotFound Specified group authorized item does not exist in our records. 403 The specified inbound security group rule does not exist.
InvalidNicType.Mismatch Specified nic type conflicts with the authorization record. 403 The specified NicType is invalid.
InvalidRegionId.NotFound The specified RegionId does not exist. 404 The specified RegionId does not exist.
InvalidSecurityGroupId.NotFound The specified SecurityGroupId does not exist. 404 The specified SecurityGroupId does not exist.
InvalidSourceGroupId.NotFound The SourceGroupId provided does not exist in our records. 404 The specified SourceGroupId does not exist.
Thank you! We've received your feedback.