本接口是阿里云 ECS 中用于增加一條或多條安全組入方向規(guī)則的接口。通過(guò)該接口,用戶可以指定安全組入方向的訪問(wèn)權(quán)限,允許或者拒絕其他設(shè)備發(fā)送入方向流量到安全組內(nèi)的實(shí)例,從而實(shí)現(xiàn)對(duì)網(wǎng)絡(luò)訪問(wèn)的精細(xì)控制。
接口說(shuō)明
使用須知
- 數(shù)量限制: 安全組出入向規(guī)則數(shù)量不能超過(guò) 200 條。具體限制請(qǐng)參見(jiàn)安全組使用限制。
- 規(guī)則分類: 安全組入方向規(guī)則分為接受訪問(wèn)(accept)和拒絕訪問(wèn)(drop)兩類。
- 優(yōu)先級(jí)設(shè)置: 安全組入方向規(guī)則優(yōu)先級(jí)(Priority)可選范圍為 1~100。數(shù)字越小,代表優(yōu)先級(jí)越高,優(yōu)先級(jí)相同的安全組規(guī)則,優(yōu)先以拒絕訪問(wèn)(drop)的規(guī)則為準(zhǔn)。
注意事項(xiàng)
- 如果指定的安全組規(guī)則已存在,此次調(diào)用成功,但不會(huì)增加規(guī)則。
規(guī)則確定方式
確定一條安全組入方向規(guī)則必要的一組相關(guān)參數(shù):
- 源端設(shè)置:選擇 SourceCidrIp(IPv4 地址)、Ipv6SourceCidrIp(IPv6 地址)、SourcetPrefixListId(前綴列表 ID)、SourceGroupId(源端安全組)中的一項(xiàng)。
- 目的端口范圍:PortRange。
- 協(xié)議類型:IpProtocol。
- 權(quán)限策略:Policy。
請(qǐng)求示例
假設(shè)要在杭州地域下指定安全組中增加幾條不同源端的入方向規(guī)則:
-
增加指定 IP 地址段的訪問(wèn)權(quán)限。
"RegionId":"cn-hangzhou", //設(shè)置地域 "SecurityGroupId":"sg-bp67acfmxazb4p****", //設(shè)置安全組 "Permissions":[ { "SourceCidrIp":"10.0.0.0/8", //設(shè)置源端 IPv4 地址 "PortRange":"22/22", //設(shè)置端口范圍 "IpProtocol":"TCP", //設(shè)置協(xié)議類型 "Policy":"Accept" //設(shè)置訪問(wèn)策略 } ]
-
增加一條其他安全組和一條前綴列表的訪問(wèn)權(quán)限。
"RegionId":"cn-hangzhou", "SecurityGroupId":"sg-bp67acfmxazb4p****", "Permissions":[ { "SourceGroupId":"sg-bp17vs63txqxbd****", //設(shè)置源端安全組 "PortRange":"22/22", "IpProtocol":"TCP", "Policy":"Drop" },{ "SourcePrefixListId":"pl-x1j1k5ykzqlixdcy****", //設(shè)置源端前綴列表 "PortRange":"22/22", "IpProtocol":"TCP", "Policy":"Drop" } ]
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ecs:AuthorizeSecurityGroup | create | *SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId} |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 安全組所屬地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
ClientToken | string | 否 | 保證請(qǐng)求冪等性。從您的客戶端生成一個(gè)參數(shù)值,確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符,且不能超過(guò) 64 個(gè)字符。更多信息,請(qǐng)參見(jiàn)如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
SecurityGroupId | string | 是 | 安全組 ID。 | sg-bp67acfmxazb4p**** |
Permissions | array<object> | 否 | 安全組規(guī)則數(shù)組。數(shù)組長(zhǎng)度:1~100。 | |
object | 否 | 安全組規(guī)則。 | ||
Policy | string | 否 | 設(shè)置訪問(wèn)權(quán)限。取值范圍:
默認(rèn)值:accept。 | accept |
Priority | string | 否 | 安全組規(guī)則優(yōu)先級(jí),數(shù)字越小,代表優(yōu)先級(jí)越高。取值范圍:1~100。 默認(rèn)值:1。 | 1 |
IpProtocol | string | 否 | 協(xié)議類型。取值不區(qū)分大小寫。取值范圍:
N 的取值范圍:1~100。 | ALL |
SourceCidrIp | string | 否 | 需要設(shè)置訪問(wèn)權(quán)限的源端 IPv4 CIDR 地址段。支持 CIDR 格式和 IPv4 格式的 IP 地址范圍。 | 10.0.0.0/8 |
Ipv6SourceCidrIp | string | 否 | 需要設(shè)置訪問(wèn)權(quán)限的源端 IPv6 CIDR 地址段。支持 CIDR 格式和 IPv6 格式的 IP 地址范圍。 說(shuō)明
僅在支持 IPv6 的 VPC 類型 ECS 實(shí)例上有效,且該參數(shù)與 SourceCidrIp 參數(shù)不可同時(shí)設(shè)置。
| 2001:250:6000::*** |
SourceGroupId | string | 否 | 需要設(shè)置訪問(wèn)權(quán)限的源端安全組 ID。
| sg-bp67acfmxazb4p**** |
SourcePrefixListId | string | 否 | 需要設(shè)置訪問(wèn)權(quán)限的源端前綴列表 ID。您可以調(diào)用 DescribePrefixLists 查詢可以使用的前綴列表 ID。 注意事項(xiàng):
| pl-x1j1k5ykzqlixdcy**** |
PortRange | string | 否 | 安全組開(kāi)放的各協(xié)議相關(guān)的目的端口范圍。取值范圍:
了解端口的應(yīng)用場(chǎng)景,請(qǐng)參見(jiàn)典型應(yīng)用的常用端口。 | 80/80 |
DestCidrIp | string | 否 | 目的端 IPv4 CIDR 地址段。支持 CIDR 格式和 IPv4 格式的 IP 地址范圍。 用于支持五元組規(guī)則,請(qǐng)參見(jiàn)安全組五元組規(guī)則。 | 10.0.0.0/8 |
Ipv6DestCidrIp | string | 否 | 目的端 IPv6 CIDR 地址段。支持 CIDR 格式和 IPv6 格式的 IP 地址范圍。 用于支持五元組規(guī)則,請(qǐng)參見(jiàn)安全組五元組規(guī)則。 說(shuō)明
僅在支持 IPv6 的 VPC 類型 ECS 實(shí)例上有效,且該參數(shù)與 DestCidrIp 參數(shù)不可同時(shí)設(shè)置。
| 2001:250:6000::*** |
SourcePortRange | string | 否 | 安全組開(kāi)放的各協(xié)議相關(guān)的源端端口范圍。取值范圍:
用于支持五元組規(guī)則,請(qǐng)參見(jiàn)安全組五元組規(guī)則。 | 7000/8000 |
SourceGroupOwnerAccount | string | 否 | 跨賬戶設(shè)置安全組規(guī)則時(shí),源端安全組所屬的阿里云賬戶。
| test@aliyun.com |
SourceGroupOwnerId | long | 否 | 跨賬戶設(shè)置安全組規(guī)則時(shí),源端安全組所屬的阿里云賬戶 ID。
| 1234567890 |
NicType | string | 否 | 經(jīng)典網(wǎng)絡(luò)類型安全組規(guī)則的網(wǎng)卡類型。取值范圍:
專有網(wǎng)絡(luò) VPC 類型安全組規(guī)則無(wú)需設(shè)置網(wǎng)卡類型,默認(rèn)為 intranet,只能為 intranet。 設(shè)置安全組之間互相訪問(wèn)時(shí),即僅指定了 DestGroupId 參數(shù)時(shí),只能為 intranet。 默認(rèn)值:internet。 | intranet |
Description | string | 否 | 安全組規(guī)則的描述信息。長(zhǎng)度為 1~512 個(gè)字符。 | This is description. |
Policydeprecated | string | 否 | 已廢棄。請(qǐng)使用 | accept |
Prioritydeprecated | string | 否 | 已廢棄。請(qǐng)使用 | 1 |
IpProtocoldeprecated | string | 否 | 已廢棄。請(qǐng)使用 | ALL |
SourceCidrIpdeprecated | string | 否 | 已廢棄。請(qǐng)使用 | 10.0.0.0/8 |
Ipv6SourceCidrIpdeprecated | string | 否 | 已廢棄。請(qǐng)使用 | 2001:250:6000::*** |
SourceGroupIddeprecated | string | 否 | 已廢棄。請(qǐng)使用 | sg-bp67acfmxazb4p**** |
SourcePrefixListIddeprecated | string | 否 | 已廢棄。請(qǐng)使用 | pl-x1j1k5ykzqlixdcy**** |
PortRangedeprecated | string | 否 | 已廢棄。請(qǐng)使用 | 22/22 |
DestCidrIpdeprecated | string | 否 | 已廢棄。請(qǐng)使用 | 10.0.0.0/8 |
Ipv6DestCidrIpdeprecated | string | 否 | 已廢棄。請(qǐng)使用 | null |
SourcePortRangedeprecated | string | 否 | 已廢棄。請(qǐng)使用 | 22/22 |
SourceGroupOwnerAccountdeprecated | string | 否 | 已廢棄。請(qǐng)使用 | test@aliyun.com |
SourceGroupOwnerIddeprecated | long | 否 | 已廢棄。請(qǐng)使用 | 1234567890 |
NicTypedeprecated | string | 否 | 已廢棄。請(qǐng)使用 | intranet |
Descriptiondeprecated | string | 否 | 已廢棄。請(qǐng)使用 | This is description. |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | OperationDenied | The specified IpProtocol does not exist or IpProtocol and PortRange do not match. | 指定的 IP 協(xié)議不存在,或與端口范圍不匹配。 |
400 | InvalidIpProtocol.Malformed | The specified parameter PortRange is not valid. | IP 協(xié)議參數(shù)格式不正確,PortRange 參數(shù)不正確。 |
400 | InvalidSourceCidrIp.Malformed | The specified parameter SourceCidrIp is not valid. | 源 IP 地址范圍參數(shù)格式不正確。 |
400 | InvalidPolicy.Malformed | The specified parameter Policy is not valid. | 指定的參數(shù)無(wú)效,請(qǐng)您檢查該參數(shù)是否正確。 |
400 | InvalidNicType.ValueNotSupported | The specified NicType does not exist. | 指定的網(wǎng)絡(luò)類型不存在,請(qǐng)您檢查網(wǎng)絡(luò)類型是否正確。 |
400 | InvalidNicType.Mismatch | The specified NicType conflicts with the authorization record. | 指定的網(wǎng)卡類型與已有規(guī)則不匹配。 |
400 | InvalidSourceGroupId.Mismatch | Specified security group and source group are not in the same VPC. | 指定的安全組和源安全組不在一個(gè) VPC 內(nèi)。 |
400 | InvalidSourceGroup.NotFound | Specified source security group does not exist. | 指定的安全組入方向規(guī)則不存在,或相關(guān)參數(shù)缺失。 |
400 | InvalidPriority.Malformed | The parameter Priority is invalid. | 指定的參數(shù) Priority 無(wú)效。 |
400 | InvalidPriority.ValueNotSupported | The specified parameter %s is invalid. | 指定的優(yōu)先級(jí)參數(shù)Priority不合法。 |
400 | InvalidNicType.ValueNotSupported | The specified parameter %s is not valid. | 指定的網(wǎng)卡類型參數(shù)NicType不合法。 |
400 | InvalidPolicy.Malformed | The specified parameter %s is not valid. | 指定的授權(quán)策略參數(shù)Policy不合法。 |
400 | InvalidSecurityGroupDiscription.Malformed | The specified security group rule description parameter %s is not valid. | 指定的安全組規(guī)則描述不合法。 |
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. | 指定的安全組網(wǎng)絡(luò)類型不支持此操作,請(qǐng)檢查安全組網(wǎng)絡(luò)類型。對(duì)于 VPC 安全組,必須啟用 ClassicLink。 |
400 | MissingParameter.Source | One of the parameters SourceCidrIp, Ipv6SourceCidrIp, SourceGroupId or SourcePrefixListId in %s must be specified. | 至少需要指定參數(shù)SourceCidrIp、SourceGroupId或SourcePrefixListId中的一個(gè)。 |
400 | InvalidParam.PortRange | The specified parameter %s is not valid. It should be two integers less than 65535 in ?/? format. | 端口范圍不合法,應(yīng)為斜線分隔兩個(gè)整數(shù)的格式。 |
400 | InvalidIpProtocol.ValueNotSupported | The parameter %s must be specified with case insensitive TCP, UDP, ICMP, GRE or All. | 協(xié)議Protocol字段不合法,應(yīng)指定大小寫不敏感的TCP,UDP,ICMP,GRE或All。 |
400 | InvalidSecurityGroupId.Malformed | The specified parameter SecurityGroupId is not valid. | 指定的參數(shù) SecurityGroupId 無(wú)效。 |
400 | InvalidParamter.Conflict | The specified SourceCidrIp should be different from the DestCidrIp. | 參數(shù) SourceCidrIp 和 DestCidrIp 不能相同。 |
400 | InvalidSourcePortRange.Malformed | The specified parameter SourcePortRange is not valid. | 指定的參數(shù) SourcePortRange 無(wú)效。 |
400 | InvalidPortRange.Malformed | The specified parameter PortRange must set. | 參數(shù)PortRange必須被設(shè)置。 |
400 | InvalidParam.SourceIp | The Parameters SourceCidrIp and Ipv6SourceCidrIp in %s cannot be set at the same time. | 參數(shù)SourceCidrIp和Ipv6SourceCidrIp不能被同時(shí)設(shè)置。 |
400 | InvalidParam.DestIp | The Parameters DestCidrIp and Ipv6DestCidrIp in %s cannot be set at the same time. | 參數(shù)DestCidrIp和Ipv6DestCidrIp不能被同時(shí)設(shè)置。 |
400 | InvalidParam.Ipv6DestCidrIp | The specified parameter %s is not valid. | 指定的參數(shù)Ipv6DestCidrIp不合法。 |
400 | InvalidParam.Ipv6SourceCidrIp | The specified parameter %s is not valid. | 指定的參數(shù)Ipv6SourceCidrIp不合法。 |
400 | InvalidParam.Ipv4ProtocolConflictWithIpv6Address | IPv6 address cannot be specified for IPv4-specific protocol. | IPv4協(xié)議不能指定IPv6地址。 |
400 | InvalidParam.Ipv6ProtocolConflictWithIpv4Address | IPv4 address cannot be specified for IPv6-specific protocol. | IPv6協(xié)議不能指定IPv4地址。 |
400 | InvalidParameter.Ipv6CidrIp | The specified Ipv6CidrIp is not valid. | 指定的Ipv6CidrIp參數(shù)不合法。 |
400 | InvalidGroupAuthParameter.OperationDenied | The security group can not authorize to enterprise level security group. | 安全組不能授權(quán)給企業(yè)級(jí)安全組。 |
400 | InvalidDestCidrIp.Malformed | The specified parameter DestCidrIp is not valid. | 指定的 DestCidrIp 無(wú)效,請(qǐng)您檢查該參數(shù)是否正確。 |
400 | InvalidParameter.Conflict | IPv6 and IPv4 addresses cannot exist at the same time. | IPv6地址和IPv4地址不能同時(shí)指定。 |
400 | InvalidParam.PrefixListAddressFamilyMismatch | The address family of the specified prefix list does not match the specified CidrIp. | 指定前綴列表的地址族,與指定的CidrIP的地址族不匹配。 |
400 | NotSupported.ClassicNetworkPrefixList | The prefix list is not supported when the network type of security group is classic. | 安全組的網(wǎng)絡(luò)類型為經(jīng)典網(wǎng)絡(luò),不支持前綴列表。 |
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. | 普通安全組內(nèi)以安全組為授權(quán)對(duì)象的規(guī)則,最多只能20條。 |
400 | InvalidParam.SourceCidrIp | The specified parameter %s is not valid. | 指定的參數(shù)SourceCidrIp不合法。 |
400 | InvalidParam.DestCidrIp | The specified parameter %s is not valid. | 指定的參數(shù)DestCidrIp不合法。 |
400 | InvalidParam.SourceCidrIp | The specified param SourceCidrIp is not valid. | 參數(shù)SourceCidrIp不合法。 |
400 | InvalidParam.DestCidrIp | The specified param DestCidrIp is not valid. | 您指定的參數(shù)DestCidrIp不合法。 |
400 | MissingParameter | %s | 缺失參數(shù),請(qǐng)檢查參數(shù)是否完整。 |
400 | InvalidParam.Permissions | The specified parameter Permissions cannot coexist with other parameters. | 指定的參數(shù)Permissions不能與其他參數(shù)同時(shí)存在。 |
400 | InvalidParam.DuplicatePermissions | There are duplicate permissions in the specified parameter Permissions. | 指定的參數(shù)Permissions中存在重復(fù)的規(guī)則。 |
400 | InvalidGroupParameter.OperationDenied | The attributes Policy, SourceGroupId, DestGroupId of enterprise level security groups are not allowed to be set or modified. | 企業(yè)級(jí)安全組不能指定Policy,SourceGroupId,DestGroupId等參數(shù)。 |
401 | InvalidOperation.SecurityGroupNotAuthorized | The specified security group is not authorized to operate. | 沒(méi)有權(quán)限操作當(dāng)前安全組 |
403 | InvalidSourceGroupId.Mismatch | NicType is required or NicType expects intranet. | 需要提供 NicType,NicType 僅在內(nèi)網(wǎng)中使用。 |
403 | MissingParameter | The input parameter SourceGroupId or SourceCidrIp cannot be both blank. | 參數(shù) SourceGroupId 和 SourceCidrIp 不能同時(shí)為空。 |
403 | AuthorizationLimitExceed | The limit of authorization records in the security group reaches. | 安全組授權(quán)規(guī)則數(shù)達(dá)到上限,請(qǐng)您檢查授權(quán)規(guī)則是否合理。 |
403 | InvalidParamter.Conflict | The specified SecurityGroupId should be different from the SourceGroupId. | 授權(quán)與被授權(quán)安全組必須不同。 |
403 | InvalidNetworkType.Mismatch | The specified SecurityGroup network type should be same with SourceGroup network type (vpc or classic). | 指定的 SecurityGroup 的網(wǎng)絡(luò)類型必須與 SouceGroup 的網(wǎng)絡(luò)類型一致。 |
403 | InvalidNetworkType.Conflict | The specified SecurityGroup network type should be same with SourceGroup network type (vpc or classic). | 指定的 SecurityGroup 的網(wǎng)絡(luò)類型必須與 SouceGroup 的網(wǎng)絡(luò)類型一致。 |
403 | InvalidOperation.ResourceManagedByCloudProduct | %s | 云產(chǎn)品托管的安全組不支持修改操作。 |
403 | LimitExceed.PrefixListAssociationResource | The number of resources associated with the prefix list exceeds the limit. | 與前綴列表關(guān)聯(lián)的資源數(shù)量超出限制。 |
404 | InvalidSecurityGroupId.NotFound | The specified SecurityGroupId does not exist. | 指定的安全組在該用戶賬號(hào)下不存在,請(qǐng)您檢查安全組 ID 是否正確。 |
404 | InvalidSourceGroupId.NotFound | The SourceGroupId provided does not exist in our records. | 指定的入方向安全組不存在。 |
404 | InvalidPrefixListId.NotFound | The specified prefix list was not found. | 前綴列表不存在。 |
404 | InvalidSecurityGroupId.NotFound | %s | 指定的安全組 ID 不存在。 |
500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯(cuò)誤,請(qǐng)重試。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-12-04 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-11-21 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-04-07 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2022-09-05 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2022-07-13 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2022-03-30 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |