文档

ModifyNatIpAttribute - 修改NAT IP地址的名称和描述

更新时间:

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:ModifyNatIpAttributeWrite
  • NatGateway
    acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

eu-central-1
NatIpIdstring

要修改的 NAT IP 地址实例 ID。

vpcnatip-gw8e1n11f44wpg****
NatIpNamestring

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

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

newname
NatIpDescriptionstring

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

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

test
DryRunboolean

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

  • true:发送检查请求,不会修改 NAT IP 地址的信息。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 2xx HTTP 状态码并修改 NAT IP 地址的信息。

false
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
5A2CFF0E-5718-45B5-9D4D-70B3FF3898

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

6CC9456C-2E29-452A-9180-B6926E51B5CA

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。
404ResourceNotFound.NatIpThe specified resource of NatIp is not found.-

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

变更历史

变更时间变更内容概要操作
2024-01-25OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:404
2023-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
  • 本页导读 (1)