本接口用于刪除指定安全組內(nèi)的一條或多條入方向安全組規(guī)則。
接口說明
注意 阿里云已于 2024 年 7 月 8 日對該接口進行了校驗規(guī)則調(diào)整。當刪除不存在的安全組規(guī)則時，從返回成功調(diào)整為返回錯誤碼：“InvalidSecurityGroupRule.RuleNotExist“。請您及時做好錯誤碼兼容，避免影響線上業(yè)務。
-
通過指定安全組規(guī)則 ID 參數(shù)刪除規(guī)則（推薦）。
- 如果指定的安全組規(guī)則 ID 不存在，會報異常。
-
通過指定 Permissions 刪除規(guī)則。
- 如果匹配的安全組規(guī)則不存在，此次調(diào)用成功，但不會刪除規(guī)則。
- 確定一條安全組入方向規(guī)則必要的一組相關參數(shù)：
- 源端設置：選擇 SourceCidrIp（IPv4 地址）、Ipv6SourceCidrIp（IPv6 地址）、SourcetPrefixListId（前綴列表 ID）、SourceGroupId（源端安全組）中的一項。
- 目的端口范圍：PortRange。
- 協(xié)議類型：IpProtocol。
- 權限策略：Policy。
說明
不支持同時設置安全組規(guī)則 ID 和 Permissions 參數(shù)。
請求示例
- 根據(jù)指定安全組規(guī)則 ID 刪除。
"SecurityGroupId":"sg-bp67acfmxazb4p****", //設置安全組 ID
"SecurityGroupRuleId":["sgr-bpdfmk****","sgr-bpdfmg****"] //設置安全組規(guī)則 ID
- 根據(jù)指定 IP 地址段刪除。
"SecurityGroupId":"sg-bp67acfmxazb4p****",
"Permissions":[
{
"SourceCidrIp":"10.0.0.0/8", //設置源端 IP 地址段
"IpProtocol":"TCP", //設置協(xié)議類型
"PortRange":"80/80", //設置目的端口范圍
"Policy":"accept" //設置訪問策略
}
]
- 根據(jù)其他安全組刪除。
"SecurityGroupId":"sg-bp67acfmxazb4p****",
"Permissions":[
{
"SourceGroupId":"sg-bp67acfmxa123b****", //設置源端安全組 ID
"IpProtocol":"TCP,"
"PortRange":"80/80",
"Policy":"accept"
]
}
- 根據(jù)指定前綴列表刪除。
"SecurityGroupId":"sg-bp67acfmxazb4p****",
"Permissions":[
{
"SourcePrefixListId":pl-x1j1k5ykzqlixdcy****", //設置源端前綴列表 ID
"IpProtocol":"TCP",
"PortRange":"80/80",
"Policy":"accept"
}
]
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作：是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
|---|---|---|---|---|
| ecs:RevokeSecurityGroup | delete | *SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 安全組所屬地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數(shù)值，確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符，且不能超過 64 個字符。更多詳情，請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
| SecurityGroupId | string | 是 | 安全組 ID。 | sg-bp67acfmxazb4p**** |
| SecurityGroupRuleId | array | 否 | 安全組規(guī)則 ID 數(shù)組。數(shù)組長度：0~100。 | |
| string | 否 | 安全組規(guī)則 ID。 說明
通過安全組規(guī)則 ID 刪除時，該參數(shù)必填。
| sgr-bp67acfmxa123b*** | |
| Permissions | array<object> | 否 | 安全組規(guī)則數(shù)組。數(shù)組長度：0~100。 | |
| object | 否 | 安全組規(guī)則。 | ||
| Policy | string | 否 | 訪問權限。取值范圍：
默認值：accept。 | accept |
| Priority | string | 否 | 安全組規(guī)則優(yōu)先級，數(shù)字越小，代表優(yōu)先級越高。取值范圍：1~100。 默認值：1。 | 1 |
| IpProtocol | string | 否 | 協(xié)議類型。取值不區(qū)分大小寫。取值范圍：
| TCP |
| SourceCidrIp | string | 否 | 需要撤銷訪問權限的源端 IPv4 CIDR 地址塊。支持 CIDR 格式和 IPv4 格式的 IP 地址范圍。 | 10.0.0.0/8 |
| Ipv6SourceCidrIp | string | 否 | 需要撤銷訪問權限的源端 IPv6 CIDR 地址塊。支持 CIDR 格式和 IPv6 格式的 IP 地址范圍。 說明
僅在支持 IPv6 的 VPC 類型 ECS 實例上有效，且該參數(shù)與 SourceCidrIp參數(shù)不可同時設置。
| 2001:db8:1234:1a00::*** |
| SourceGroupId | string | 否 | 需要撤銷訪問權限的源端安全組 ID。
您需要注意：
| sg-bp67acfmxa123b**** |
| SourcePrefixListId | string | 否 | 需要撤銷訪問權限的源端前綴列表 ID。您可以調(diào)用 DescribePrefixLists 查詢可以使用的前綴列表 ID。 注意事項：
| pl-x1j1k5ykzqlixdcy**** |
| PortRange | string | 否 | 安全組開放的各協(xié)議相關的目的端口范圍。取值范圍：
| 1/200 |
| DestCidrIp | string | 否 | 目的端 IPv4 CIDR 地址段。支持 CIDR 格式和 IPv4 格式的 IP 地址范圍。 用于支持五元組規(guī)則，請參見安全組五元組規(guī)則。 | 10.0.0.0/8 |
| Ipv6DestCidrIp | string | 否 | 目的端 IPv6 CIDR 地址段。支持 CIDR 格式和 IPv6 格式的 IP 地址范圍。 用于支持五元組規(guī)則，請參見安全組五元組規(guī)則。 說明
僅在支持 IPv6 的 VPC 類型 ECS 實例上有效，且該參數(shù)與 DestCidrIp參數(shù)不可同時設置。
| 2001:db8:1233:1a00::*** |
| SourcePortRange | string | 否 | 安全組開放的各協(xié)議相關的源端端口范圍。取值范圍：
用于支持五元組規(guī)則，請參見安全組五元組規(guī)則。 | 80/80 |
| SourceGroupOwnerAccount | string | 否 | 撤銷跨賬戶授權的安全組規(guī)則時，源端安全組所屬的阿里云賬戶。
| Test@aliyun.com |
| SourceGroupOwnerId | long | 否 | 撤銷跨賬戶授權的安全組規(guī)則時，源端安全組所屬的阿里云賬戶 ID。
| 12345678910 |
| NicType | string | 否 | 經(jīng)典網(wǎng)絡類型安全組規(guī)則的網(wǎng)卡類型。取值范圍：
專有網(wǎng)絡 VPC 類型安全組規(guī)則無需設置網(wǎng)卡類型，默認為 intranet，只能為 intranet。 撤銷安全組之間授權規(guī)則，即指定了 默認值：internet。 | intranet |
| Description | string | 否 | 安全組規(guī)則描述。長度為 1~512 個字符。 | This is description. |
Policydeprecated | string | 否 | 已廢棄。請使用 | accept |
Prioritydeprecated | string | 否 | 已廢棄。請使用 | 1 |
IpProtocoldeprecated | string | 否 | 已廢棄。請使用 | ALL |
SourceCidrIpdeprecated | string | 否 | 已廢棄。請使用 | 10.0.0.0/8 |
Ipv6SourceCidrIpdeprecated | string | 否 | 已廢棄。請使用 | 2001:db8:1234:1a00::*** |
SourceGroupIddeprecated | string | 否 | 已廢棄。請使用 | sg-bp67acfmxa123b**** |
SourcePrefixListIddeprecated | string | 否 | 已廢棄。請使用 | pl-x1j1k5ykzqlixdcy**** |
PortRangedeprecated | string | 否 | 已廢棄。請使用 | 1/200 |
DestCidrIpdeprecated | string | 否 | 已廢棄。請使用 | 10.0.0.0/8 |
Ipv6DestCidrIpdeprecated | string | 否 | 已廢棄。請使用 | 2001:db8:1233:1a00::*** |
SourcePortRangedeprecated | string | 否 | 已廢棄。請使用 | 80/80 |
SourceGroupOwnerAccountdeprecated | string | 否 | 已廢棄。請使用 | Test@aliyun.com |
SourceGroupOwnerIddeprecated | long | 否 | 已廢棄。請使用 | 12345678910 |
NicTypedeprecated | string | 否 | 已廢棄。請使用 | intranet |
Descriptiondeprecated | string | 否 | 已廢棄。請使用 | This is description. |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidSecurityGroupId.Malformed | The specified parameter SecurityGroupId is not valid. | 指定的參數(shù) SecurityGroupId 無效。 |
| 400 | InvalidIpProtocol.ValueNotSupported | The parameter IpProtocol must be specified with case insensitive TCP, UDP, ICMP, GRE or All. | 協(xié)議類型只能是TCP、UDP、ICMP、GRE或者All。 |
| 400 | InvalidIpPortRange.Malformed | The specified parameter PortRange is not valid. | IP協(xié)議相關的端口號范圍格式不正確。 |
| 400 | InvalidSourceCidrIp.Malformed | The specified parameter SourceCidrIp is not valid. | 源 IP 地址范圍參數(shù)格式不正確。 |
| 400 | MissingParameter | The input parameter SourceGroupId or SourceCidrIp cannot be both blank. | 參數(shù) SourceGroupId 和 SourceCidrIp 不能同時為空。 |
| 400 | InvalidPolicy.Malformed | The specified parameter %s is not valid. | 指定的授權策略參數(shù)Policy不合法。 |
| 400 | InvalidNicType.ValueNotSupported | The specified parameter %s is not valid. | 指定的網(wǎng)卡類型參數(shù)NicType不合法。 |
| 400 | InvalidSourceGroupId.Mismatch | Specified security group and source group are not in the same VPC. | 指定的安全組和源安全組不在一個 VPC 內(nèi)。 |
| 400 | MissingParameter.Source | One of the parameters SourceCidrIp, Ipv6SourceCidrIp, SourceGroupId or SourcePrefixListId in %s must be specified. | 至少需要指定參數(shù)SourceCidrIp、SourceGroupId或SourcePrefixListId中的一個。 |
| 400 | InvalidParam.PortRange | The specified parameter %s is not valid. It should be two integers less than 65535 in ?/? format. | 端口范圍不合法，應為斜線分隔兩個整數(shù)的格式。 |
| 400 | InvalidIpProtocol.ValueNotSupported | The parameter %s must be specified with case insensitive TCP, UDP, ICMP, GRE or All. | 協(xié)議Protocol字段不合法，應指定大小寫不敏感的TCP，UDP，ICMP，GRE或All。 |
| 400 | InvalidPriority.Malformed | The parameter Priority is invalid. | 指定的參數(shù) Priority 無效。 |
| 400 | InvalidPriority.ValueNotSupported | The specified parameter %s is invalid. | 指定的優(yōu)先級參數(shù)Priority不合法。 |
| 400 | InvalidPriority.ValueNotSupported | The parameter Priority is invalid. | 指定的參數(shù) Priority 無效。 |
| 400 | InvalidParamter.Conflict | The specified SecurityGroupId should be different from the SourceGroupId. | 授權與被授權安全組必須不同。 |
| 400 | InvalidDestCidrIp.Malformed | The specified parameter DestCidrIp is not valid. | 指定的 DestCidrIp 無效，請您檢查該參數(shù)是否正確。 |
| 400 | InvalidParam.SourceIp | The Parameters SourceCidrIp and Ipv6SourceCidrIp in %s cannot be set at the same time. | 參數(shù)SourceCidrIp和Ipv6SourceCidrIp不能被同時設置。 |
| 400 | InvalidParam.DestIp | The Parameters DestCidrIp and Ipv6DestCidrIp in %s cannot be set at the same time. | 參數(shù)DestCidrIp和Ipv6DestCidrIp不能被同時設置。 |
| 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. | 安全組不能授權給企業(yè)級安全組。 |
| 400 | InvalidPortRange.Malformed | The specified parameter PortRange must set. | 參數(shù)PortRange必須被設置。 |
| 400 | InvalidSourcePortRange.Malformed | The specified parameter SourcePortRange is not valid. | 指定的參數(shù) SourcePortRange 無效。 |
| 400 | InvalidSecurityGroupDiscription.Malformed | The specified security group rule description is not valid. | 指定的安全組規(guī)則描述不合法。 |
| 400 | NotSupported.ClassicNetworkPrefixList | The prefix list is not supported when the network type of security group is classic. | 安全組的網(wǎng)絡類型為經(jīng)典網(wǎng)絡，不支持前綴列表。 |
| 400 | InvalidParam.SourceCidrIp | The specified parameter %s is not valid. | 指定的參數(shù)SourceCidrIp不合法。 |
| 400 | InvalidParam.SourceCidrIp | The specified param SourceCidrIp is not valid. | 參數(shù)SourceCidrIp不合法。 |
| 400 | InvalidParam.DestCidrIp | The specified parameter %s is not valid. | 指定的參數(shù)DestCidrIp不合法。 |
| 400 | InvalidParam.DestCidrIp | The specified parameter DestCidrIp is invalid. | 指定的參數(shù)“DestCidrIp”無效。 |
| 400 | InvalidParam.Permissions | The specified parameter Permissions cannot coexist with other parameters. | 指定的參數(shù)Permissions不能與其他參數(shù)同時存在。 |
| 400 | InvalidParam.DuplicatePermissions | There are duplicate permissions in the specified parameter Permissions. | 指定的參數(shù)Permissions中存在重復的規(guī)則。 |
| 400 | InvalidSecurityGroupId.NotFound | The specified parameter SecurityGroupId is not valid. | 指定的安全組在該用戶賬號下不存在，請您檢查安全組 id 是否正確。 |
| 400 | InvalidParam.SecurityGroupRuleId | The specified parameter SecurityGroupRuleId is not valid. | 指定的參數(shù)SecurityGroupRuleId不合法。 |
| 400 | InvalidParam.SecurityGroupRuleIdRepeated | The specified parameter SecurityGroupRuleId is repeated. | 指定的參數(shù)SecurityGroupRuleId存在重復。 |
| 400 | InvalidGroupParameter.OperationDenied | The attributes Policy, SourceGroupId, DestGroupId of enterprise level security groups are not allowed to be set or modified. | 企業(yè)級安全組不能指定Policy，SourceGroupId，DestGroupId等參數(shù)。 |
| 400 | InvalidSecurityGroupRule.RuleNotExist | The specified rule does not exist. | 指定的安全組規(guī)則不存在。 |
| 401 | InvalidOperation.SecurityGroupNotAuthorized | The specified security group is not authorized to operate. | 沒有權限操作當前安全組 |
| 403 | InvalidNicType.Mismatch | The specified NicType conflicts with the authorization record. | 指定的網(wǎng)卡類型與已有規(guī)則不匹配。 |
| 403 | InvalidGroupAuthItem.NotFound | Specified group authorized item does not exist in our records. | 指定的組授權條目不存在。 |
| 403 | InvalidOperation.ResourceManagedByCloudProduct | %s | 云產(chǎn)品托管的安全組不支持修改操作。 |
| 404 | InvalidSecurityGroupId.NotFound | The specified SecurityGroupId does not exist. | 指定的安全組在該用戶賬號下不存在，請您檢查安全組 ID 是否正確。 |
| 404 | InvalidSourceGroupId.NotFound | The SourceGroupId provided does not exist in our records. | 指定的入方向安全組不存在。 |
| 404 | InvalidPrefixListId.NotFound | The specified prefix list was not found. | 前綴列表不存在。 |
| 404 | InvalidSecurityGroupRuleId.NotFound | The specified SecurityGroupRuleId is not exists. | 指定的SecurityGroupRuleId不存在。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯誤，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-12-04 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-06-20 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-11-21 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-04-07 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-09-05 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-07-13 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2022-05-07 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |