tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyAddressAttribute

Last updated: 2023-08-23 14:11:34

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.

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 Params. The value used for this API: ModifyAddressAttribute.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
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 the EIP name

This example shows you how to modify the name of an EIP

Input Example

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAddressAttribute
<Common request parameters>

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

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

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.AddressIdMalformed This IP address ID is invalid.
InvalidParameterValue.AddressNotFound Unable to find the address.
InvalidParameterValue.ResourceNotExisted The resource is not associated with this bandwidth package.
InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
OperationDenied.MutexTaskRunning Mutually exclusive tasks are executing.
UnsupportedOperation.AddressStatusNotPermit This operation is not supported by the IP address status.
UnsupportedOperation.IncorrectAddressResourceType This type of address does not support this operation.
UnsupportedOperation.ModifyAddressAttribute The account does not support modifying this attribute of the public IP.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy