All Products
Search
Document Center

Elastic Compute Service:RevokeSecurityGroupEgress

Last Updated:Mar 13, 2024

Deletes outbound security group rules.

Operation description

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 the Permissions.N-prefixed counterparts of the parameters at the same time. - Sample request:

    http(s)://ecs.aliyuncs.com/?Action=RevokeSecurityGroupEgress
    &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 RevokeSecurityGroupEgress is successful but no security group rules are deleted.

    • The SecurityGroupRuleId.N parameter and parameters that are not prefixed with Permissions.N cannot be specified.

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

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

      http(s)://ecs.aliyuncs.com/?Action=RevokeSecurityGroupEgress &SecurityGroupId=sg-bp67acfmxazb4ph*** &Permissions.1.IpProtocol=TCP &Permissions.1.DestCidrIp=10.0.0.0/8 &Permissions.1.PortRange=-22/22 &Permissions.1.NicType=intranet &Permissions.1.Policy=accept &<Common request parameters> ```

      • Parameters used to determine an outbound security group rule that controls access to another security group: IpProtocol, PortRange, SourcePortRange (optional), NicType, Policy, SourceCidrIp (optional), and DestGroupId. Sample request:

      http(s)://ecs.aliyuncs.com/?Action=RevokeSecurityGroupEgress &SecurityGroupId=sg-bp67acfmxazb4ph*** &Permissions.1.DestGroupId=sg-bp67acfmxa123b**** &Permissions.1.IpProtocol=TCP &Permissions.1.PortRange=22/22 &Permissions.1.NicType=intranet &Permissions.1.Policy=accept &<Common request parameters> ```

      • Parameters used to determine an outbound security group rule that controls access to a prefix list: IpProtocol, PortRange, SourcePortRange (optional), NicType, Policy, SourceCidrIp (optional), and DestPrefixListId. Sample request:

      http(s)://ecs.aliyuncs.com/?Action=RevokeSecurityGroupEgress &SecurityGroupId=sg-bp67acfmxazb4ph*** &Permissions.1.IpProtocol=TCP &Permissions.1.DestPrefixListId=pl-x1j1k5ykzqlixdcy**** &Permissions.1.PortRange=-22/22 &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 token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
SecurityGroupIdstringYes

The ID of the security group.

sg-bp67acfmxazb4p****
SecurityGroupRuleIdarrayNo

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

stringNo

The ID of security group rule N.

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

sgr-bp67acfmxa123b***
Permissionsobject []No

Security group rule N. Valid values of N: 1 to 100.

PolicystringNo

The action of security group rule N that determines whether to allow outbound 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 indicates 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 value of this parameter is case-insensitive. Valid values:

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

Valid values of N: 1 to 100.

TCP
DestCidrIpstringNo

The destination 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
Ipv6DestCidrIpstringNo

The destination 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 destination is Elastic Compute Service (ECS) instances that reside in virtual private clouds (VPCs) and support IPv6 CIDR blocks. You cannot specify both this parameter and the DestCidrIp parameter.
2001:db8:1233:1a00::***
DestGroupIdstringNo

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

  • At least one of DestGroupId, DestCidrIp, Ipv6DestCidrIp, and DestPrefixListId must be specified.
  • If DestGroupId is specified but DestCidrIp is not specified, the NicType parameter must be set to intranet.
  • If both DestGroupId and DestCidrIp are specified, DestCidrIp takes precedence.

Take note of the following items:

  • For advanced security groups, security groups cannot be used as authorization objects.
  • For each basic security group, a maximum of 20 security groups can be used as authorization objects.

Valid values of N: 1 to 100.

sg-bp67acfmxa123b****
DestPrefixListIdstringNo

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

Take note of the following items:

  • If a security group is in the 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 DestCidrIp, Ipv6DestCidrIp, or DestGroupId, 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 for security group rule N. Valid values:

  • If you set IpProtocol to TCP or UDP, the port number range is 1 to 65535. Specify a port range in the format of <Start port number>/<End port number>. Example: 1/200.
  • If you set IpProtocol to ICMP, the port number range is -1/-1.
  • If you set IpProtocol to GRE, the port number range is -1/-1.
  • If you set IpProtocol to ALL, the port number range is -1/-1.

Valid values of N: 1 to 100.

22/22
SourceCidrIpstringNo

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

This parameter is specified to meet quintuple rules. For more information, see Security group quintuple rules.

Valid values of N: 1 to 100.

10.0.0.0/8
Ipv6SourceCidrIpstringNo

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

This parameter is specified to meet 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 source is ECS instances that reside in VPCs and support IPv6 CIDR blocks. You cannot specify both this parameter and the SourceCidrIp parameter.
2001:db8:1234:1a00::***
SourcePortRangestringNo

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

  • If you set IpProtocol to TCP or UDP, the port number range is 1 to 65535. Specify a port range in the format of <Start port number>/<End port number>. Example: 1/200.
  • If you set IpProtocol to ICMP, the port number range is -1/-1.
  • If you set IpProtocol to GRE, the port number range is -1/-1.
  • If you set IpProtocol to ALL, the port number range is -1/-1.

This parameter is specified to meet quintuple rules. For more information, see Security group quintuple rules.

Valid values of N: 1 to 100.

22/22
DestGroupOwnerAccountstringNo

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

  • If both DestGroupOwnerAccount and DestGroupOwnerId are not specified, the access control is revoked from another security group managed by your account.
  • If DestCidrIp is specified, DestGroupOwnerAccount is ignored.

Valid values of N: 1 to 100.

Test@aliyun.com
DestGroupOwnerIdstringNo

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

  • If both DestGroupOwnerId and DestGroupOwnerAccount are not specified, the access control is revoked from another security group managed by your account.
  • If DestCidrIp is specified, DestGroupOwnerId is invalid.

Valid values of N: 1 to 100.

12345678910
NicTypestringNo

The network interface controller (NIC) type of security group rule N when the security group is in the classic network. 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 modified.

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

This parameter is no longer used. Use Permissions.N.Policy to specify whether to allow outbound access.

accept
PrioritystringNo

This parameter is no longer used. Use Permissions.N.Priority to specify the rule priority.

1
IpProtocolstringNo

This parameter is no longer used. Use Permissions.N.IpProtocol to specify the transport layer protocol.

TCP
DestCidrIpstringNo

This parameter is no longer used. Use Permissions.N.DestCidrIp to specify the destination IPv4 CIDR block.

10.0.0.0/8
Ipv6DestCidrIpstringNo

This parameter is no longer used. Use Permissions.N.Ipv6DestCidrIp to specify the destination IPv6 CIDR block.

2001:db8:1233:1a00::***
DestGroupIdstringNo

This parameter is no longer used. Use Permissions.N.DestGroupId to specify the ID of the destination security group.

sg-bp67acfmxa123b****
DestPrefixListIdstringNo

This parameter is no longer used. Use Permissions.N.DestPrefixListId to specify the ID of the destination prefix list.

pl-x1j1k5ykzqlixdcy****
PortRangestringNo

This parameter is no longer used. Use Permissions.N.PortRange to specify the range of destination ports.

22/22
SourceCidrIpstringNo

This parameter is no longer used. Use Permissions.N.SourceCidrIp to specify the source IPv4 CIDR block.

10.0.0.0/8
Ipv6SourceCidrIpstringNo

This parameter is no longer used. Use Permissions.N.Ipv6SourceCidrIp to specify the source IPv6 CIDR block.

2001:db8:1234:1a00::***
SourcePortRangestringNo

This parameter is no longer used. Use Permissions.N.SourcePortRange to specify the range of source ports.

22/22
DestGroupOwnerAccountstringNo

This parameter is no longer used. Use Permissions.N.DestGroupOwnerAccount to specify the Alibaba Cloud account that manages the destination security group.

Test@aliyun.com
DestGroupOwnerIdlongNo

This parameter is no longer used. Use Permissions.N.DestGroupOwnerId to specify the ID of the Alibaba Cloud account that manages the destination security group.

12345678910
NicTypestringNo

This parameter is no longer used. Use Permissions.N.NicType to specify the network interface type.

intranet
DescriptionstringNo

This parameter is no longer used. Use Permissions.N.Description to specify the description of security group rule N.

This is description.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
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.-
400InvalidDestCidrIp.sMalformedThe specified parameter DestCidrIp is not valid.The specified DestCidrIp parameter is invalid.
400MissingParameterThe input parameter DestGroupId or DestCidrIp cannot be both blank.The DestGroupId and DestCidrIp parameters are required.
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.
400InvalidDestGroupId.MismatchSpecified security group and destination group are not in the same VPC.The specified source and destination security groups do not belong to the same VPC.
400InvalidDestCidrIp.MalformedThe specified parameter DestCidrIp is not valid.The specified DestCidrIp parameter is invalid.
400MissingParameter.DestOne of the parameters DestCidrIp, Ipv6DestCidrIp, DestGroupId or DestPrefixListId in %s must be specified.Specify at least one of the DestCidrIp, Ipv6DestCidrIp, DestGroupId, and DestPrefixListId parameters.
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.
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.
400InvalidSecurityGroupId.MalformedThe specified parameter SecurityGroupId is not valid.The specified SecurityGroupId parameter is invalid.
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.
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.MismatchSpecified nic type conflicts with the authorization record.The specified NIC type does not match the authorization object of the security group 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.
403InvalidSecurityGroup.IsSameThe authorized SecurityGroupId should be different from the DestGroupId.The ID of the source security group is the same as that of the destination security group.
403InvalidParamter.ConflictThe specified SecurityGroupId should be different from the SourceGroupId.The destination security group is the same as the source security group.
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.
404InvalidDestGroupId.NotFoundThe DestGroupId provided does not exist in our records.-
404InvalidSecurityGroupRuleId.NotFoundThe specified SecurityGroupRuleId is not exists.The specified SecurityGroupRuleId parameter does not exist.
404InvalidPrefixListId.NotFoundThe specified prefix list was not found.The prefix list does not exist.

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
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
    delete Error Codes: 403
    delete Error Codes: 500
2022-09-05The 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
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