tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Lighthouse
    Documentation
    Download PDF

    ModifyInstancesRenewFlag

    Last updated: 2023-12-04 16:31:57
    Download PDF

      1. API Description

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

      This API is used to change the auto-renewal setting of monthly-subscribed instances.

      • Instances with auto-renewal enabled are automatically renewed on a monthly basis upon the expiration.
      • Batch operations are supported. Up to 100 instances per request is allowed.

      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: ModifyInstancesRenewFlag.
      Version Yes String Common Params. The value used for this API: 2020-03-24.
      Region No String Common Params. This parameter is not required for this API.
      InstanceIds.N Yes Array of String Instance ID list. Each request can contain up to 100 instances at a time. You can get an instance ID from the InstanceId returned by the DescribeInstances API.
      RenewFlag Yes String Auto-Renewal flag. Valid values:
    • NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically
    • NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically
    • DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically

      If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed monthly if the account balance is sufficient.
      		•

      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 auto-renewal setting of Lighthouse instances

      This example shows you how to change the auto-renewal setting of Lighthouse instances.

      Input Example

      https://lighthouse.tencentcloudapi.com/?Action=ModifyInstancesRenewFlag 
&InstanceIds.0=lhins-ruy9d2tw 
&RenewFlag=NOTIFY_AND_AUTO_RENEW 
&<Common request parameters>

      Output Example

      {
    "Response": {
        "RequestId": "4804b3a2-0c0f-4900-a39a-76885a17d4bb"
    }
}

      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.DescribeInstanceStatus An error occurred when querying the instance status.
      FailedOperation.RequestError A request error occurred.
      FailedOperation.TradeCallBillingGatewayFailed Failed to call the billing gateway service. Please try again later.
      InternalError.TradeCallBillingGatewayFailed Failed to call billing gateway service
      InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
      InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
      InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
      ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
      ResourceNotFound.InstanceNotFound The instance does not exist.
      UnauthorizedOperation.NoPermission No permission
      UnsupportedOperation Unsupported operation.
      UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
      UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy