ModifySecurityGroupEgressRule-阿里云帮助中心

Modifies an egress security group rule.

Operation description

When modifying security group rules by specifying the security group rule ID, note the following usage limits:

Authorization objects of security group rules include IPv4 CIDR blocks (or IP addresses), IPv6 CIDR blocks (or IP addresses), security groups, and prefix lists. You cannot use this API to change the authorization object type of an existing security group rule. For example, if the original authorization object type is an IPv4 CIDR block, you can change it to another IPv4 CIDR block (or IP address), but you cannot change it to an IPv6 CIDR block (or IP address), a security group, or a prefix list.
Fields cannot be changed from non-empty to empty. If modification is needed, we recommend that you add a new rule first and then delete the current rule.

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:ModifySecurityGroupEgressRule

update

*All Resource

*

ecs:tag
ecs:tag
ecs:SecurityGroupIpProtocols
ecs:SecurityGroupSourceCidrIps

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the source security group. You can call DescribeRegions to query the latest region list of Alibaba Cloud.	cn-hangzhou
RegionId	string	Yes	The region ID of the source security group. You can call DescribeRegions to query the latest region list of Alibaba Cloud.	cn-hangzhou
ClientToken	string	No	Ensures the idempotency of the request. The value is generated by a client and must be unique among different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotency.	123e4567-e89b-12d3-a456-426655440000
SecurityGroupId	string	Yes	The security group ID.	sg-bp67acfmxazb4p****
SecurityGroupRuleId	string	No	The security group rule ID. You can call DescribeSecurityGroupAttribute to query security group rule IDs.	sgr-bp67acfmxazb4q****
Policy	string	No	The access control policy. Valid values: accept: accepts access requests. drop: denies access requests without returning a rejection response. Default value: accept.	accept
Priority	string	No	The priority of the security group rule. Valid values: 1 to 100. Default value: 1.	1
IpProtocol	string	No	The network/transport layer protocol. Two types of values are supported: Case-insensitive protocol names. Valid values: ICMP GRE TCP UDP ALL: supports all protocols. Protocol numbers that comply with IANA specifications, which are integers from 0 to 255. Currently available regions: Philippines UK (London) Malaysia Hohhot Qingdao US West Singapore	tcp
DestCidrIp	string	No	The destination IPv4 CIDR block. CIDR format and IPv4 format are supported. Default value: none.	10.0.0.0/8
Ipv6DestCidrIp	string	No	The destination IPv6 CIDR block. CIDR format and IPv6 format are supported. Note Only VPC-type IP addresses are supported. This parameter and `DestCidrIp` cannot be specified at the same time. Default value: none.	2001:db8:1233:1a00::***
DestGroupId	string	No	The ID of the destination security group to which you want to set access permissions. At least one of `DestGroupId` or `DestCidrIp` must be specified. At least one of the DestGroupId, DestCidrIp, Ipv6DestCidrIp, or DestPrefixListId parameters must be specified. If DestGroupId is specified without DestCidrIp, the NicType parameter can only be set to intranet. If both DestGroupId and DestCidrIp are specified, DestCidrIp takes precedence by default.	sg-bp67acfmxa123b****
DestPrefixListId	string	No	The ID of the destination prefix list. You can call DescribePrefixLists to query available prefix list IDs. This parameter is ignored when any of the `DestCidrIp`, `Ipv6DestCidrIp`, or `DestGroupId` parameters is specified.	pl-x1j1k5ykzqlixdcy****
PortRange	string	No	The range of destination ports relevant to the transport layer protocol. Valid values: TCP/UDP protocol: Valid values are 1 to 65535. Use a forward slash (/) to separate the start port and the end port. Example: 1/200. ICMP protocol: -1/-1. GRE protocol: -1/-1. ALL: -1/-1.	80/80
SourceCidrIp	string	No	The source IPv4 CIDR block. CIDR format and IPv4 format are supported. Default value: none.	10.0.0.0/8
Ipv6SourceCidrIp	string	No	The source IPv6 CIDR block. CIDR format and IPv6 format are supported. Note Only VPC-type IP addresses are supported. This parameter and `SourceCidrIp` cannot be specified at the same time. Default value: none.	2001:db8:1234:1a00::***
SourcePortRange	string	No	The range of source ports relevant to the transport layer protocol. Valid values: TCP/UDP protocol: Valid values are 1 to 65535. Use a forward slash (/) to separate the start port and the end port. Example: 1/200. ICMP protocol: -1/-1. GRE protocol: -1/-1. ALL: -1/-1.	80/80
DestGroupOwnerAccount	string	No	The Alibaba Cloud account that owns the destination security group when you set security group rules across accounts.	EcsforCloud@Alibaba.com
DestGroupOwnerId	integer	No	The ID of the Alibaba Cloud account that owns the destination security group when you set security group rules across accounts.	1234567890
NicType	string	No	The NIC type. Note When modifying a rule by security group rule ID, this parameter cannot be modified. If modification is needed, we recommend that you add a new rule first and then delete the current rule.	intranet
Description	string	No	The description of the security group rule. The description must be 1 to 512 characters in length.	This is a new securitygroup rule.
PortRangeListId	string	No	The port range list ID. You can call `DescribePortRangeLists` to query available port range list IDs. This parameter is ignored when the PortRange parameter is specified. Port range lists are not supported for security groups of the classic network type. For more information about the usage limits of security groups and port range lists, see Security group limits.	prl-2ze9743****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

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

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	InvalidDestCidrIp.Malformed	The specified parameter DestCidrIp is not valid.	The specified DestCidrIp parameter 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	InvalidDestGroupId.Mismatch	Specified 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.
400	InvalidDestGroup.NotFound	Specified destination security group does not exist.	The specified DestGroupId parameter does not exist.
400	InvalidPriority.Malformed	The specified parameter Priority is not valid.	The specified Priority parameter is invalid.
400	InvalidPriority.ValueNotSupported	The specified Priority is invalid.	Your specified priority is invalid.
400	InvalidSecurityGroupDiscription.Malformed	The specified security group rule description 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.Dest	One of the parameters DestCidrIp, DestGroupId or DestPrefixListId must be specified.	At least one of the DestCidrIp, DestGroupId, and DestPrefixListId 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 specified parameter IpProtocol should not be null and only tcp, udp, icmp, gre or all is supported. Ignore case.	The specified protocol type cannot be empty and must be a legal value.
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	InvalidSourcePortRange.Malformed	The specified parameter SourcePortRange is not valid.	The specified SourcePortRange parameter is invalid.
400	InvalidParam.SourceCidrIp	The specified param SourceCidrIp is not valid.	The specified SourceCidrIp parameter is invalid.
400	InvalidParam.DestCidrIp	The specified param 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.SecurityGroupRuleId	The specified parameter SecurityGroupRuleId is not valid.	The specified SecurityGroupRuleId parameter is invalid.
400	InvalidOperation.ModifySgRuleEntityType	The source or destination type of the rules cannot be modified.	The type of the source or destination in the rule cannot be modified.
400	AuthorizationLimitExceed	The 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.
400	InvalidPrefixListId.NotFound	The specified prefix list was not found.
400	InvalidParam.ProtocolAndPortRangeMismatch	The specified Protocol and PortRange do not match.	The protocol and the port range do not match.
400	InvalidParam.ProtocolAndAddressFamilyMismatch	The specified Protocol and address family do not match.	The protocol and the address family do not match.
400	InvalidParam.PrefixListAddressFamilyMismatch	The address family of the prefix list does not match the rule.	The address family of the prefix list and the rule do not match.
400	InvalidParam.InvalidModifyRuleRequest	The request parameters are illegal.	The request parameter is invalid.
400	InvalidOperation.ModifyNicType	NicType is not allowed to modify.	The NicType parameter cannot be modified.
400	InvalidParamter.Conflict	The specified SourceCidrIp should be different from the DestCidrIp.	The value of SourceCidrIp must be different from that of DestCidrIp.
400	InvalidOperation.RuleDuplicate	%s.	The rule being modified will be duplicated with an existing rule.
400	InvalidParam.ProtocolNotSupportPortRangeList	The specified protocol does not support the port range list.	The specified protocol does not support the port list.
400	InvalidSourceOrDestGroupId.DirectionMissmatch	The specified SourceGroupId or DestGroupId does not match the direction of the rule.	The specified SourceGroupId or DestGroupId does not match the direction of the security group rule.
400	InvalidOperation.ModifyPortRangeType	The PortRange type is not allowed to be modified. You cannot modify a rule from using the port list to not using it, and vice versa.	The port range type of a security group rule cannot be modified. You cannot change a rule from using the port list to not using, and vice versa.
400	InvalidPortRangeListId.NotFound	The specified port range list was not found.	The specified port list was not found.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidDestGroupId.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 DestGroupId or DestCidrIp cannot be both blank.	The DestGroupId and DestCidrIp parameters are required.
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.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	InvalidSecurityGroup.IsSame	The 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.
403	InvalidOperation.ResourceManagedByCloudProduct	%s	You cannot modify security groups managed by cloud services.
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	InvalidDestGroupId.NotFound	The DestGroupId provided does not exist in our records.
404	SecurityGroupRule.NotFound	The target security group rule do not exist.	The specified security group rule does not exist.
404	InvalidPrefixListId.NotFound	The specified prefix list was not found.	The prefix list does not exist.
404	InvalidSecurityGroupRuleId.NotFound	The specified SecurityGroupRuleId is not exists.	The specified SecurityGroupRuleId parameter does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.