1. 接口描述
接口请求域名: ecm.tencentcloudapi.com 。
修改弹性公网IP属性
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyAddressAttribute。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EcmRegion | 是 | String | ECM 地域 |
AddressId | 是 | String | 标识 EIP 的唯一 ID。EIP 唯一 ID 形如:eip-11112222。 |
AddressName | 否 | String | 修改后的 EIP 名称。长度上限为20个字符。 |
EipDirectConnection | 否 | String | 设定EIP是否直通,"TRUE"表示直通,"FALSE"表示非直通。注意该参数仅对EIP直通功能可见的用户可以设定。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改EIP名称
输入示例
https://ecm.tencentcloudapi.com/?Action=ModifyAddressAttribute
&AddressId=eip-11112222
&AddressName=test_eip
&EcmRegion=ap-hangzhou-ecm
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
示例2 修改EIP 直通属性
输入示例
https://ecm.tencentcloudapi.com/?Action=ModifyAddressAttribute
&AddressId=eip-11112222
&EipDirectConnection=FALSE
&EcmRegion=ap-hangzhou-ecm
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "ABCD0BEC-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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.InternalOperationFailure | 内部操作错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidInstanceID | 实例ID不合法。 |
InvalidParameterValue.InvalidRegion | ecm region不合法。 |
InvalidParameterValue.ParameterValueTooLarge | 参数值超出限制。 |
InvalidParameterValue.TooLong | 参数值太长。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |
UnsupportedOperation.AddressIdNotFound | 未找到相关IP。 |
UnsupportedOperation.Malformed | 请确认提供的IP地址是否完整。 |
UnsupportedOperation.StatusNotPermit | 当前状态不能进行此操作。 |