操作指南

API 文档

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

1. 接口描述

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

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

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

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

2. 输入参数

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

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

3. 输出参数

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

4. 示例

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

输入示例

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

输出示例

{
    "Response": {
        "TotalCount": 72,
        "Items": [
            {
                "Name": "max_connections",
                "ParamType": "integer",
                "Default": "151",
                "Description": "The maximum permitted number of simultaneous client connections.",
                "CurrentValue": "800",
                "NeedReboot": 0,
                "Max": 10240,
                "Min": 1,
                "EnumValue": [],
                "MinFunc": "",
                "MaxFunc": ""
            },
            {
                "Name": "character_set_server",
                "ParamType": "enum",
                "Default": "utf8",
                "Description": "Specify default server character set.",
                "CurrentValue": "utf8",
                "NeedReboot": 1,
                "EnumValue": [
                    "utf8",
                    "utf8mb4",
                    "gbk",
                    "latin1"
                ],
                "Max": 0,
                "Min": 0,
                "MinFunc": "",
                "MaxFunc": ""
            },
            {
                "Name": "lower_case_table_names",
                "ParamType": "integer",
                "Default": "0",
                "Description": "If set to 0, table names are stored as specified and comparisons are case sensitive. If set to 1, they are stored in lowercase on disk and comparisons are not case sensitive.",
                "CurrentValue": "0",
                "NeedReboot": 1,
                "Max": 1,
                "Min": 0,
                "EnumValue": [],
                "MinFunc": "",
                "MaxFunc": ""
            }
        ],
        "RequestId": "92131c95-aa65-44db-8c3c-e8cd67883b58"
    }
}

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.InternalHttpServerError 请求执行异常。
InternalError.ParamError 参数错误。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied 操作被拒绝。
目录