ModifySecurityGroupRuleDescriptionsEgress--私有网络-火山引擎

文档中心

立即注册

导航

ModifySecurityGroupRuleDescriptionsEgress

最近更新时间：2024.11.15 09:39:38首次发布时间：2021.07.29 14:11:53

调用 ModifySecurityGroupRuleDescriptionsEgress 接口，修改安全组出方向规则的描述信息。

调用说明

传入多个请求参数，确认唯一满足条件的安全组出方向规则，修改其描述信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	ModifySecurityGroupRuleDescriptionsEgress	系统规定参数。取值：ModifySecurityGroupRuleDescriptionsEgress。
Version	String	是	2020-04-01	API版本信息，取值为：2020-04-01。
SecurityGroupId	String	是	sg-bp67acfmxazb4p****	安全组ID。您可以调用 DescribeSecurityGroups 接口，查询安全组的ID。
Protocol	String	是	all	协议类型。取值如下： tcp：TCP协议。 udp：UDP协议。 icmp：ICMP协议。 icmpv6：ICMPV6协议。说明 IPv6功能正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。 all：支持所有协议。
PortStart	Integer	是	22	端口范围开始值。当`Protocol` 传入tcp或udp时，取值范围为1~65535。当`Protocol` 传入icmp、icmpv6或all时，仅支持传入-1，表示不限制端口。
PortEnd	Integer	是	22	端口范围结束值。当`Protocol` 传入tcp或udp时，取值范围为1~65535。当`Protocol` 传入icmp、icmpv6或all时，仅支持传入-1，表示不限制端口。
CidrIp	String	否	10.XX.XX.0/8	目的地址的IPv4 CIDR或IPv6 CIDR。说明参数`CidrIp`、`SourceGroupId`和 `PrefixListId`，三者必须传入一个。若传入多个，仅生效一个，生效的优先级为`CidrIp` > `SourceGroupId` > `PrefixListId`。
SourceGroupId	String	否	sg-bp67acfmxazb4p****	目的地址安全组ID。即该安全组中的所有网卡的地址作为目的地址。说明参数`CidrIp`、`SourceGroupId`和 `PrefixListId`，三者必须传入一个。若传入多个，仅生效一个，生效的优先级为`CidrIp` > `SourceGroupId` > `PrefixListId`。
PrefixListId	String	否	pl-bp1fg655nh68xyz9****	目的地址前缀列表的ID。即前缀列表中的CIDR均为目的地址。您可以调用 DescribePrefixLists 接口，查询前缀列表的ID。说明当前安全组还可添加出方向安全组规则的数量不小于前缀列表最大条目数。参数`CidrIp`、`SourceGroupId`和 `PrefixListId`，三者必须传入一个。若传入多个，仅生效一个，生效的优先级为`CidrIp` > `SourceGroupId` > `PrefixListId`。
Policy	String	否	accept	访问策略。即安全组内的网卡访问`CidrIp` 、`SourceGroupId` 或 `PrefixListId` 对应的资源。 accept：允许。 drop：拒绝。
Priority	Integer	否	1	安全组规则优先级，数字越小，代表优先级越高。取值范围：1 ~ 100
Description	String	否	S_G_R_E_Description	安全组规则的描述信息。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为1 ~ 255个字符。不填保持原有配置。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。

请求示例

GET /?Action=ModifySecurityGroupRuleDescriptionsEgress&Version=2020-04-01&SecurityGroupId=sg-bp67acfmxazb4p****&Protocol=tcp&PortStart=22&PortEnd=22&CidrIp=10.XX.XX.0/8&Policy=accept&Priority=1&Description=S_G_R_E_Description  HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "ModifySecurityGroupRuleDescriptionsEgress",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
   "Result": {
        "RequestId": "2021062415303301022514515207C4****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidCidr.Malformed	The specified cidr block is malformed.	指定的网段格式不合法。
400	InvalidCidr.ProtocolMismatch	The specified cidr block mismatch the protocol type.	指定的网段格式和协议类型不匹配。
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidRouteCidr.Malformed	The specified CIDR is malformed.	指定的网段不合法。
400	InvalidSecurityGroup.InvalidStatus	The specified security group is not in the correct status for the request.	指定的安全组所处的状态无法响应该请求。
400	InvalidSecurityGroup.VpcMismatch	The specified source security group is not in the specified VPC.	指定的引用安全组不在指定的VPC中。
400	InvalidSecurityRule.InvalidSourceStatus	The specified source security group is not in the correct status for the request.	指定安全组规则对应的源安全组所处的状态无法响应该请求。
400	InvalidSecurityRulePolicy.Malformed	The specified security rule policy is malformed.	指定的安全组规则的行为不合法。
400	InvalidSecurityRulePort.Malformed	The specified security rule port is malformed.	指定的安全组规则的端口不合法。
400	InvalidSecurityRulePriority.Malformed	The specified security rule priority is malformed.	指定的安全组规则的优先级不合法。
400	InvalidSecurityRuleProtocol.Malformed	The specified security rule protocol is malformed.	指定的安全组规则的协议不合法。
403	Forbidden	You are not authorized to perform operations on the specified security group. The specified security group is a service-managed security group.	无权限对指定安全组进行操作。指定的安全组为云产品托管的安全组。
404	InvalidPrefixList.NotFound	The specified prefix list does not exist.	指定的前缀列表不存在。
404	InvalidSecurityGroupId.NotFound	The specified security group does not exist.	指定的安全组不存在。