有奖捉虫:云通信与企业服务文档专题,速来> HOT
文档中心 > API 中心 > 私有网络 > 安全组相关接口 > 修改安全组出站和入站规则

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(ModifySecurityGroupPolicies)用于重置安全组出站和入站规则(SecurityGroupPolicy)。

  • 该接口不支持自定义索引 PolicyIndex。
  • 在 SecurityGroupPolicySet 参数中:
    • 如果指定 SecurityGroupPolicySet.Version 为0, 表示清空所有规则,并忽略 Egress 和 Ingress。
    • 如果指定 SecurityGroupPolicySet.Version 不为0, 在添加出站和入站规则(Egress 和 Ingress)时:
      • Protocol 字段支持输入 TCP, UDP, ICMP, ICMPV6, GRE, ALL。
      • CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。在基础网络中,如果 CidrBlock 包含您的账户内的云服务器之外的设备在腾讯云的内网 IP,并不代表此规则允许您访问这些设备,租户之间网络隔离规则优先于安全组中的内网规则。
      • Ipv6CidrBlock 字段允许输入符合 IPv6 cidr 格式标准的任意字符串。在基础网络中,如果Ipv6CidrBlock 包含您的账户内的云服务器之外的设备在腾讯云的内网 IPv6,并不代表此规则允许您访问这些设备,租户之间网络隔离规则优先于安全组中的内网规则。
      • SecurityGroupId 字段允许输入与待修改的安全组位于相同项目中的安全组 ID,包括这个安全组 ID 本身,代表安全组下所有云服务器的内网 IP。使用这个字段时,这条规则用来匹配网络报文的过程中会随着被使用的这个ID所关联的云服务器变化而变化,不需要重新修改。
      • Port 字段允许输入一个单独端口号,或者用减号分隔的两个端口号代表端口范围,例如80或8000-8010。只有当 Protocol 字段是 TCP 或 UDP 时,Port 字段才被接受。
      • Action 字段只允许输入 ACCEPT 或 DROP。
      • CidrBlock, Ipv6CidrBlock, SecurityGroupId, AddressTemplate 四者是排他关系,不允许同时输入,Protocol + Port 和 ServiceTemplate 二者是排他关系,不允许同时输入。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifySecurityGroupPolicies。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
SecurityGroupId String 安全组实例ID,例如sg-33ocnj9n,可通过DescribeSecurityGroups获取。
示例值:sg-ohuuioma
SecurityGroupPolicySet SecurityGroupPolicySet 安全组规则集合。 SecurityGroupPolicySet对象必须同时指定新的出(Egress)入(Ingress)站规则。 SecurityGroupPolicy对象不支持自定义索引(PolicyIndex)。
示例值:ppm-f5n1f8da
SortPolicys Boolean 排序安全组标识,默认值为False。当SortPolicys为False时,不改变安全组规则排序;当SortPolicys为True时,系统将严格按照SecurityGroupPolicySet参数传入的安全组规则及顺序进行重置,考虑到人为输入参数可能存在遗漏风险,建议通过控制台对安全组规则进行排序。
示例值:False

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改安全组出站和入站规则

修改安全组出站和入站规则

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityGroupPolicies
<公共请求参数>

{
    "SecurityGroupId": "sg-ohuuioma",
    "SecurityGroupPolicySet": {
        "Ingress": [
            {
                "Action": "accept",
                "AddressTemplate": {
                    "AddressGroupId": "ipmg-2uw6ujo6",
                    "AddressId": "ipm-2uw6ujo6"
                },
                "ServiceTemplate": {
                    "ServiceGroupId": "ppmg-f5n1f8da",
                    "ServiceId": "ppm-f5n1f8da"
                },
                "PolicyDescription": "Test"
            }
        ],
        "Egress": [
            {
                "Action": "accept",
                "AddressTemplate": {
                    "AddressGroupId": "ipmg-2uw6ujo6",
                    "AddressId": "ipm-2uw6ujo6"
                },
                "ServiceTemplate": {
                    "ServiceGroupId": "ppmg-f5n1f8da",
                    "ServiceId": "ppm-f5n1f8da"
                },
                "PolicyDescription": "TestPolicy"
            }
        ]
    }
}

输出示例

{
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.ModuleError 内部模块错误。
InvalidParameter.Coexist 参数不支持同时指定。
InvalidParameterValue.Empty 缺少参数。
InvalidParameterValue.LimitExceeded 参数值超出限制。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.MemberApprovalApplicationIdMismatch 指定审批单号和资源不匹配。
InvalidParameterValue.MemberApprovalApplicationNotApproved 流程服务审批单未审批。
InvalidParameterValue.MemberApprovalApplicationRejected 流程服务审批单被拒绝。
InvalidParameterValue.MemberApprovalApplicationStarted 该请求需要走BPAAS流程服务审批,当前发起审批中。
InvalidParameterValue.Range 参数值不在指定范围。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
LimitExceeded 超过配额限制。
ResourceNotFound 资源不存在。
UnsupportedOperation.ClbPolicyExceedLimit 负载均衡的安全组规则已达到上限。
UnsupportedOperation.DuplicatePolicy 安全组规则重复。
UnsupportedOperation.LockedResources 资源被锁定。