tencent cloud

Feedback

ModifyInstancesRenewFlag

Last updated: 2022-09-26 17:00:19

1. API Description

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

This API is used to modify the renewal flags of monthly subscribed instances.

  • Instances marked with "auto-renewal" will be automatically renewed for one month when they expire.
  • Batch operations are supported. The maximum number of instances in each request is 100.
  • The result of the instance operation can be queried by calling the DescribeInstances API. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.

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 Yes String Common Params. For more information, please see the list of regions supported by the product.
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 renewal flags of 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
    InternalError.TradeCallBillingGatewayFailed Failed to call billing gateway service
    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.

    Technical Support

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

    7x24 Phone Support