修改弹性公网IP属性

最近更新时间:2020-07-13 08:54:04

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口 (ModifyAddressAttribute) 用于修改弹性公网IP(简称 EIP)的名称。

默认接口请求频率限制:10次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyAddressAttribute。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
AddressId String 标识 EIP 的唯一 ID。EIP 唯一 ID 形如:eip-11112222
AddressName String 修改后的 EIP 名称。长度上限为20个字符。
EipDirectConnection String 设定EIP是否直通,"TRUE"表示直通,"FALSE"表示非直通。注意该参数仅对EIP直通功能可见的用户可以设定。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改EIP名称

输入示例

https://vpc.tencentcloudapi.com/?Action=ModifyAddressAttribute
&AddressId=eip-p2x6wxc0
&AddressName=test_eip
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidAddressId.NotFound 指定的EIP不存在。
InvalidParameterValue 参数值不合法。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
目录