tencent cloud

Cloud Virtual Machine

Release Notes and Announcements
Release Notes
Public Image Release Notes
Official End of Support Plan for the Operating System
Announcements
Product Introduction
CVM Overview
Strengths
Basic Concepts
Regions and Zones
Tutorial
Service Regions and Service Providers
Billing
Billing Overview
Billing Modes
Billing Items
Billing Mode Conversion Overview
Purchasing Instances
Configuration Adjustment Billing Guide
Overdue Payments
Getting Started
Purchasing a Customized Linux Instance
Purchasing a Customized Windows Instance
User Guide
Operation Guide Overview
Use Limits
Instances
Spot Instances
Reserved Instances
Images
Storage
Backup and Restoration
Network
Security
Passwords/Keys
Monitoring and Alarms
Ops Management
Convenience Features
Migrating a Server
Online Migration
Migration Consultation
Troubleshooting
CVM Login Failures
Windows Instance Login Failures
Linux Instance Login Failures
Other Login Failures
Instance Running Failures
Linux Instance Memory Failures
Network Failures
Use Cases
Suggestions on CVM Model Selection
Environment Building
Website Building
Application Building
Visual GUI Building
Uploading Local Files to CVM
Network Performance Test
Other Practical Tutorials
API Documentation
History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Security and Compliance
CAM
Network
FAQs
Regions and Zones
Billing
Instances
Storage
Images
Server Migration
Network
Security
Operating Systems
Ops and Monitoring
CAM
NTP Service
Scenarios
Agreements
CVM Service Level Agreements
Red Hat Enterprise Linux Image Service Agreement
Public IP Service Level Agreement
Glossary

ModifyInstancesRenewFlag

PDF
Focus Mode
Font Size
Last updated: 2025-11-13 10:53:35

1. API Description

Domain name for API request: cvm.intl.tencentcloudapi.com.

This API is used to modify the renewal flag of monthly subscription instances.

  • After an instance is marked as auto-renewal, it will be automatically renewed for one month each time it expires.
  • Batch operations are supported. The maximum number of instances for each request is 100.* You can query the result of the instance operation by calling the API DescribeInstances. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.

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: ModifyInstancesRenewFlag.
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-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceIds.N Yes Array of String For one or more instance IDs to be operated. You can obtain the instance ID through the instanceid in the returned value from the API DescribeInstances. The maximum number of instances that can be operated for each request is 100.
RenewFlag Yes String Auto-renewal flag. Valid values:
  • NOTIFY_AND_AUTO_RENEW: Notifies of expiration and performs auto-renewal.
  • NOTIFY_AND_MANUAL_RENEW: Notifies of expiration but does not perform auto-renewal.
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: Not notifies of expiration nor perform auto-renewal.

  • If this parameter is specified to NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis after it expires when there is sufficient account balance.

    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 Modifying the Renewal Flags of Two Instances

    This example shows you how to modify the renewal tags of two instances.

    Input Example

    POST / HTTP/1.1
    Host: cvm.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyInstancesRenewFlag
    <Common request parameters>
    
    {
        "InstanceIds": [
            "ins-r8hr2upy",
            "ins-5d8a23rs"
        ],
        "RenewFlag": "NOTIFY_AND_AUTO_RENEW"
    }

    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
    FailedOperation.InvalidInstanceApplicationRoleEmr The EMR instance ins-xxxxxxxx does not support this operation.
    InternalServerError Internal error.
    InvalidInstance.NotSupported This instance is not supported.
    InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
    InvalidInstanceId.NotFound No instance found.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    MutexOperation.TaskRunning An identical job is running.
    OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
    UnauthorizedOperation.MFAExpired Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid.
    UnauthorizedOperation.MFANotFound Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists.
    UnsupportedOperation.InstanceChargeType This instance billing mode does not support the operation.
    UnsupportedOperation.InstanceReinstallFailed The current instance is in a failed OS reinstallation state and does not support this operation. We recommend reinstalling the operating system again. Alternatively, you may terminate/return the instance or submit a support ticket.
    UnsupportedOperation.InstanceStateBanning This CVM is blocked. Please submit a ticket.
    UnsupportedOperation.InstanceStateEnterRescueMode Instances are entering the rescue mode, and this operation is not supported.
    UnsupportedOperation.InstanceStateExitRescueMode Instances are exiting from the rescue mode, and this operation is not supported.
    UnsupportedOperation.InstanceStateFreezing The operation is not supported for the frozen instances.
    UnsupportedOperation.InstanceStateIsolating Unable to isolate: the instance is isolated
    UnsupportedOperation.InstanceStatePending The instances are being created, and this operation is not supported.
    UnsupportedOperation.InstanceStateRebooting The instances are being restarted, and this operation is not supported.
    UnsupportedOperation.InstanceStateRescueMode Instances in the rescue mode are not available for this operation.
    UnsupportedOperation.InstanceStateServiceLiveMigrate The instances are being migrated, and this operation is not supported.
    UnsupportedOperation.InstanceStateShutdown Isolated instances do not support this operation.
    UnsupportedOperation.InstanceStateStarting The instance is starting up, and this operation is not supported.
    UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
    UnsupportedOperation.SpecialInstanceType This special instance type does not support the operation.
    UnsupportedOperation.UnderwritingInstanceTypeOnlySupportAutoRenew For an underwriting instance, RenewFlag can only be set to NOTIFY_AND_AUTO_RENEW.

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback