调用ModifySecurityGroupRule修改安全组入方向规则的描述信息。该接口只能修改描述信息,如果您需要修改安全组规则的策略、端口范围、授权对象等信息,请在ECS管理控制台修改。

接口说明

安全组相关的API文档中,入方向流量的发起端为源端(Source),数据传输的接收端为目的端(Dest)。

以下任意一组参数可以确定一条安全组入方向规则,只指定一个参数无法确定一条安全组规则。

  • 授权指定IP地址段访问的规则。如以下请求示例:IpProtocol、PortRange、(可选)SourcePortRange、NicType、Policy、(可选)DestCidrIp和SourceCidrIp。
    https://ecs.aliyuncs.com/?Action=ModifySecurityGroupRule
        &SecurityGroupId=sg-bp67acfmxazb4p****
        &SourceCidrIp=10.0.0.0/8
        &IpProtocol=tcp
        &PortRange=80/80
        &Policy=accept
        &Description=This is a new security group rule.
        &<公共请求参数>
  • 授权其他安全组访问的规则。如以下请求示例:IpProtocol、PortRange、(可选)SourcePortRange、NicType、Policy、(可选)DestCidrIp和SourceGroupId。
    https://ecs.aliyuncs.com/?Action=ModifySecurityGroupRule
        &SecurityGroupId=sg-bp67acfmxazb4p****
        &SourceGroupId=sg-bp67acfmxa123b****
        &IpProtocol=tcp
        &PortRange=80/80
        &Policy=accept
        &Description=This is a new security group rule.
        &<公共请求参数>
  • 关联了前缀列表的安全组规则。如以下请求示例:IpProtocol、PortRange、(可选)SourcePortRange、NicType、Policy、(可选)DestCidrIp和SourcePrefixListId。
    https://ecs.aliyuncs.com/?Action=ModifySecurityGroupRule
        &SecurityGroupId=sg-bp67acfmxazb4p****
        &SourcePrefixListId=pl-x1j1k5ykzqlixdcy****
        &IpProtocol=tcp
        &PortRange=80/80
        &Policy=accept
        &Description=This is a new security group rule.
        &<公共请求参数>

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifySecurityGroupRule

系统规定参数。取值:ModifySecurityGroupRule

IpProtocol String all

传输层协议。不区分大小写。取值范围:

  • icmp
  • gre
  • tcp
  • udp
  • all:支持所有协议
PortRange String 80/80

目的端安全组开放的传输层协议相关的端口范围。取值范围:

  • TCP/UDP协议:取值范围为1~65535。使用斜线(/)隔开起始端口和终止端口。例如:1/200
  • ICMP协议:-1/-1
  • GRE协议:-1/-1
  • all:-1/-1
RegionId String cn-hangzhou

目标安全组所属地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

SecurityGroupId String sg-bp67acfmxazb4p****

目标安全组ID。

SourceGroupId String sg-bp67acfmxa123b****

设置访问权限的源端安全组ID。至少设置一项SourceGroupId或者SourceCidrIp参数。

  • 如果指定了SourceGroupId没有指定参数SourceCidrIp,则参数NicType取值只能为intranet。
  • 如果同时指定了SourceGroupIdSourceCidrIp,则默认以SourceCidrIp为准。
SourceGroupOwnerId Long 12345678910

跨账户设置安全组规则时,源端安全组所属的阿里云账户ID。

  • 如果SourceGroupOwnerIdSourceGroupOwnerAccount均未设置,则认为是设置您其他安全组的访问权限。
  • 如果您已经设置参数SourceCidrIp,则参数SourceGroupOwnerId无效。
SourceGroupOwnerAccount String EcsforCloud@Alibaba.com

跨账户设置安全组规则时,源端安全组所属的阿里云账户。

  • 如果SourceGroupOwnerAccountSourceGroupOwnerID均未设置,则认为是设置您其他安全组的访问权限。
  • 如果已经设置参数SourceCidrIp,则参数SourceGroupOwnerAccount无效。
SourceCidrIp String 10.0.0.0/8

设置访问权限的源端IPv4 CIDR地址块。支持CIDR格式和IPv4格式的IP地址范围。

默认值:无

Ipv6SourceCidrIp String 2001:db8:1233:1a00::***

设置访问权限的源端IPv6 CIDR地址块。支持CIDR格式和IPv6格式的IP地址范围。

说明 仅支持VPC类型的IP地址。

默认值:无

SourcePrefixListId String pl-x1j1k5ykzqlixdcy****

设置访问权限的源端前缀列表ID。您可以调用DescribePrefixLists查询可以使用的前缀列表ID。

当您指定了SourceCidrIpIpv6SourceCidrIpSourceGroupId参数中的一个时,将忽略该参数。

SourcePortRange String 80/80

源端安全组开放的传输层协议相关的端口范围。取值范围:

  • TCP/UDP协议:取值范围为1~65535。使用斜线(/)隔开起始端口和终止端口。例如:1/200
  • ICMP协议:-1/-1
  • GRE协议:-1/-1
  • all:-1/-1
DestCidrIp String 10.0.0.0/8

目的端IPv4 CIDR地址块。支持CIDR格式和IPv4格式的IP地址范围。

默认值:无

Ipv6DestCidrIp String 2001:db8:1234:1a00::***

目的端IPv6 CIDR地址段。支持CIDR格式和IPv6格式的IP地址范围。

说明 仅支持VPC类型的IP地址。

默认值:无

Policy String accept

访问权限。取值范围:

  • accept:接受访问。
  • drop:拒绝访问,不返回拒绝信息。

默认值:accept

Priority String 1

安全组规则优先级。取值范围:1~100

默认值:1

NicType String intranet

经典网络类型安全组规则的网卡类型。取值范围:

  • internet:公网
  • intranet:内网

默认值:internet

在以下情况中,参数NicType取值只能为intranet:

  • 安全组规则的网络类型为专有网络VPC时,您必须设置NicType参数,且只能为intranet。
  • 当设置安全组之间互相访问时,即仅指定了SourceGroupId时,只能为intranet。
ClientToken String 123e4567-e89b-12d3-a456-426655440000

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多详情,请参见如何保证幂等性

Description String This is a new security group rule.

安全组规则的描述信息。长度为1~512个字符。

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=ModifySecurityGroupRule
&SecurityGroupId=sg-bp67acfmxazb4p****
&SourceGroupId=sg-bp67acfmxa123b****
&IpProtocol=all
&PortRange=80/80
&Policy=accept
&Description=This is a new security group rule.
&<公共请求参数>

正常返回示例

XML格式

<ModifySecurityGroupRuleResponse>
      <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
</ModifySecurityGroupRuleResponse>

JSON格式

{
    "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidSecurityGroupId.NotFound The specified SecurityGroupId does not exist. 指定的安全组在该用户账号下不存在,请您检查安全组ID是否正确。
404 InvalidSourceGroupId.NotFound The SourceGroupId provided does not exist in our records. 指定的入方向安全组不存在。
400 OperationDenied The specified IpProtocol does not exist or IpProtocol and PortRange do not match. 指定的IP协议不存在,或与端口范围不匹配。
400 InvalidIpProtocol.Malformed The specified parameter "PortRange" is not valid. IP协议参数格式不正确,PortRange参数不正确。
403 InvalidSourceGroupId.Mismatch NicType is required or NicType expects intrnet. 需要明确IP段类型参数或者网络类型必须为内网。
400 InvalidSourceCidrIp.Malformed The specified parameter "SourceCidrIp" is not valid. 源IP地址范围参数格式不正确。
403 MissingParameter The input parameter "SourceGroupId" or "SourceCidrIp" cannot be both blank. 参数SourceGroupId和SourceCidrIp不能同时为空。
400 InvalidPolicy.Malformed The specified parameter "Policy" is not valid. 指定的参数无效,请您检查该参数是否正确。
400 InvalidNicType.ValueNotSupported The specified NicType does not exist. 指定的网络类型不存在,请您检查网络类型是否正确。
400 InvalidNicType.Mismatch Specified nic type conflicts with the authorization record. 指定的NIC类型与规则信息冲突。
403 AuthorizationLimitExceed The limit of authorization records in the security group reaches. 安全组授权规则数达到上限,请您检查授权规则是否合理。
403 InvalidParamter.Conflict The specified SecurityGroupId should be different from the SourceGroupId. 授权与被授权安全组必须不同。
400 InvalidSourceGroupId.Mismatch Specified security group and source group are not in the same VPC. 指定的安全组和源安全组不在一个VPC内。
400 InvalidSourceGroup.NotFound Specified source security group does not exist. 指定的安全组入方向规则不存在,或相关参数缺失。
400 VPCDisabled Can't use the SecurityGroup in VPC. VPC 不支持安全组。
400 InvalidPriority.Malformed The parameter Priority is invalid. 指定的参数Priority无效。
400 InvalidPriority.ValueNotSupported The parameter Priority is invalid. 指定的参数Priority无效。
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。如果多次尝试失败,请提交工单。
403 InvalidNetworkType.Mismatch The specified SecurityGroup network type should be same with SourceGroup network type (vpc or classic). 指定的SecurityGroup的网络类型必须与SouceGroup的网络类型一致。
400 InvalidSecurityGroupDiscription.Malformed The specified security group rule description is not valid. 指定的安全组规则描述不合法。
404 SecurityGroupRule.NotFound The target security group rule not exist. 目标安全组规则不存在。
400 MissingParameter.Source One of the parameters SourceCidrIp, SourceGroupId or SourcePrefixListId must be specified. 至少需要指定参数SourceCidrIp、SourceGroupId或SourcePrefixListId中的一个。
400 InvalidIpProtocol.ValueNotSupported The parameter IpProtocol must be specified with case insensitive TCP, UDP, ICMP, GRE or All. 协议类型只能是TCP、UDP、ICMP、GRE或者All。
400 InvalidParam.SourceIp %s 指定的参数SourceIp无效。
400 InvalidParam.DestIp %s 指定的参数DestIp无效。
400 InvalidParam.Ipv6DestCidrIp %s 您输入的参数无效。
400 InvalidParam.Ipv6SourceCidrIp %s 您输入的参数无效。
400 InvalidParam.Ipv4ProtocolConflictWithIpv6Address %s 您输入的参数无效,请检查IPv4协议下是否填写了IPv6地址。
400 InvalidParam.Ipv6ProtocolConflictWithIpv4Address %s 您输入的参数无效,请检查IPv6协议下是否填写了IPv4地址。
400 ILLEGAL_IPV6_CIDR %s 指定的IPv6地址无效。
400 InvalidSourcePortRange.Malformed The specified parameter "SourcePortRange" is not valid. 指定的参数SourcePortRange无效。
400 InvalidSecurityGroupId.Malformed The specified parameter "SecurityGroupId" is not valid. 指定的参数SecurityGroupId无效。
403 InvalidOperation.ResourceManagedByCloudProduct %s 云产品托管的安全组不支持修改操作。
404 InvalidPrefixListId.NotFound The specified prefix list was not found. 前缀列表不存在。
404 NotSupported.GrayFunction The prefix list is a gray-scale function, not currently supported. 前缀列表功能正在邀测中,暂不支持本次操作。

访问错误中心查看更多错误码。