修改mongoDB实例参数

最近更新时间:2024-06-21 01:58:22

我的收藏

1. 接口描述

接口请求域名: mongodb.tencentcloudapi.com 。

本接口(ModifyInstanceParams)用于修改mongoDB实例的参数配置。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyInstanceParams。
Version String 公共参数,本接口取值:2019-07-25。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 指定实例 ID。例如:cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。

示例值:"cmgo-jyjcw8yv"
InstanceParams.N Array of ModifyMongoDBParamType 指定需修改的参数名及值。当前所支持的参数名及对应取值范围,请通过 DescribeInstanceParams 获取。
ModifyType String 操作类型,包括:
- IMMEDIATELY:立即调整。
- DELAY:延迟调整。可选字段,不配置该参数则默认为立即调整。
示例值:IMMEDIATELY

3. 输出参数

参数名称 类型 描述
Changed Boolean 修改参数配置是否生效。
- true:参数修改后的值已生效。
- false:执行失败。

示例值:true
TaskId Integer 该参数暂时无意义(兼容前端保留)。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改mongoDB实例参数

用户发起修改其mongoDB的参数配置

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceParams
<公共请求参数>

{
    "InstanceId": "cmgo-9d0p6umb",
    "InstanceParams": [
        {
            "Value": "operation.profiling.slowOpThresholdMs",
            "Key": "operation.profiling.slowOpThresholdMs"
        }
    ]
}

输出示例

{
    "Response": {
        "Changed": true,
        "RequestId": "e51b4590-db7b-4835-9899-1f5c33f92fbf",
        "TaskId": 0
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.OperationNotAllowedInInstanceLocking 实例锁定中不允许操作。
InternalError 内部错误。
InvalidParameter.ModifyMongodbParams 参数名有误
InvalidParameter.PermissionDenied 当前子账号无权执行该操作。
InvalidParameterValue.ModifyMongodbParams 参数值有误。
InvalidParameterValue.NotFoundInstance 未找到实例。
ResourceNotFound 资源不存在。