私有网络修改弹性公网IP属性

1. 接口描述

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

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

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

推荐使用 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`。可以使用DescribeAddresses接口获取AddressId。示例值：eip-p2x6wxc0
AddressName	否	String	修改后的 EIP 名称。长度上限为128个字符，允许使用大小写字母、汉字、数字、连字符"-"和下划线"_"，不能包含空格。示例值：test_eip
EipDirectConnection	否	String	设定EIP是否直通，"TRUE"表示直通，"FALSE"表示非直通。注意：该参数仅对 EIP 直通功能可见的用户可以设定，EIP 必须为绑定状态，绑定的对象为 CVM 。示例值：FALSE

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改EIP名称

修改EIP名称。

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAddressAttribute
<公共请求参数>

{
    "AddressName": "test_eip",
    "AddressId": "eip-p2x6wxc0"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidAddressId.Blocked	指定EIP处于被封堵状态。当EIP处于封堵状态的时候是不能够进行绑定操作的，需要先进行解封。
InvalidAddressId.NotFound	指定的EIP不存在。
InvalidParameter.Conflict	指定的两个参数冲突，不能同时存在。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.AddressAlreadyHasPassThrough	指定的EIP已开启直通开关，无法再次开启
InvalidParameterValue.AddressIdMalformed	该地址ID不合法。
InvalidParameterValue.AddressNotFound	未找到该地址。
InvalidParameterValue.InstanceDoesNotSupportEipVisibleOnEni	实例不支持在网卡上显示EIP。支持的实例ID格式为 ins-xxxxxxxx 和 eks-xxxxxxxx
InvalidParameterValue.InstanceVpcDoesNotSupportEipVisibleOnEni	实例所属的VPC不支持在网卡上显示EIP
InvalidParameterValue.PrivateIpAddressDoesNotSupportEipVisibleOnEni	私网IP是一个辅助IP，不支持其绑定的EIP在网卡上显示
InvalidParameterValue.ResourceNotExisted	该资源不在此带宽包中。
InvalidParameterValue.TooLong	无效参数值。参数值太长。
OperationDenied.MutexTaskRunning	互斥的任务正在执行。
RequestLimitExceeded	请求的次数超过了频率限制。
UnsupportedOperation.AddressStatusNotPermit	该地址状态不支持此操作。
UnsupportedOperation.IncorrectAddressResourceType	该种类型地址不支持此操作。
UnsupportedOperation.ModifyAddressAttribute	账户不支持修改公网IP的该属性。

修改弹性公网IP属性

本页目录：