调用ModifyNatIpAttribute接口修改NAT IP地址的名称和描述。

使用说明

ModifyNatIpAttribute接口不支持并发修改同一个NAT IP地址的名称和描述。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String 是 eu-central-1

要修改的NAT IP地址所属NAT网关实例的地域ID。

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

NatIpId String 是 vpcnatip-gw8e1n11f44wpg****

要修改的NAT IP地址实例ID。
NatIpName String 是 newname

要修改的NAT IP地址的名称。

长度为2~128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。但不能以http://或https://开头。

NatIpDescription String 是 test

要修改的NAT IP地址的描述信息。

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

DryRun Boolean 否 false

是否只预检此次请求，取值：

  • true：发送检查请求，不会修改NAT IP地址的信息。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回2xx HTTP状态码并修改NAT IP地址的信息。
ClientToken String 否 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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

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

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
Action String 是 ModifyNatIpAttribute

系统规定参数。取值：ModifyNatIpAttribute。

返回数据

名称 类型 示例值 描述
RequestId String 6CC9456C-2E29-452A-9180-B6926E51B5CA

请求ID。

示例

请求示例

http(s)://[Endpoint]/?RegionId=eu-central-1
&NatIpId=vpcnatip-gw8e1n11f44wpg****
&NatIpName=newname
&NatIpDescription=test
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&Action=ModifyNatIpAttribute
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyNatIpAttributeResponse>
    <RequestId>6CC9456C-2E29-452A-9180-B6926E51B5CA</RequestId>
</ModifyNatIpAttributeResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6CC9456C-2E29-452A-9180-B6926E51B5CA"
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. 指定的RegionId不存在。

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