API 文档

修改实例参数

最近更新时间:2022-04-13 07:06:54

我的收藏

1. 接口描述

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

本接口(ModifyInstanceParam)用于修改云数据库实例的参数。
注意:如果修改的参数是需要重启实例的,那么实例将会按照WaitSwitch参数的设置(可能是立即执行也可能在可维护时间窗内自动执行)在执行参数修改时重启实例
您可以通过DescribeInstanceParams接口查询修改参数时是否会重启实例,以免导致您的实例不符合预期重启。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyInstanceParam。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 实例短 ID 列表
ParamList.N Array of Parameter 要修改的参数列表。每一个元素是 Name 和 CurrentValue 的组合。Name 是参数名,CurrentValue 是要修改的值。注意:如果修改的参数需要重启实例,那么您的实例将会在执行修改时重启。您可以通过DescribeInstanceParams接口查询修改参数时是否会重启实例,以免导致您的实例不符合预期重启。
WaitSwitch Integer 执行参数调整任务的方式,默认为 0。支持值包括:0 - 立刻执行,1 - 时间窗执行。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改实例参数

输入示例

https://sqlserver.tencentcloudapi.com/?Action=ModifyInstanceParam
&WaitSwitch=0
&InstanceIds.0=mssql-bm5e51kb
&InstanceIds.1=mssql-p2yli7gv
&InstanceIds.2=mssql-9ahw2qp9
&ParamList.0.Name=fill factor(%)
&ParamList.0.CurrentValue=50
&ParamList.1.Name=cost threshold for parallelism
&ParamList.1.CurrentValue=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "74172b7e-139c-4eed-b237-856f56e67f48"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
InternalError.DBError 数据库错误。
InternalError.SystemError 系统错误。
InvalidParameter.InputIllegal 输入错误。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。
UnknownParameter 未知参数错误。
目录