tencent cloud



Last updated: 2022-09-19 17:20:04

1. API Description

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

This API (ModifyInstanceParam) is used to modify instance parameters.

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: ModifyInstanceParam.
Version Yes String Common Params. The value used for this API: 2017-03-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceIds.N Yes Array of String List of short instance IDs.
ParamList.N No Array of Parameter List of parameters to be modified. Every element is a combination of Name (parameter name) and CurrentValue (new value).
TemplateId No Integer Template ID. At least one of ParamList and TemplateId must be passed in.
WaitSwitch No Integer When to perform the parameter adjustment task. Default value: 0. Valid values: 0 - execute immediately, 1 - execute during window. When its value is 1, only one instance ID can be passed in (i.e., only one InstanceIds can be passed in).

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async task ID, which can be used to query task progress.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying instance parameters

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "AsyncRequestId": "38265324-dd030463-3d46a793-4a0420b1"

5. Developer Resources


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
AuthFailure CAM signature/authentication error.
CdbError.DatabaseError Backend database error.
CdbError.TaskError Backend task error.
InternalError.DatabaseAccessError Internal database error.
InternalError.InternalHttpServerError An exception occurred while executing the request.
InternalError.ParamError Parameter error
InternalError.TaskFrameError Async task error.
InternalError.UnknownError Unknown error
InvalidParameter Parameter error.
InvalidParameter.ExceptionParam Parameter exception.
InvalidParameter.InstanceNotFound The instance does not exist.
InvalidParameterValue.DataConvertError Data conversion failed.
OperationDenied Operation denied.
OperationDenied.InstanceTaskStatusError Abnormal instance task status.
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