有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

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

该接口(DescribeInstanceParams)用于查询实例的参数列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceParams。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:mssql-dj5i29c5n,与云数据库控制台页面中显示的实例 ID 相同,可使用 DescribeDBInstances 接口获取,其值为输出参数中字段 InstanceId 的值。
示例值:mssql-dj5i29c5n

3. 输出参数

参数名称 类型 描述
TotalCount Integer 实例的参数总数
示例值:10
Items Array of ParameterDetail 参数详情
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例的可设置参数列表

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeInstanceParams
&InstanceId=mssql-bm5e51kb
&<公共请求参数>

输出示例

{
    "Response": {
        "Items": [
            {
                "CurrentValue": "24",
                "Default": "0",
                "Description": "The fill-factor option is provided for fine-tuning index data storage and performance.",
                "EnumValue": [],
                "Max": 100,
                "Min": 0,
                "Name": "fill factor(%)",
                "NeedReboot": 1,
                "ParamType": "integer",
                "Status": 0
            },
            {
                "CurrentValue": "0",
                "Default": "0",
                "Description": "The max worker threads option configures the number of worker threads that are available SQL Server-wide to process query requests, login, logout, and similar application requests.",
                "EnumValue": [
                    "0"
                ],
                "Max": 32767,
                "Min": 336,
                "Name": "max worker threads",
                "NeedReboot": 1,
                "ParamType": "integer",
                "Status": 0
            },
            {
                "CurrentValue": "30000",
                "Default": "5",
                "Description": "The cost threshold for parallelism option specifies the threshold at which SQL Server creates and runs parallel plans for queries.",
                "EnumValue": [],
                "Max": 32767,
                "Min": 0,
                "Name": "cost threshold for parallelism",
                "NeedReboot": 1,
                "ParamType": "integer",
                "Status": 0
            },
            {
                "CurrentValue": "1024",
                "Default": "0",
                "Description": "The degree of parallelism sets the number of processors employed to run a single statement, for each parallel plan execution. ",
                "EnumValue": [],
                "Max": 1024,
                "Min": 0,
                "Name": "max degree of parallelism",
                "NeedReboot": 1,
                "ParamType": "integer",
                "Status": 0
            },
            {
                "CurrentValue": "0",
                "Default": "0",
                "Description": "The optimize for ad hoc workloads option is used to improve the efficiency of the plan cache for workloads that contain many single use ad hoc batches.",
                "EnumValue": [
                    "0",
                    "1"
                ],
                "Max": 0,
                "Min": 0,
                "Name": "optimize for ad hoc workloads",
                "NeedReboot": 1,
                "ParamType": "enum",
                "Status": 0
            },
            {
                "CurrentValue": "1024",
                "Default": "0",
                "Description": "This options change the amount of memory the SQL Server Memory Manager can allocate to a SQL Server process.",
                "EnumValue": [],
                "Max": 2560,
                "Min": 0,
                "Name": "min server memory(MB)",
                "NeedReboot": 1,
                "ParamType": "integer",
                "Status": 0
            },
            {
                "CurrentValue": "23",
                "Default": "0",
                "Description": "Use the blocked process threshold option to specify the threshold, in seconds, at which blocked process reports are generated.",
                "EnumValue": [],
                "Max": 86400,
                "Min": 0,
                "Name": "blocked process threshold(s)",
                "NeedReboot": 1,
                "ParamType": "integer",
                "Status": 0
            }
        ],
        "RequestId": "8c2fa1ec-7e13-4a2b-ba20-4d5ef93047ad",
        "TotalCount": 7
    }
}

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签名/鉴权错误。
FailedOperation.GcsError 操作失败或者网络超时。
InternalError.DBError 数据库错误。
InternalError.GcsError GCS接口错误。
InternalError.SystemError 系统错误。
ResourceNotFound.InstanceNotFound 实例不存在。
ResourceNotFound.ParamsNotFound 参数未找到。
ResourceUnavailable.InstanceStatusInvalid 实例状态无效。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.PermissionDenied cam鉴权错误。