操作指南

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

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

该接口(DescribeDefaultParams)用于查询默认的可设置参数列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDefaultParams。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
EngineVersion String mysql版本,目前支持 ["5.1", "5.5", "5.6", "5.7"]。
TemplateType String 默认参数模板类型。支持值包括:"HIGH_STABILITY" - 高稳定模板,"HIGH_PERFORMANCE" - 高性能模板。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 参数个数。
Items Array of ParameterDetail 参数详情。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

https://cdb.tencentcloudapi.com/?Action=DescribeDefaultParams
&EngineVersion=5.7
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "RequestId": "92131c95-aa65-44db-8c3c-e8cd67883b58",
        "Items": [
            {
                "CurrentValue": "utf8",
                "Default": "LATIN1",
                "Description": "Specify default server character set",
                "EnumValue": [
                    "LATIN1",
                    "UTF8",
                    "GBK",
                    "UTF8MB4"
                ],
                "Max": 0,
                "MaxFunc": "",
                "Min": 0,
                "MinFunc": "",
                "Name": "character_set_server",
                "NeedReboot": 1,
                "ParamType": "enum"
            },
            {
                "CurrentValue": "1600",
                "Default": "{MIN(DBInitMemory/4+500,1000000)}",
                "Description": "The maximum permitted number of simultaneous client connections.",
                "EnumValue": [],
                "Max": 100000,
                "MaxFunc": "100000",
                "Min": 1,
                "MinFunc": "1",
                "Name": "max_connections",
                "NeedReboot": 0,
                "ParamType": "func"
            }
        ]
    }
}

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签名/鉴权错误。
CdbError 后端错误或者流程错误。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.ParamError 参数错误。
InvalidParameter 参数错误。
InvalidParameterValue.InvalidParameterValueError 参数值无效。
目录