ModifyNatIpAttributes--NAT网关-火山引擎

文档中心

立即注册

导航

ModifyNatIpAttributes

最近更新时间：2024.07.16 19:49:34首次发布时间：2023.11.07 08:15:17

调用 ModifyNatIpAttributes 接口，修改中转IP名称和描述。

说明

私网NAT网关正在邀测中，如需试用，请联系客户经理。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	ModifyNatIpAttributes	要执行的操作，取值：ModifyNatIpAttributes。
Version	String	是	2020-04-01	API的版本信息，当前版本为：2020-04-01。
NatIpId	String	是	vpcnatip-gw8y7q3cpk3fggs87****	中转IP的ID。
NatIpName	String	否	nat_ip_1	中转IP的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。
NatIpDescription	String	否	natip-1	中转IP的描述。长度限制为0~ 255个字符。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。

返回数据

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

请求示例

GET /?Action=ModifyNatIpAttributes&Version=2020-04-01&NatIpId=vpcnatip-gw8y7q3cpk3fggs87****&NatIpName=nat_ip_1 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: natgateway
Region: cn-beijing

返回示例

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

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	InvalidNatGateway.InvalidStatus	The specified NAT gateway is not in the correct status for the request.	指定的NAT网关所处的状态无法响应该请求。
404	InvalidNatIp.NotFound	The specified nat ip does not exist.	指定的NAT IP不存在。
409	InvalidOperation.Conflict	The specified resource operation conflicts.	指定的资源操作冲突。