All Products
Search
Document Center

Elastic Compute Service:AuthorizeSecurityGroup

Last Updated:Oct 16, 2026

Adds one or more inbound rules to a security group in Elastic Compute Service (ECS). This operation allows you to specify inbound access permissions for a security group to allow or deny inbound traffic from other devices to instances in the security group, thereby implementing fine-grained network access control.

Operation description

Before you begin

  • Quota limit: The total number of rules (including inbound and outbound rules) in all security groups associated with a single Elastic Network Interface (ENI) cannot exceed 1,000. For more information about the limits, see Security group limits.

  • Priority settings: The priority of an inbound rule ranges from 1 to 100. A smaller value indicates a higher priority. For security group rules with the same priority, rules that deny access (drop) take precedence.

Precautions

If the specified security group rule already exists, the call succeeds but no new rule is added.

Rule definition

The following parameters are required to define an inbound rule:

  • Source settings: Specify one of the following parameters: SourceCidrIp (IPv4 address), Ipv6SourceCidrIp (IPv6 address), SourcePrefixListId (prefix list ID), or SourceGroupId (source security group).

  • Destination port range: PortRange.

  • Protocol type: IpProtocol.

  • Access policy: Policy.

Note

Advanced security groups do not support authorization for access from other security groups. A basic security group supports authorization for up to 20 security groups.

Request examples

The following examples show how to add inbound rules with different sources to a specified security group in the China (Hangzhou) region:

  • Add access permissions for a specified IP address range.

    "RegionId":"cn-hangzhou", // Specify the region ID.
    "SecurityGroupId":"sg-bp67acfmxazb4p****", // Specify the security group ID.
    "Permissions":[
         {
           "SourceCidrIp":"10.0.0.0/8", // Specify the source IPv4 address.
           "PortRange":"22/22", // Specify the port range.
           "IpProtocol":"TCP", // Specify the protocol type.
           "Policy":"Accept" // Specify the access policy.
         }
    ]
    
  • Add access permissions for another security group and a prefix list.

    "RegionId":"cn-hangzhou",
    "SecurityGroupId":"sg-bp67acfmxazb4p****",
    "Permissions":[
         {
           "SourceGroupId":"sg-bp17vs63txqxbd****", // Specify the source security group ID.
           "PortRange":"22/22",
           "IpProtocol":"TCP",
           "Policy":"Drop"
         },{
           "SourcePrefixListId":"pl-x1j1k5ykzqlixdcy****", // Specify the source prefix list ID.
           "PortRange":"22/22",
           "IpProtocol":"TCP",
           "Policy":"Drop"
         }
    ]
    

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:AuthorizeSecurityGroup

create

*All Resource

*

  • ecs:SecurityGroupIpProtocols
  • ecs:SecurityGroupSourceCidrIps
None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

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

cn-hangzhou

RegionId

string

Yes

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.

123e4567-e89b-12d3-a456-426655440000

RegionId

string

Yes

The security group ID.

sg-bp67acfmxazb4p****

ClientToken

string

No

The security group rules. Array length: 1 to 100.

123e4567-e89b-12d3-a456-426655440000

ClientToken

string

No

[Deprecated] Use Permissions.N.Policy to configure the access policy.

accept

SecurityGroupId

string

Yes

[Deprecated] Use Permissions.N.Priority to specify the priority of the security group rule.

1

SecurityGroupId

string

Yes

[Deprecated] Use Permissions.N.IpProtocol to specify the protocol type.

ALL

Permissions

array<object>

No

[Deprecated] Use Permissions.N.SourceCidrIp to specify the source IPv4 CIDR block.

10.0.0.0/8

object

No

The security group rule.

Policy

string

No

Settings for access permissions. Valid values:

  • accept: Accepts access.

  • drop: Denies access without returning a deny response. The request appears to timeout or the connection cannot be established.

Default value: accept.

accept

Priority

string

No

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

Default value: 1.

1

IpProtocol

string

No

The network-layer or transport-layer protocol. Two types of values are supported:

  1. Case-insensitive protocol names. Valid values:

  • ICMP

  • GRE

  • TCP

  • UDP

  • ALL: All protocols are supported.

  1. Protocol numbers that comply with IANA specifications, which are integers from 0 to 255. The following regions currently support this feature:

  • Philippines

  • UK

  • Malaysia

  • Hohhot

  • Qingdao

  • US West

  • Singapore

ALL

SourceCidrIp

string

No

The source IPv4 CIDR block for which you want to set access permissions. Settings support CIDR format and IPv4 format address ranges.

10.0.0.0/8

Ipv6SourceCidrIp

string

No

The source IPv6 CIDR block for which you want to set access permissions. Settings support CIDR format and IPv6 format address ranges.

Note

This parameter takes effect only for VPC-connected ECS instances that support IPv6. This parameter and SourceCidrIp cannot be specified at the same time.

2001:250:6000::***

SourceGroupId

string

No

The ID of the source security group for which you want to set access permissions.

  • Specify at least one of the following parameters: SourceGroupId, SourceCidrIp, Ipv6SourceCidrIp, or SourcePrefixListId.

  • If SourceGroupId is specified but SourceCidrIp or Ipv6SourceCidrIp is not specified, the NicType parameter can only be set to intranet.

  • If both SourceGroupId and SourceCidrIp are specified, SourceCidrIp takes precedence.

sg-bp67acfmxazb4p****

SourcePrefixListId

string

No

The ID of the source prefix list for which you want to set access permissions. You can call DescribePrefixLists to query available prefix list IDs.

Usage notes:

If you specify one of the SourceCidrIp, Ipv6SourceCidrIp, or SourceGroupId parameters, this parameter is ignored.

For more information, see Security group limits.

pl-x1j1k5ykzqlixdcy****

PortRange

string

No

The range of destination ports that correspond to the protocol for the security group. Valid values:

  • TCP/UDP: Valid values are 1 to 65535. Separate the start port and the stop port with a forward slash (/). Example: 1/200.

  • ICMP: -1/-1.

  • GRE: -1/-1.

  • If IpProtocol is set to ALL: -1/-1.

For more information about common scenarios of ports, see Common ports.

80/80

DestCidrIp

string

No

The destination IPv4 CIDR block. CIDR blocks and IPv4 address ranges are supported.

This parameter is used to support quintuple rules. For more information, see Security group quintuple rules.

10.0.0.0/8

Ipv6DestCidrIp

string

No

The destination IPv6 CIDR block. Settings support CIDR format and IPv6 format address ranges.

This parameter is used to support quintuple rules. For more information, see Security group quintuple rules.

Note

This parameter takes effect only for VPC-connected ECS instances that support IPv6. This parameter and DestCidrIp cannot be specified at the same time.

2001:250:6000::***

SourcePortRange

string

No

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

  • TCP/UDP: Valid values are 1 to 65535. Separate the start port and the end port with a forward slash (/). Example: 1/200.

  • ICMP: -1/-1.

  • GRE: -1/-1.

  • If IpProtocol is set to ALL: -1/-1.

This parameter is used to support quintuple rules. For more information, see Security group quintuple rules.

7000/8000

SourceGroupOwnerAccount

string

No

The Alibaba Cloud account that owns the source security group when you set a cross-account security group rule. Settings apply as follows:

  • If neither SourceGroupOwnerAccount nor SourceGroupOwnerId is set, the rule is created to set access permissions for another security group within your account.

  • If the SourceCidrIp parameter is specified, the SourceGroupOwnerAccount parameter is ignored.

test@aliyun.com

SourceGroupOwnerId

integer

No

The ID of the Alibaba Cloud account that owns the source security group when you set a cross-account security group rule. Settings apply as follows:

  • If neither SourceGroupOwnerAccount nor SourceGroupOwnerId is set, the rule is created to set access permissions for another security group within your account.

  • If the SourceCidrIp parameter is specified, the SourceGroupOwnerAccount parameter is ignored.

1234567890

NicType

string

No

The network interface controller (NIC) type for a classic network security group rule. Settings include the following valid values:

  • internet: public network interface controller (NIC).

  • intranet: internal network interface controller (NIC).

For VPC security group rules, you do not need to set the network interface controller (NIC) type. The default value is intranet, and only intranet is supported.

When you set security groups to access each other, meaning only the DestGroupId parameter is specified, only intranet is supported.

Default value: internet.

intranet

Description

string

No

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

This is description.

PortRangeListId

string

No

The port address book ID. You can invoke DescribePortRangeLists to query available port address book IDs.

  • If you specify Permissions.N.PortRange, this parameter is ignored.

  • Port address books are not supported when the security group network type is classic network. For more information about security group and port address book limits, see Security group limits. Settings for port address books are subject to these limits.

prl-2ze9743****

Policy deprecated

string

No

[Deprecated] Use Permissions.N.Ipv6SourceCidrIp to specify the source IPv6 CIDR block.

2001:250:6000::***

Priority deprecated

string

No

[Deprecated] Use Permissions.N.SourceGroupId to specify the source security group ID.

sg-bp67acfmxazb4p****

IpProtocol deprecated

string

No

[Deprecated] Use Permissions.N.SourcePrefixListId to specify the source prefix list ID.

pl-x1j1k5ykzqlixdcy****

SourceCidrIp deprecated

string

No

[Deprecated] Use Permissions.N.PortRange to specify the port range.

22/22

Ipv6SourceCidrIp deprecated

string

No

[Deprecated] Use Permissions.N.DestCidrIp to specify the destination IPv4 CIDR block.

10.0.0.0/8

SourceGroupId deprecated

string

No

[Deprecated] Use Permissions.N.Ipv6DestCidrIp to specify the destination IPv6 CIDR block.

null

SourcePrefixListId deprecated

string

No

[Deprecated] Use Permissions.N.SourcePortRange to specify the source port range.

22/22

PortRange deprecated

string

No

[Deprecated] Use Permissions.N.SourceGroupOwnerAccount to specify the Alibaba Cloud account to which the source security group belongs.

test@aliyun.com

DestCidrIp deprecated

string

No

[Deprecated] Use Permissions.N.SourceGroupOwnerId to specify the ID of the Alibaba Cloud account to which the source security group belongs.

1234567890

Ipv6DestCidrIp deprecated

string

No

[Deprecated] Use Permissions.N.NicType to specify the NIC type.

intranet

SourcePortRange deprecated

string

No

[Deprecated] Use Permissions.N.Description to specify the description of the security group rule.

This is description.

SourceGroupOwnerAccount deprecated

string

No

Deprecated. Use Permissions.N.SourceGroupOwnerAccount to specify the Alibaba Cloud account that owns the source security group.

test@aliyun.com

SourceGroupOwnerId deprecated

integer

No

Deprecated. Use Permissions.N.SourceGroupOwnerId to specify the ID of the Alibaba Cloud account that owns the source security group.

1234567890

NicType deprecated

string

No

Deprecated. Use Permissions.N.NicType to specify the NIC type.

intranet

Description deprecated

string

No

Deprecated. Use Permissions.N.Description to specify the description of the security group rule.

This is description.

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

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

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 OperationDenied The 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.
400 InvalidIpProtocol.Malformed The specified parameter PortRange is not valid. The specified IpProtocol or PortRange parameter is invalid.
400 InvalidSourceCidrIp.Malformed The specified parameter SourceCidrIp is not valid. The specified source CIDR block is invalid.
400 InvalidPolicy.Malformed The specified parameter Policy is not valid. The specified Policy parameter is invalid.
400 InvalidNicType.ValueNotSupported The specified NicType does not exist. The specified NicType parameter does not exist.
400 InvalidNicType.Mismatch The specified NicType conflicts with the authorization record. The specified NIC type does not match the existing rule.
400 InvalidSourceGroupId.Mismatch Specified 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.
400 InvalidSourceGroup.NotFound Specified source security group does not exist. The specified inbound security group rule does not exist, or required parameters are not specified.
400 InvalidPriority.Malformed The parameter Priority is invalid. The specified Priority parameter is invalid.
400 InvalidPriority.ValueNotSupported The specified parameter %s is invalid. The specified Priority parameter is invalid.
400 InvalidSecurityGroupDiscription.Malformed The specified security group rule description parameter %s is not valid. The specified security group rule description is invalid.
400 InvalidSecurityGroup.InvalidNetworkType The 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.
400 MissingParameter.Source One 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.
400 InvalidParam.PortRange The 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.
400 InvalidIpProtocol.ValueNotSupported The 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.
400 InvalidSecurityGroupId.Malformed The specified parameter SecurityGroupId is not valid. The specified SecurityGroupId parameter is invalid.
400 InvalidParamter.Conflict The specified SourceCidrIp should be different from the DestCidrIp. The value of SourceCidrIp must be different from that of DestCidrIp.
400 InvalidSourcePortRange.Malformed The specified parameter SourcePortRange is not valid. The specified SourcePortRange parameter is invalid.
400 InvalidPortRange.Malformed The specified parameter PortRange must set. The PortRange parameter must be specified.
400 InvalidParam.SourceIp The 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.
400 InvalidParam.DestIp The 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.
400 InvalidParam.Ipv6DestCidrIp The specified parameter %s is not valid. The specified Ipv6DestCidrIp parameter is invalid.
400 InvalidParam.Ipv6SourceCidrIp The specified parameter %s is not valid. The specified Ipv6SourceCidrIp parameter is invalid.
400 InvalidParam.Ipv4ProtocolConflictWithIpv6Address IPv6 address cannot be specified for IPv4-specific protocol. IPv6 addresses cannot be specified for instances that use the IPv4 protocol.
400 InvalidParam.Ipv6ProtocolConflictWithIpv4Address IPv4 address cannot be specified for IPv6-specific protocol. IPv4 addresses cannot be specified for instances that use the IPv6 protocol.
400 InvalidParameter.Ipv6CidrIp The specified Ipv6CidrIp is not valid. The specified Ipv6CidrIp parameter is invalid.
400 InvalidGroupAuthParameter.OperationDenied The 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.
400 InvalidDestCidrIp.Malformed The specified parameter DestCidrIp is not valid. The specified DestCidrIp parameter is invalid.
400 InvalidParameter.Conflict IPv6 and IPv4 addresses cannot exist at the same time. IPv6 and IPv4 addresses cannot be both specified.
400 InvalidParam.PrefixListAddressFamilyMismatch The 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.
400 NotSupported.ClassicNetworkPrefixList The 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.
400 AuthorizedGroupRule.LimitExceed You have 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. Up to 20 rules in which security groups are specified as authorization objects can be present in a basic security group.
400 InvalidParam.SourceCidrIp The specified parameter %s is not valid. The specified SourceCidrIp parameter is invalid.
400 InvalidParam.DestCidrIp The specified parameter %s is not valid. The specified DestCidrIp parameter is invalid.
400 MissingParameter %s A parameter is not specified.
400 InvalidParam.Permissions The specified parameter Permissions cannot coexist with other parameters. The specified Permissions parameter and other parameters are mutually exclusive.
400 InvalidParam.DuplicatePermissions There are duplicate permissions in the specified parameter Permissions. The specified Permissions parameter contains duplicate permissions.
400 InvalidGroupParameter.OperationDenied The 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.
400 InvalidParam.ProtocolNotSupportPortRangeList The specified protocol does not support the port range list. The specified protocol does not support the port list.
400 InvalidPortRangeListId.NotFound The specified port range list was not found. The specified port list was not found.
401 InvalidOperation.SecurityGroupNotAuthorized The specified security group is not authorized to operate. You do not have permission to operate the current security group.
500 InternalError The request processing has failed due to some unknown error.
403 InvalidSourceGroupId.Mismatch NicType is required or NicType expects intranet. The NicType parameter is not specified or is not set to intranet.
403 MissingParameter The input parameter SourceGroupId or SourceCidrIp cannot be both blank. At least one of the SourceGroupId and SourceCidrIp parameters must be specified.
403 AuthorizationLimitExceed The limit of authorization records in the security group reaches.
403 InvalidParamter.Conflict The specified SecurityGroupId should be different from the SourceGroupId. The destination security group is the same as the source security group.
403 InvalidNetworkType.Mismatch The 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.
403 InvalidNetworkType.Conflict The 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.
403 InvalidOperation.ResourceManagedByCloudProduct %s You cannot modify security groups managed by cloud services.
403 LimitExceed.PrefixListAssociationResource The 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.
404 InvalidSecurityGroupId.NotFound The specified SecurityGroupId does not exist. The specified security group does not exist in this account. Check whether the security group ID is correct.
404 InvalidSourceGroupId.NotFound The SourceGroupId provided does not exist in our records. The specified SourceGroupId parameter does not exist.
404 InvalidPrefixListId.NotFound The specified prefix list was not found. The prefix list does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.