All Products
Search
Document Center

Elastic Compute Service:RevokeSecurityGroup

Last Updated:May 16, 2024

Deletes one or more inbound security group rules.

Operation description

In the security group-related API documents, inbound traffic refers to the traffic sent by the source and received by the destination.

When you call this operation, you can use one of the following groups of parameters to specify the security group rules that you want to delete:

  • Parameters used to specify the IDs of security group rules. We recommend that you specify the IDs of security group rules to delete the rules. - If the security group rule ID that you specify does not exist, an error is reported. - You cannot specify the parameters that are no longer available and their Permissions.N-prefixed counterparts at the same time. - Sample request:

    http(s)://ecs.aliyuncs.com/?Action=RevokeSecurityGroup
    &SecurityGroupId=sg-bp67acfmxazb4p****
    &SecurityGroupRuleId.1=sgr-bpdfmk****
    &SecurityGroupRuleId.2=sgr-bpdfmg****
    &<Common request parameters>
    
  • Parameters that are prefixed with Permissions.N.

    • If no security group rule matches the specified parameters, the call to RevokeSecurityGroup is successful but no security group rules are deleted.

    • You cannot specify SecurityGroupRuleId.N or the parameters that are not prefixed with Permissions.N.

    • You can determine an inbound security group rule by specifying one of the following groups of parameters. You cannot determine an inbound security group rule by specifying only one parameter.

    • Parameters used to determine an inbound security group rule that controls access from a CIDR block: IpProtocol, PortRange, SourcePortRange (optional), NicType, Policy, DestCidrIp (optional), and SourceCidrIp. Sample request:

      http(s)://ecs.aliyuncs.com/?Action=RevokeSecurityGroup
      &SecurityGroupId=sg-bp67acfmxazb4p****
      &Permissions.1.SourceCidrIp=10.0.0.0/8
      &Permissions.1.IpProtocol=TCP
      &Permissions.1.PortRange=80/80
      &Permissions.1.NicType=intranet
      &Permissions.1.Policy=accept
      &<Common request parameters>
      
    • Parameters used to determine an inbound security group rule that controls access from another security group: IpProtocol, PortRange, SourcePortRange (optional), NicType, Policy, DestCidrIp (optional), and SourceGroupId. Sample request:

      http(s)://ecs.aliyuncs.com/?Action=RevokeSecurityGroup
      &SecurityGroupId=sg-bp67acfmxazb4p****
      &Permissions.1.SourceGroupId=sg-bp67acfmxa123b****
      &Permissions.1.IpProtocol=TCP
      &Permissions.1.PortRange=80/80
      &Permissions.1.NicType=intranet
      &Permissions.1.Policy=accept
      &<Common request parameters>
      
    • Parameters used to determine an inbound security group rule that controls access from a prefix list: IpProtocol, PortRange, SourcePortRange (optional), NicType, Policy, DestCidrIp (optional), and SourcePrefixListId. Sample request:

      http(s)://ecs.aliyuncs.com/?Action=RevokeSecurityGroup
      &SecurityGroupId=sg-bp67acfmxazb4p****
      &Permissions.1.SourcePrefixListId=pl-x1j1k5ykzqlixdcy****
      &Permissions.1.IpProtocol=TCP
      &Permissions.1.PortRange=80/80
      &Permissions.1.NicType=intranet
      &Permissions.1.Policy=accept
      &<Common request parameters>
      

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the security group. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000
SecurityGroupIdstringYes

The ID of the security group.

sg-bp67acfmxazb4p****
SecurityGroupRuleIdarrayNo

The IDs of the security group rules. Valid values of N: 1 to 100.

stringNo

The ID of the security group rule.

This parameter is required if you delete a security group rule based on the ID of the security group rule.

sgr-bp67acfmxa123b***
Permissionsobject []No

The security group rules. Valid values of N: 1 to 100.

PolicystringNo

The action of security group rule N that determines whether to allow inbound access. Valid values:

  • accept: allows access.
  • drop: denies access and returns no responses. In this case, the request times out or the connection cannot be established.

Default value: accept.

Valid values of N: 1 to 100.

accept
PrioritystringNo

The priority of security group rule N. A smaller value specifies a higher priority. Valid values: 1 to 100.

Default value: 1.

Valid values of N: 1 to 100.

1
IpProtocolstringNo

The transport layer protocol of security group rule N. The values of this parameter are not case-sensitive. Valid values:

  • TCP
  • UDP
  • ICMP
  • ICMPv6
  • GRE
  • ALL: All protocols are supported.

Valid values of N: 1 to 100.

TCP
SourceCidrIpstringNo

The source IPv4 CIDR block for security group rule N. CIDR blocks and IPv4 addresses are supported.

Valid values of N: 1 to 100.

10.0.0.0/8
Ipv6SourceCidrIpstringNo

The source IPv6 CIDR block for security group rule N. CIDR blocks and IPv6 addresses are supported.

Valid values of N: 1 to 100.

Note This parameter is valid only when the source is an Elastic Compute Service (ECS) instance that resides in a virtual private cloud (VPC) and supports IPv6 CIDR blocks. You cannot specify both this parameter and the SourceCidrIp parameter.
2001:db8:1234:1a00::***
SourceGroupIdstringNo

The ID of the source security group that is referenced in security group rule N.

  • Specify at least one of the following parameters: SourceGroupId, SourceCidrIp, Ipv6SourceCidrIp, and SourcePrefixListId.
  • If you specify SourceGroupId but you do not specify SourceCidrIp or Ipv6SourceCidrIp, you must set NicType to intranet.
  • If you specify SourceGroupId and SourceCidrIp, SourceCidrIp takes precedence.

When you specify this parameter, take note of the following items:

  • You cannot reference security groups as destinations or sources in the rules of advanced security groups.
  • You can reference up to 20 security groups as destinations or sources in the rules of each basic security group.

Valid values of N: 1 to 100.

sg-bp67acfmxa123b****
SourcePrefixListIdstringNo

The ID of the source prefix list that is referenced in security group rule N. You can call the DescribePrefixLists operation to query the IDs of available prefix lists.

When you specify this parameter, take note of the following items:

  • If the network type of a security group is classic network, you cannot reference prefix lists in the security group rules. For information about the limits on security groups and prefix lists, see the "Security group limits" section in Limits .
  • If you specify the SourceCidrIp, Ipv6SourceCidrIp, or SourceGroupId parameter, this parameter is ignored.

Valid values of N: 1 to 100.

pl-x1j1k5ykzqlixdcy****
PortRangestringNo

The range of destination ports that correspond to the transport layer protocol of security group rule N. Valid values:

  • If the Permissions.N.IpProtocol parameter is set to TCP or UDP, the port range is 1 to 65535. Specify a port range in the format of <start port number>/<end port number>. Example: 1/200.
  • If the Permissions.N.IpProtocol parameter is set to ICMP, the port range is -1/-1, which indicates all ports.
  • If the Permissions.N.IpProtocol parameter is set to GRE, the port range is -1/-1, which indicates all ports.
  • If the Permissions.N.IpProtocol parameter is set to ALL, the port range is -1/-1, which indicates all ports.

Valid values of N: 1 to 100.

1/200
DestCidrIpstringNo

The destination IPv4 CIDR block. CIDR blocks and IPv4 addresses are supported.

This parameter is supported by quintuple rules. For more information, see Security group quintuple rules.

Valid values of N: 1 to 100.

10.0.0.0/8
Ipv6DestCidrIpstringNo

The destination IPv6 CIDR block. CIDR blocks and IPv6 addresses are supported.

This parameter is supported by quintuple rules. For more information, see Security group quintuple rules.

Valid values of N: 1 to 100.

Note This parameter is valid only when the destination is an ECS instance that resides in a VPC and supports IPv6 CIDR blocks. You cannot specify both this parameter and the DestCidrIp parameter.
2001:db8:1233:1a00::***
SourcePortRangestringNo

The range of source ports that correspond to the transport layer protocol of security group rule N. Valid values:

  • If the Permissions.N.IpProtocol parameter is set to TCP or UDP, the port range is 1 to 65535. Specify a port range in the format of <start port number>/<end port number>. Example: 1/200.
  • If the Permissions.N.IpProtocol parameter is set to ICMP, the port range is -1/-1, which indicates all ports.
  • If the Permissions.N.IpProtocol parameter is set to GRE, the port range is -1/-1, which indicates all ports.
  • If the Permissions.N.IpProtocol parameter is set to ALL, the port range is -1/-1, which indicates all ports.

This parameter is supported by quintuple rules. For more information, see Security group quintuple rules.

Valid values of N: 1 to 100.

80/80
SourceGroupOwnerAccountstringNo

The Alibaba Cloud account that manages the source security group when you delete security group rule N across accounts.

  • If both SourceGroupOwnerAccount and SourceGroupOwnerId are not specified, the security group rule that controls access to other security groups managed by your account is deleted.
  • If you specify SourceCidrIp, SourceGroupOwnerAccount is ignored.

Valid values of N: 1 to 100.

Test@aliyun.com
SourceGroupOwnerIdlongNo

The ID of the Alibaba Cloud account that manages the source security group when you delete security group rule N across accounts.

  • If both SourceGroupOwnerId and SourceGroupOwnerAccount are not specified, the security group rule that controls access to other security groups managed by your account is deleted.
  • If you specify SourceCidrIp, SourceGroupOwnerId is ignored.

Valid values of N: 1 to 100.

12345678910
NicTypestringNo

The network interface card (NIC) type of the security group rule if the security group is of the classic network type. Valid values:

  • internet: public NIC
  • intranet: internal NIC

If the security group is in a VPC, this parameter is set to intranet by default and cannot be changed.

If you specify only SourceGroupId when you configure access between security groups, this parameter must be set to intranet.

Default value: internet.

Valid values of N: 1 to 100.

intranet
DescriptionstringNo

The description of security group rule N. The description must be 1 to 512 characters in length.

Valid values of N: 1 to 100.

This is description.
PolicydeprecatedstringNo

This parameter is deprecated. Use Permissions.N.Policy to specify whether to allow inbound access.

accept
PrioritydeprecatedstringNo

This parameter is deprecated. Use Permissions.N.Priority to specify the rule priority.

1
IpProtocoldeprecatedstringNo

This parameter is deprecated. Use Permissions.N.IpProtocol to specify the transport layer protocol.

ALL
SourceCidrIpdeprecatedstringNo

This parameter is deprecated. Use Permissions.N.SourceCidrIp to specify the source IPv4 CIDR block.

10.0.0.0/8
Ipv6SourceCidrIpdeprecatedstringNo

This parameter is deprecated. Use Permissions.N.Ipv6SourceCidrIp to specify the source IPv6 CIDR block.

2001:db8:1234:1a00::***
SourceGroupIddeprecatedstringNo

This parameter is deprecated. Use Permissions.N.SourceGroupId to specify the ID of the source security group.

sg-bp67acfmxa123b****
SourcePrefixListIddeprecatedstringNo

This parameter is deprecated. Use Permissions.N.SourcePrefixListId to specify the ID of the source prefix list.

pl-x1j1k5ykzqlixdcy****
PortRangedeprecatedstringNo

This parameter is deprecated. Use Permissions.N.PortRange to specify the range of destination ports.

1/200
DestCidrIpdeprecatedstringNo

This parameter is deprecated. Use Permissions.N.DestCidrIp to specify the destination IPv4 CIDR block.

10.0.0.0/8
Ipv6DestCidrIpdeprecatedstringNo

This parameter is deprecated. Use Permissions.N.Ipv6DestCidrIp to specify the destination IPv6 CIDR block.

2001:db8:1233:1a00::***
SourcePortRangedeprecatedstringNo

This parameter is deprecated. Use Permissions.N.SourcePortRange to specify the range of source ports.

80/80
SourceGroupOwnerAccountdeprecatedstringNo

This parameter is deprecated. Use Permissions.N.SourceGroupOwnerAccount to specify the Alibaba Cloud account that manages the source security group.

Test@aliyun.com
SourceGroupOwnerIddeprecatedlongNo

This parameter is deprecated. Use Permissions.N.SourceGroupOwnerId to specify the ID of the Alibaba Cloud account that manages the source security group.

12345678910
NicTypedeprecatedstringNo

This parameter is deprecated. Use Permissions.N.NicType to specify the network interface type.

intranet
DescriptiondeprecatedstringNo

This parameter is deprecated. Use Permissions.N.Description to specify the rule description.

This is description.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidSecurityGroupId.MalformedThe specified parameter SecurityGroupId is not valid.The specified SecurityGroupId parameter is invalid.
400InvalidIpProtocol.ValueNotSupportedThe parameter IpProtocol must be specified with case insensitive TCP, UDP, ICMP, GRE or All.The specified IpProtocol parameter is invalid. The valid values of this parameter are tcp, udp, icmp, gre, and all.
400InvalidIpPortRange.MalformedThe specified parameter PortRange is not valid.-
400InvalidSourceCidrIp.MalformedThe specified parameter SourceCidrIp is not valid.The specified source CIDR block is invalid.
400MissingParameterThe input parameter SourceGroupId or SourceCidrIp cannot be both blank.At least one of the SourceGroupId and SourceCidrIp parameters must be specified.
400InvalidPolicy.MalformedThe specified parameter %s is not valid.The specified Policy parameter is invalid.
400InvalidNicType.ValueNotSupportedThe specified parameter %s is not valid.The specified NicType parameter is invalid.
400InvalidSourceGroupId.MismatchSpecified security group and source group are not in the same VPC.The specified source and destination security groups do not belong to the same VPC.
400MissingParameter.SourceOne of the parameters SourceCidrIp, Ipv6SourceCidrIp, SourceGroupId or SourcePrefixListId in %s must be specified.At least one of the SourceCidrIp, SourceGroupId, and SourcePrefixListId parameters must be specified.
400InvalidParam.PortRangeThe specified parameter %s is not valid. It should be two integers less than 65535 in ?/? format.The format of the port range is invalid. Specify the port range in the format of a slash separating two integers.
400InvalidIpProtocol.ValueNotSupportedThe parameter %s must be specified with case insensitive TCP, UDP, ICMP, GRE or All.The specified Protocol parameter is invalid. You must set Protocol to a vaule that is case-insensitive, such as TCP, UDP, ICMP, GRE, and All.
400InvalidPriority.MalformedThe parameter Priority is invalid.The specified Priority parameter is invalid.
400InvalidPriority.ValueNotSupportedThe specified parameter %s is invalid.The specified Priority parameter is invalid.
400InvalidPriority.ValueNotSupportedThe parameter Priority is invalid.The specified Priority parameter is invalid.
400InvalidParamter.ConflictThe specified SecurityGroupId should be different from the SourceGroupId.The destination security group is the same as the source security group.
400InvalidDestCidrIp.MalformedThe specified parameter DestCidrIp is not valid.The specified DestCidrIp parameter is invalid.
400InvalidParam.SourceIpThe Parameters SourceCidrIp and Ipv6SourceCidrIp in %s cannot be set at the same time.The SourceCidrIp and Ipv6SourceCidrIp parameters cannot be specified at the same time.
400InvalidParam.DestIpThe Parameters DestCidrIp and Ipv6DestCidrIp in %s cannot be set at the same time.The DestCidrIp and Ipv6DestCidrIp parameters cannot be specified at the same time.
400InvalidParam.Ipv6DestCidrIpThe specified parameter %s is not valid.The specified Ipv6DestCidrIp parameter is invalid.
400InvalidParam.Ipv6SourceCidrIpThe specified parameter %s is not valid.The specified Ipv6SourceCidrIp parameter is invalid.
400InvalidParam.Ipv4ProtocolConflictWithIpv6AddressIPv6 address cannot be specified for IPv4-specific protocol.IPv6 addresses cannot be specified for instances that use the IPv4 protocol.
400InvalidParam.Ipv6ProtocolConflictWithIpv4AddressIPv4 address cannot be specified for IPv6-specific protocol.IPv4 addresses cannot be specified for instances that use the IPv6 protocol.
400InvalidParameter.Ipv6CidrIpThe specified Ipv6CidrIp is not valid.The specified Ipv6CidrIp parameter is invalid.
400InvalidGroupAuthParameter.OperationDeniedThe security group can not authorize to enterprise level security group.Security groups cannot be referenced as authorization objects (destinations or sources) in rules of advanced security groups.
400InvalidPortRange.MalformedThe specified parameter PortRange must set.The PortRange parameter must be specified.
400InvalidSourcePortRange.MalformedThe specified parameter SourcePortRange is not valid.The specified SourcePortRange parameter is invalid.
400InvalidSecurityGroupDiscription.MalformedThe specified security group rule description is not valid.The specified security group rule description is invalid.
400NotSupported.ClassicNetworkPrefixListThe prefix list is not supported when the network type of security group is classic.Security groups in the classic network do not support prefix lists.
400InvalidParam.SourceCidrIpThe specified parameter %s is not valid.The specified SourceCidrIp parameter is invalid.
400InvalidParam.SourceCidrIpThe specified param SourceCidrIp is not valid.The specified SourceCidrIp parameter is invalid.
400InvalidParam.DestCidrIpThe specified parameter %s is not valid.The specified DestCidrIp parameter is invalid.
400InvalidParam.DestCidrIpThe specified parameter DestCidrIp is invalid.The specified DestCidrIp parameter is invalid.
400InvalidParam.PermissionsThe specified parameter Permissions cannot coexist with other parameters.The specified Permissions parameter and other parameters are mutually exclusive.
400InvalidParam.DuplicatePermissionsThere are duplicate permissions in the specified parameter Permissions.The specified Permissions parameter contains duplicate permissions.
400InvalidSecurityGroupId.NotFoundThe specified parameter SecurityGroupId is not valid.The specified security group does not exist in this account. Check whether the security group ID is correct.
400InvalidParam.SecurityGroupRuleIdThe specified parameter SecurityGroupRuleId is not valid.The specified SecurityGroupRuleId parameter is invalid.
400InvalidParam.SecurityGroupRuleIdRepeatedThe specified parameter SecurityGroupRuleId is repeated.The SecurityGroupRuleId parameter has duplicate values.
400InvalidGroupParameter.OperationDeniedThe attributes Policy, SourceGroupId, DestGroupId of enterprise level security groups are not allowed to be set or modified.The attributes Policy, SourceGroupId, DestGroupId of enterprise level security groups are not allowed to be set or modified.
403InvalidNicType.MismatchThe specified NicType conflicts with the authorization record.The specified NIC type does not match the existing rule.
403InvalidGroupAuthItem.NotFoundSpecified group authorized item does not exist in our records.The security group referenced as the authorization object in the security group rule does not exist.
403InvalidOperation.ResourceManagedByCloudProduct%sYou cannot modify security groups managed by cloud services.
404InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.The specified security group does not exist in this account. Check whether the security group ID is correct.
404InvalidSourceGroupId.NotFoundThe SourceGroupId provided does not exist in our records.The specified SourceGroupId parameter does not exist.
404InvalidPrefixListId.NotFoundThe specified prefix list was not found.The prefix list does not exist.
404InvalidSecurityGroupRuleId.NotFoundThe specified SecurityGroupRuleId is not exists.The specified SecurityGroupRuleId parameter does not exist.
500InternalErrorThe request processing has failed due to some unknown error.An internal error has occurred. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-21The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
2023-04-07The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 404 change
    Error Codes 500 change
    delete Error Codes: 403
2022-09-05The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 403 change
    delete Error Codes: 404
    delete Error Codes: 500
2022-07-13API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Permissions
2022-05-07The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 404 change
    delete Error Codes: 403
    delete Error Codes: 500