Release Notes
Announcements
Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to modify the parameter configuration of a TencentDB for MongoDB instance.
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: ModifyInstanceParams. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-25. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Specifies the instance ID. For example, cmgo-p8vn****. Log in to the TencentDB for MongoDB console, and copy the instance ID from the instance list. |
| InstanceParams.N | Yes | Array of ModifyMongoDBParamType | Specifies the parameter name and value to be modified. For details about the currently supported parameter names and the corresponding valid values, see DescribeInstanceParams. |
| ModifyType | No | String | Operation type. Valid values: - IMMEDIATELY: immediate adjustment. - DELAY: delayed adjustment. It is an optional field. The default value is immediate adjustment if this parameter is left unspecified. |
| Parameter Name | Type | Description |
|---|---|---|
| Changed | Boolean | Whether the modification on the parameter configuration takes effect. - true: the modified parameter value has taken effect. - false: execution failed. |
| TaskId | Integer | This parameter is temporarily meaningless (to be compatible with the earlier versions, reserve this parameter at the frontend). |
| 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. |
This example shows you how to initiate a modification task of the parameter configuration for a TencentDB for MongoDB instance.
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceParams
<Common request parameters>
{
"InstanceId": "cmgo-9d0p6umb",
"InstanceParams": [
{
"Value": "operation.profiling.slowOpThresholdMs",
"Key": "operation.profiling.slowOpThresholdMs"
}
]
}{
"Response": {
"Changed": true,
"RequestId": "e51b4590-db7b-4835-9899-1f5c33f92fbf",
"TaskId": 0
}
}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 |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.OperationNotAllowedInInstanceLocking | Operations are not allowed to be performed while the instance is locked. |
| InternalError | Internal error |
| InvalidParameter.ModifyMongodbParams | The parameter name is incorrect. |
| InvalidParameter.PermissionDenied | The current sub-account has no permission to perform this operation. |
| InvalidParameterValue.ModifyMongodbParams | The parameter value is incorrect. |
| InvalidParameterValue.NotFoundInstance | The instance was not found. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback