All Products
Search
Document Center

Elastic Compute Service:AuthorizeSecurityGroupEgress

Last Updated:Feb 04, 2024

Creates outbound rules in a security group. You can use the created rules to allow or deny outbound traffic from instances in the security group to other objects.

Operation description

In the security group-related API documents, outbound traffic refers to the traffic that is sent by the source device and received at the destination device.

When you call this operation, take note of the following items:

  • The total number of inbound and outbound security group rules in each security group cannot exceed 200. For more information, see the "Security group limits" section in .

  • You can set Policy to accept or drop for each security group rule to allow or deny access.

  • The valid value of Priority ranges from 1 to 100. A smaller value indicates a higher priority.

  • When several security group rules have the same priority, drop rules take precedence.

  • The destination can be a CIDR block specified by DestCidrIp, Ipv6DestCidrIp, or DestPrefixListId or can be Elastic Compute Service (ECS) instances in a security group specified by DestGroupId.

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

  • If the specified security group rule exists in the security group, the call is successful but no security group rule is created.

  • The Permissions.N prefix is added to some parameters to generate new parameters. Original parameters and corresponding parameters prefixed with Permissions.N cannot be configured together. We recommend that you use parameters prefixed with Permissions.N.

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

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

      http(s)://ecs.aliyuncs.com/?Action=AuthorizeSecurityGroupEgress
      &SecurityGroupId=sg-bp67acfmxazb4ph***
      &Permissions.1.IpProtocol=ICMP
      &Permissions.1.DestCidrIp=10.0.0.0/8
      &Permissions.1.PortRange=-1/-1
      &Permissions.1.NicType=intranet
      &Permissions.1.Policy=Accept
      &<Common request parameters>
      
    • Parameters used to specify a security group rule that controls access to a security group: IpProtocol, PortRange, SourcePortRange (optional), NicType, Policy, DestGroupOwnerAccount, and DestGroupId. Sample request:

      http(s)://ecs.aliyuncs.com/?Action=AuthorizeSecurityGroupEgress
      &SecurityGroupId=sg-bp67acfmxazb4ph***
      &Permissions.1.DestGroupId=sg-bp67acfmxazb4pi***
      &Permissions.1.DestGroupOwnerAccount=Test@aliyun.com
      &Permissions.1.IpProtocol=TCP
      &Permissions.1.PortRange=22/22
      &Permissions.1.NicType=intranet
      &Permissions.1.Policy=Drop
      &<Common request parameters>
      
    • Parameters used to specify a security group rule that controls access to a prefix list: IpProtocol, PortRange, SourcePortRange (optional), NicType, Policy, and DestPrefixListId. In this case, prefix lists support only security groups in virtual private clouds (VPCs). NicType must be set to intranet. Sample request:

      http(s)://ecs.aliyuncs.com/?Action=AuthorizeSecurityGroupEgress
      &SecurityGroupId=sg-bp67acfmxazb4ph***
      &Permissions.1.DestPrefixListId=pl-x1j1k5ykzqlixdcy****
      &Permissions.1.DestGroupOwnerAccount=Test@aliyun.com
      &Permissions.1.IpProtocol=TCP
      &Permissions.1.PortRange=22/22
      &Permissions.1.NicType=intranet
      &Permissions.1.Policy=Drop
      &<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 source 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 Ensure idempotence.

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

The security group ID.

sg-bp67acfmxazb4p****
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 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.

ALL
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 takes effect only when the destination is ECS instances that reside in VPCs and support IPv6 CIDR blocks. You cannot configure both this parameter and DestCidrIp.
2001:db8:1233:1a00::***
DestGroupIdstringNo

The ID of the destination security group to be referenced in security group rule N.

  • At least one of DestGroupId, DestCidrIp, Ipv6DestCidrIp, and DestPrefixListId must be configured.
  • If DestGroupId is configured but DestCidrIp is not configured, the value of NicType must be set to intranet.
  • If both DestGroupId and DestCidrIp are configured, the value of DestCidrIp prevails by default.

Valid values of N: 1 to 100.

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.
sg-bp67acfmxazb4p****
DestPrefixListIdstringNo

The ID of the destination prefix list to be 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 configured DestCidrIp, Ipv6DestCidrIp, or DestGroupId, DestPrefixListId 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. Separate the start port number and the end port number with a forward slash (/). 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.

80/80
SourceCidrIpstringNo

The source IPv4 CIDR block for security group rule N. 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
Ipv6SourceCidrIpstringNo

The source IPv6 CIDR block for security group rule N. 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 takes effect only when the source is ECS instances that reside in VPCs and support IPv6 CIDR blocks. You cannot configure both this parameter and SourceCidrIp.
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. Separate the start port number and the end port number with a forward slash (/). 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 supported by quintuple rules. For more information, see Security group quintuple rules.

Valid values of N: 1 to 100.

80/80
DestGroupOwnerAccountstringNo

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

  • If both DestGroupOwnerAccount and DestGroupOwnerId are not configured, the rule is created to control access to another security group within your Alibaba Cloud account.
  • If DestCidrIp is configured, DestGroupOwnerAccount is ignored.

Valid values of N: 1 to 100.

Test@aliyun.com
DestGroupOwnerIdlongNo

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

  • If both DestGroupOwnerId and DestGroupOwnerAccount are not configured, the rule is created to control access to another security group within your Alibaba Cloud account.
  • If DestCidrIp is configured, DestGroupOwnerId is ignored.

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 changed.
    • If you configure only DestGroupId 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 deprecated. Use Permissions.N.Policy to specify whether to allow outbound access.

accept
PrioritystringNo

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

1
IpProtocolstringNo

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

ALL
DestCidrIpstringNo

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

10.0.0.0/8
Ipv6DestCidrIpstringNo

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

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

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

sg-bp67acfmxazb4p****
DestPrefixListIdstringNo

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

pl-x1j1k5ykzqlixdcy****
PortRangestringNo

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

80/80
SourceCidrIpstringNo

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

10.0.0.0/8
Ipv6SourceCidrIpstringNo

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

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

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

80/80
DestGroupOwnerAccountstringNo

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

Test@aliyun.com
DestGroupOwnerIdlongNo

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

12345678910
NicTypestringNo

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

intranet
DescriptionstringNo

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

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
400OperationDeniedThe specified IpProtocol does not exist or IpProtocol and PortRange do not match.The specified IP protocol does not exist or does not match the specified port range.
400InvalidIpProtocol.MalformedThe specified parameter PortRange is not valid.The specified IpProtocol or PortRange parameter is invalid.
400InvalidDestCidrIp.MalformedThe specified parameter DestCidrIp is not valid.The specified DestCidrIp parameter is invalid.
400InvalidPolicy.MalformedThe specified parameter Policy is not valid.The specified Policy parameter is invalid.
400InvalidNicType.ValueNotSupportedThe specified NicType does not exist.The specified NicType parameter does not exist.
400InvalidNicType.MismatchThe specified NicType conflicts with the authorization record.The specified NIC type does not match the existing rule.
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.
400InvalidDestGroup.NotFoundSpecified destination security group does not exist.The specified DestGroupId parameter does not exist.
400VPCDisabledCan't use the SecurityGroup in VPC.-
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.
400InvalidDestCidrIp.MalformedThe parameter DestCidrIp is not valid.The specified DestCidrIp parameter is invalid.
400InvalidNicType.ValueNotSupportedThe specified parameter %s is not valid.The specified NicType parameter is invalid.
400InvalidPolicy.MalformedThe specified parameter %s is not valid.The specified Policy parameter is invalid.
400InvalidSecurityGroupDiscription.MalformedThe specified security group rule description parameter %s is not valid.The specified security group rule description is invalid.
400InvalidSecurityGroup.InvalidNetworkTypeThe specified security group network type is not support this operation, please check the security group network types. For VPC security groups, ClassicLink must be enabled.The operation is not supported while the security group is of the current network type. If the network type is VPC, ClassicLink must be enabled.
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.
400InvalidSecurityGroupId.MalformedThe specified parameter SecurityGroupId is not valid.The specified SecurityGroupId parameter is invalid.
400InvalidParamter.ConflictThe specified SourceCidrIp should be different from the DestCidrIp.The value of SourceCidrIp must be different from that of DestCidrIp.
400InvalidSourcePortRange.MalformedThe specified parameter SourcePortRange is not valid.The specified SourcePortRange parameter is invalid.
400InvalidPortRange.MalformedThe specified parameter PortRange must set.The PortRange parameter must be specified.
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.
400InvalidGroupParameter.OperationDeniedThe Priority, Policy, SourceGroupId, DestGroupId attributes of enterprise level security group can't be set or modified.-
400InvalidGroupAuthParameter.OperationDeniedThe security group can't authorize to enterprise level security group.-
400InvalidParameter.ConflictIPv6 and IPv4 addresses cannot exist at the same time.IPv6 and IPv4 addresses cannot be both specified.
400InvalidParam.PrefixListAddressFamilyMismatchThe address family of the specified prefix list does not match the specified CidrIp.The address family of the specified prefix list does not match that of the specified CIDR block.
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.
400AuthorizedGroupRule.LimitExceedYou've reached the limit on the number of group authorization rules that you can add to a security group.When authorization object of rule is security group, the limit is 20.-
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.SourceCidrIpThe specified param SourceCidrIp is not valid.The specified SourceCidrIp parameter is invalid.
400InvalidParam.SourceCidrIpThe specified parameter %s is not valid.The specified SourceCidrIp parameter is invalid.
400InvalidParam.PermissionsThe specified parameter Permissions cannot coexist with other parameters.The specified Permissions parameter and other parameters are mutually exclusive.
403InvalidDestGroupId.MismatchNicType is required or NicType expects intranet.The NicType parameter is not specified or is not set to intranet.
403MissingParameterThe input parameter DestGroupId or DestCidrIp cannot be both blank.The DestGroupId and DestCidrIp parameters are required.
403AuthorizationLimitExceedThe limit of authorization records in the security group reaches.The security group has reached the maximum number of rules that can be added to it.
403InvalidParamter.ConflictThe specified SecurityGroupId should be different from the SourceGroupId.The destination security group is the same as the source security group.
403InvalidNetworkType.ConflictThe specified SecurityGroup network type should be same with SourceGroup network type (vpc or classic).The network type of the destination security group is different from that of the source security group.
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.
403InvalidNetworkType.ConflictThe parameter SecurityGroup network type should be same with SourceGroup network type (vpc or classic).The network type of the specified security group is different from that of the source security group.
403InvalidOperation.ResourceManagedByCloudProduct%sYou cannot modify security groups managed by cloud services.
403LimitExceed.PrefixListAssociationResourceThe number of resources associated with the prefix list exceeds the limit.The maximum number of resources that can be associated with the prefix list has been exceeded.
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.-
404InvalidPrefixListId.NotFoundThe specified prefix list was not found.The prefix list does not exist.
404InvalidSecurityGroupId.NotFound%sThe specified security group ID 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 500 change
    delete Error Codes: 403
    delete Error Codes: 404
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
    Error Codes 500 change
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Permissions
2022-03-30The 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