tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyAddressAttribute

Last updated: 2023-08-18 14:28:15

1. API Description

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

This API is used to modify EIP attributes.

A maximum of 20 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: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
EcmRegion Yes String ECM region
AddressId Yes String Unique EIP ID, such as eip-11112222.
AddressName No String New EIP name, which can contain up to 20 characters.
EipDirectConnection No String Whether "direct access" is enabled for the EIP. TRUE: yes. FALSE: no. Note that this parameter is available only to users who have activated the EIP direct access feature.

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 Renaming EIP

Input Example

https://ecm.tencentcloudapi.com/?Action=ModifyAddressAttribute
&AddressId=eip-11112222
&AddressName=test_eip
&EcmRegion=ap-hangzhou-ecm
&<Common request parameters>

Output Example

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

Example2 Modifying EIP direct access attributes

Input Example

https://ecm.tencentcloudapi.com/?Action=ModifyAddressAttribute
&AddressId=eip-11112222
&EipDirectConnection=FALSE
&EcmRegion=ap-hangzhou-ecm
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "ABCD0BEC-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
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.InvalidInstanceID The instance ID is invalid.
InvalidParameterValue.InvalidRegion The ECM region is invalid.
InvalidParameterValue.ParameterValueTooLarge The parameter value exceeds the limit.
InvalidParameterValue.TooLong The parameter value is too long.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
UnsupportedOperation.AddressIdNotFound The IP was not found.
UnsupportedOperation.Malformed Please check whether the provided IP address is complete.
UnsupportedOperation.StatusNotPermit This operation cannot be performed in the current status.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy