tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyAddressesRenewFlag

Last updated: 2024-10-31 10:37:37

1. API Description

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

This API is used to adjust the renewal flag for the monthly subscription EIP.

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: ModifyAddressesRenewFlag.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
AddressIds.N Yes Array of String List of unique EIP IDs, for example, eip-xxxx.
RenewFlag Yes String Auto-renewal flag.

  • NOTIFY_AND_AUTO_RENEW: Notify upon expiration and automatically renew.
  • NOTIFY_AND_MANUAL_RENEW: Notify upon expiration but do not automatically renew.
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: Do not notify upon expiration and do not automatically renew.


If this parameter is set to NOTIFY_AND_AUTO_RENEW and the account balance is sufficient, the instance will be automatically renewed on a monthly basis after expiration.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Adjusting the Renewal Flag for the Monthly Subscription EIP

Adjusting the Renewal Flag for the Monthly Subscription EIP

Input Example

https://vpc.tencentcloudapi.com/?Action=ModifyAddressesRenewFlag
&AddressIds.0=eip-cpfph9t4
&RenewFlag=NOTIFY_AND_MANUAL_RENEW
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "c89a8c84-6943-45ad-9342-36f599d77754"
    }
}

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
InvalidParameterValue The parameter value is invalid.
InvalidParameterValue.AddressIdMalformed This IP address ID is invalid.
InvalidParameterValue.AddressNotFound Unable to find the address.
InvalidParameterValue.ResourceNotSupport The resource does not support this operation.
UnsupportedOperation.AddressStatusNotPermit This operation is not supported by the IP address status.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy