Domain name for API request: cdb.intl.tencentcloudapi.com.
This API (ModifyInstanceParam) is used to modify instance parameters.
A maximum of 20 requests can be initiated per second for this API.
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). |
NotSyncRo | No | Boolean | Whether to sync the parameters to read-only instance of the source instance. Valid values: true (not sync), false (sync). Default value: false . |
NotSyncDr | No | Boolean | Whether to sync the parameters to disaster recovery instance of the source instance. Valid values: true (not sync), false (sync). Default value: false . |
Parameter Name | Type | Description |
---|---|---|
AsyncRequestId | String | Async task ID, which can be used to query task progress. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceParam
<Common request parameters>
{
"NotSyncDr": true,
"NotSyncRo": true,
"ParamList": [
{
"CurrentValue": "xx",
"Name": "xx"
}
],
"TemplateId": 0,
"InstanceIds": [
"cdb-atjl8gns"
],
"WaitSwitch": 0
}
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"AsyncRequestId": "38265324-dd030463-3d46a793-4a0420b1"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.HttpError | Exceptional HTTP request |
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. |
InvalidParameterValue.InvalidParameterValueError | Invalid parameter value |
OperationDenied | Operation denied. |
OperationDenied.InstanceTaskStatusError | Abnormal instance task status. |
ResourceNotFound.InstanceNotFundError | The instance does not exist. |
Was this page helpful?