tencent cloud

Feedback

SetRenewFlag

Last updated: 2022-04-07 11:38:12

1. API Description

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

This API is used to set auto-renewal for an instance.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: SetRenewFlag.
Version Yes String Common parameter. The value used for this API: 2019-01-07.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ResourceIds.N Yes Array of String ID of the instance to be manipulated
AutoRenewFlag Yes Integer Auto-Renewal flag

3. Output Parameters

Parameter Name Type Description
Count Integer Number of successfully manipulated instances
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Setting the auto-renewal flag

Input Example

https://cynosdb.tencentcloudapi.com/?Action=SetRenewFlag
&ResourceIds.0=cynosdbmysql-ins-xxxxxxx
&AutoRenewFlag=1
&<Common request parameters>

Output Example

{
  "Response": {
    "Count": 1,
    "RequestId": 123123123
  }
}

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.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
InternalError Internal error.
InternalError.DbOperationFailed Failed to query the database.
InternalError.OperationNotSupport Unsupported operation.
InternalError.QueryDatabaseFailed Failed to query the database.
InternalError.SystemError Internal system error.
InvalidParameterValue.ClusterNotFound No cluster found.
InvalidParameterValue.DBTypeNotFound Unsupported instance type.
InvalidParameterValue.IllegalInstanceName The instance name contains invalid characters.
InvalidParameterValue.InstanceNotFound The instance does not exist.
InvalidParameterValue.ParamError Incorrect parameter.
InvalidParameterValue.RegionZoneUnavailable The selected region and AZ are unavailable.
OperationDenied.ClusterOpNotAllowedError This operation is not allowed for the current cluster. Reason: {{1}}.
ResourceNotFound.ClusterNotFoundError The cluster ({{1}}) does not exist.
ResourceUnavailable.InstanceStatusAbnormal The instance is exceptional, so the operation cannot be performed temporarily.
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