ModifyAddressAttribute

Last updated: 2021-05-12 10:21:32

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API (ModifyAddressAttribute) is used to modify the name of an Elastic IP.

A maximum of 10 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: ModifyAddressAttribute.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
AddressId	Yes	String	The unique ID of the EIP, such as `eip-11112222`.
AddressName	No	String	The EIP name after modification. The maximum length is 20 characters.
EipDirectConnection	No	String	Whether the set EIP is a direct connection EIP. TRUE: yes. FALSE: no. Note that this parameter is available only to users who have activated the EIP direct connection function.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying EIP name

Input Example

https://vpc.tencentcloudapi.com/?Action=ModifyAddressAttribute
&AddressId=eip-p2x6wxc0
&AddressName=test_eip
&<Common request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidAddressId.Blocked	The specified EIP is in blocked status. When the EIP is in blocked status, it cannot be bound. You must first unblock it.
InvalidAddressId.NotFound	The specified EIP does not exist.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.TooLong	Invalid parameter value. The parameter value is too long.

Recent Pages