tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AdjustPublicAddress

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

1. API Description

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

This API is used to change the public IP of a CVM or the EIP of the associated bandwidth package.

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: AdjustPublicAddress.
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.
InstanceId No String The unique ID of the CVM instance, such as ins-11112222.
AddressId No String The unique ID of the EIP, such as eip-11112222.

3. Output Parameters

Parameter Name Type Description
TaskId Integer The async task ID. You can use the DescribeTaskResult API to query the task status.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Changing the public IP

This example show you how to change the public IP of a CVM instance.

Input Example

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

{
    "InstanceId": "ins-1vogaxgk"
}

Output Example

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

Example2 Changing the EIP bound with a monthly bandwidth package

This example show you how to change the EIP bound with a monthly bandwidth package.

Input Example

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

{
    "AddressId": "eip-oy67r5oi"
}

Output Example

{
    "Response": {
        "TaskId": 5312621,
        "RequestId": "6AF60BEC-0142-43AF-CB20-276271FB54A7"
    }
}

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
InvalidAccount.NotSupported This account is not supported.
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.
InvalidInstanceId.NotFound Invalid instance ID. The specified instance ID does not exist.
InvalidParameterValue.AddressAttacked Attacked IP address.
InvalidParameterValue.AddressIpNotAvailable The IP address is not available now.
InvalidParameterValue.AddressNotFound Unable to find the address.
InvalidParameterValue.Combination Invalid input parameters
InvalidParameterValue.InstanceHasNoWanIP The instance does not have a public IP.
InvalidParameterValue.InstanceIdMalformed Incorrect instance ID.
InvalidParameterValue.InstanceNoWanIP Request failed: this instance does not have a WanIP (public IP).
InvalidParameterValue.ResourceNotSupport The resource does not support this operation.
InvalidParameterValue.UnavailableZone This availability zone is unavailable.
LimitExceeded.ChangeAddressQuota Run out of the chances to change the IP.
LimitExceeded.DailyChangeAddressQuota Run out of the daily chances to change the IP.
OperationDenied.AddressInArrears The specified public IP is isolated.
OperationDenied.MutexTaskRunning Mutually exclusive tasks are executing.
ResourceInsufficient Insufficient resources.
UnsupportedOperation.AddressStatusNotPermit This operation is not supported by the IP address status.
UnsupportedOperation.InvalidAddressInternetChargeType This operation is not allowed under the network billing mode of the IP address.
UnsupportedOperation.IspNotSupported This ISP does not support this operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy