ModifyForwardEntry - 修改指定的DNAT条目

更新时间:
复制 MD 格式

调用ModifyForwardEntry接口修改指定的DNAT条目。

接口说明

  • ModifyForwardEntry 接口属于异步接口,即系统会先返回一个请求 ID,但 DNAT 条目并未修改完成,系统后台的修改任务仍在进行。您可以调用 DescribeForwardTableEntries 查询 DNAT 条目的状态:

    • 当 DNAT 条目处于 Pending 状态时,表示 DNAT 条目正在修改中,在该状态下,您只能执行查询操作,不能执行其他操作。

    • 当 DNAT 条目处于 Available 状态时,表示 DNAT 条目修改完成。

  • ModifyForwardEntry 接口在同一个 DNAT 条目下不支持并发修改指定的 DNAT 条目。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:ModifyForwardEntry

update

*ForwardTable

acs:vpc:{#regionId}:{#accountId}:forwardtable/{#ForwardTableId}

请求参数

名称

类型

必填

描述

示例值

ForwardTableId

string

DNAT 条目所属的 DNAT 列表的 ID。

ftb-8vbx8xu2lqj9qb334****

ForwardEntryId

string

要修改的 DNAT 条目的 ID。

fwd-8vbn3bc8roygjp0gy****

ExternalIp

string

  • 当修改公网 NAT 网关的 DNAT 条目时,该参数为提供公网访问的公网 IP 地址。

  • 当修改 VPC NAT 网关的 DNAT 条目时,该参数为供外部网络访问的 NAT IP 地址。

116.85.XX.XX

ExternalPort

string

  • 当修改公网 NAT 网关的 DNAT 条目时,该参数为 DNAT 条目中进行端口转发的外部端口或端口段。

    • 修改的端口范围需要在 1~65535 之间。

    • 如果需要修改端口段,请在输入时以正斜线(/)隔开起始端口,例如10/20

    • 如果需要同时修改 ExternalPortInternalPort,而且 ExternalPort 为端口段,则 InternalPort 也需要设置为端口段,且端口段的端口个数相同,例如 ExternalPort 设置为10/20InternalPort 设置为80/90

  • 当修改 VPC NAT 网关的 DNAT 条目时,该参数为被外部网络访问的端口,取值范围:1~65535

80

InternalIp

string

  • 当修改公网 NAT 网关的 DNAT 条目时,该参数为通过 DNAT 条目进行公网通信的 ECS 实例的私网 IP 地址。

  • 当修改 VPC NAT 网关的 DNAT 条目时,该参数为需要通过 DNAT 规则进行通信的私网 IP 地址。

10.0.0.78

InternalPort

string

  • 当修改公网 NAT 网关的 DNAT 条目时,该参数为 DNAT 条目中进行端口转发的内部端口或端口段,取值范围:1~65535

  • 当修改 VPC NAT 网关的 DNAT 条目时,该参数为需要映射的目标 ECS 实例端口,取值范围:1~65535

80

IpProtocol

string

协议类型,取值:

  • TCP:转发 TCP 协议的报文。

  • UDP:转发 UDP 协议的报文。

  • Any:转发所有协议的报文。

TCP

ForwardEntryName

string

修改后的 DNAT 条目名称。

长度为 2~128 个字符,必须以字母或中文开头,但不能以http://https://开头。

test

RegionId

string

NAT 网关所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

ClientToken

string

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明

若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。

123e4567-e89b-12d3-a456-426655440000

PortBreak

boolean

是否开启端口突破,取值:

  • true:开启端口突破。

  • false:不开启端口突破。当 DNAT 条目和 SNAT 条目使用同一个公网 IP 地址时,如果您需要配置大于1024的端口号,您需要指定PortBreaktrue

false

DryRun

boolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会修改 DNAT 条目。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接修改 DNAT 条目。

false

返回参数

名称

类型

描述

示例值

object

请求 ID。

RequestId

string

请求 ID。

2315DEB7-5E92-423A-91F7-4C1EC9AD97C3

示例

正常返回示例

JSON格式

{
  "RequestId": "2315DEB7-5E92-423A-91F7-4C1EC9AD97C3"
}

错误码

HTTP status code

错误码

错误信息

描述

400 UnsupportedFeature.PortSegment The feature of PortSegment is not supported.
400 ExclusiveParam.%sAnd%s The param of %s and %s are mutually exclusive. 参数 %s 和 %s 相互排斥。
400 InvalidIp.NotInNatgw The specified Ip not belong to natgateway.
400 DuplicatedParam.InternalPort The param of %s is duplicated. InternalPort参数重复或已被占用
400 DuplicatedParam.ExternalPort The param of %s is duplicated. DNAT公网端口%s已被重复占用。
400 OperationFailed.AnyPortConfig Operation failed because any port correspondence any protocol 操作失败. 与其他条目有冲突, 存在任何端口或任何协议类型.
400 OperationUnsupported.ForwardEntry Duplicated destination ip port is unsupported. 不支持重复的目标IP端口。
400 IncorrectStatus.NatIp The status of %s [%s] is incorrect. NatIp当前状态不正确。
400 Forbidden.IpHasBeenUsedInSnat The source ip can't be used. Because it has been used in snat.
400 IncorrectStatus.ForwardEntry The status of %s [%s] is incorrect. 要删除的DNAT条目实例状态不对
400 InvalidExternalIp.Malformed The specified ExternalIp is not a valid IP address.
400 InvalidInternalIp.Malformed The specified InternalIp is not a valid IP address.
400 InvalidExternalPort.Malformed The specified ExternalPort is not a valid port.
400 InvalidInternalPort.Malformed The specified InternalPort is not a valid port.
400 Forbidden.DestnationIpOutOfVpcCIDR The specified Destination Ip is Out of VPC CIDR.
400 InvalidProtocal.ValueNotSupported The specified IpProtocol does not support.
400 IncorretForwardEntryStatus Some Forward entry status blocked this operation..
400 QuotaExceeded Forward entry quota exceeded in this route table. 同一个路由表中自定义路由条目不能超过200条,可以在配额管理页面申请调整数量。
400 ForwardEntry.Duplicated The specified ExternalIp, IpProtocol, ExternalPort,InternalIp, InternalPort is duplicated
400 Forbidden.ExternalIp.UsedInSnatTable The specified ExternalIp is already used in SnatTable
400 Forbidden.Already.Bounded The specified instance already bounded
400 InvalidIp.NotFound The specified ip does not exist.
400 InvalidParameter.Name.Malformed The specified Name is not valid.
400 IncorretStatus.ForwardEntry The Specified forwardEntry is not stable status, can not operation
400 IllegalParam.AnyPortNotZero Any port port must be zero. 参数非法,DNAT转发协议为Any时,源端口和目标端口必须为0
400 Duplicated.DestinationPort The specified param DestinationPort is duplicated.
400 InvalidForwardEntryId.NotFound Specified forward entry ID does not exist
400 OperationUnsupported.EipInBinding Create snat entry with eip in associating status is unsupported. 创建snat不可以使用绑定中的eip
400 QuotaExceeded.ForwardEntrySessionManytoOne The dnat session quota is exceed. dnat session 多对一的配额超限。
400 OperationFailed.ForwardEntryNotAllowSrcIpEqualDstIp The source IP of forward entry is not allowed to equal destination IP. DNAT条目不允许公网IP地址等于私网IP地址
404 ResourceNotFound.NatIp The specified resource of %s is not found.
404 ResourceNotFound.ForwardEntry The specified resource of %s is not found. 找不到指定的%s资源。
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records.
404 InvalidForwardEntryId.NotFound Specified forward entry ID does not exist
404 InvalidExternalIp.NotFound Specified External Ip address does not found on the VRouter
404 InvalidForwardTableId.NotFound Specified forward table does not exist.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情