编辑单条安全组规则

最近更新时间:2024-11-22 16:44:05

我的收藏
说明:
当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

本接口(ModifySingleSecurityGroupPolicy)用于编辑单条安全组规则。 接口请求域名:dfw.api.qcloud.com
1. 规则描述
2. 安全组的每条规则最多可包含四个有效字段:ipProtocol、cidrIp 或 sgId(两者是排他关系,不允许同时输入)、portRange 和 action。action 字段是必需的,其他字段如果不出现,代表这条规则处理网络报文时,不考虑这个字段而全部匹配。
3. ipProtocol 字段支持输入 tcp、udp 和 icmp,不区分大小写。
4. cidrIp 字段允许输入符合 cidr 格式标准的任意字符串。(展开)在基础网络中,如果 cidrIp 包含您的账户内的云服务器之外的设备在腾讯云的内网 IP,并不代表此规则允许您访问这些设备,租户之间网络隔离规则优先于安全组中的内网规则。
5. sgId 字段允许输入与待修改的安全组位于相同项目中的安全组 ID,包括这个安全组 ID 本身,代表安全组下所有云服务器的内网 IP。使用这个字段时,这条规则用来匹配网络报文的过程中会随着被使用的这个 ID 所关联的云服务器变化而变化,不需要重新修改。
6. portRange 字段允许输入一个单独端口号,或者用减号分隔的两个端口号代表端口范围,例如80或8000-8010。只有当 ipProtocol 字段是 tcp 或 udp 时,portRange 字段才被接受。
7. action 字段允许输入 ACCEPT 或 DROP 字符串,不区分大小写。
8. desc 字段允许输入单条规则的描述语,不超过50个UTF-8字符。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的 Action 字段为ModifySingleSecurityGroupPolicy。
参数名称
必选
类型
描述
sgId
String
安全组 ID
version
Int
版本,用户更新安全规则,每次更新安全规则版本会自动加1,防止您更新的路由规则已过期,不填不考虑冲突
direction
String
方向(ingress/egress)
index
Int
规则所在位置,index从0开始,必须是编辑已有规则
policys
Array
安全组规则Array(Object),该Array的key为action等
policys 规则成员结构
参数名称
类型
描述
ipProtocol
String
网络协议,支持 udp、tcp、icmp 等,无则表示全协议
cidrIp
String
IP 网段地址,不传为全地址,和 sgId 互斥,一条规则中两参数都存在会报错
sgId
String
安全组 ID,和 cidrIp 互斥,一条规则中两参数都存在会报错
addressModule
String
IP 地址 ID 或者 IP 地址组 ID,和 cidrIp、sgId 互斥
portRange
String
端口,不传为不限端口
serviceModule
String
协议端口 ID 或者协议端口组 ID,和 ipProtocol+portRange 互斥
desc
String
规则描述
action
String
动作,accept 或者 drop

3. 输出参数

参数名称
类型
描述
code
Int
错误码, 0: 成功, 其他值: 失败
message
String
错误信息

4. 错误码表

错误码数值
原因
7000
安全组后台异常
7001
安全组不属于当前用户
7002
7002规则数量超过配额
7006
系统默认安全组禁止修改
9003
规则数据格式错误

5. 示例

输入
https://dfw.api.qcloud.com/v2/index.php?Action=ModifySingleSecurityGroupPolicy
&sgId=sg-33ocnj9n
&version=2
&direction=ingress
&index=0
&policys.ipProtocol=tcp
&policys.cidrIp=10.0.0.0/8
&policys.action=ACCEPT
&policys.portRange=22
&policys.desc=内网入流量tcp协议22端口允许访问
输出
{
"code": 0,
"message": ""
}