Last updated: 2019-11-29 17:30:43

1. API Description

Domain name for API request:

This API (ModifyInstanceParam) is used to modify the parameters of a database instance.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyInstanceParam
Version Yes String Common parameter. The value used for this API: 2017-03-20
Region Yes String Common parameter. For more information, please see the [list of regions] supported by the product.
InstanceIds.N Yes Array of String List of instance IDs.
ParamList.N Yes Array of Parameter List of parameters to be modified. Each element is a combination of "name" and "currentValue". "name" is the parameter name, and "currentValue" is the modified value.

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Asynchronous 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. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see [Common Error Codes].

Error Code Description
CdbError.DatabaseError Backend database error.
CdbError.TaskError Backend task error.
InternalError.DatabaseAccessError Database's internal error.
InternalError.TaskFrameError An error occurred with the asynchronous task.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.

5. Example

Example 1 Modify instance parameter

Input example
&<Common request parameters>

Output example

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

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.