tencent cloud

TDSQL Boundless

产品动态
产品简介
产品概述
应用场景
产品架构
实例类型
兼容性说明
使用规范建议
自研内核
内核概述
内核版本更新动态
功能类特性
性能类特性
产品计费
计费概述
购买方式
价格详情
续费说明
欠费说明
退费说明
快速入门
创建实例
连接实例
用户指南
数据迁移
数据同步/订阅
实例管理
参数配置
账号管理
安全组
备份与恢复
数据库审计
标签管理
实践教程
Online DDL 的技术演进与使用实践
锁机制解析与问题排查实践
数据智能调度及相关性能优化实践
TDSQL Boundless 选型指南与实践教程
开发指南
开发指南(MySQL 兼容模式)
开发指南(HBase 兼容模式)
性能调优
性能调优概述
SQL 调优
DDL 调优
性能白皮书
性能概述
TPC-C 测试
Sysbench 测试
API 文档
History
Introduction
API Category
Making API Requests
Instance APIs
Security Group APIs
Task APIs
Backup APIs
Rollback APIs
Parameter APIs
Database APIs
Data Types
Error Codes
通用参考
系统原理
SQL 参考
数据库参数说明
TPC-H 基准测试数据模型参考
错误码信息
安全与合规
常见问题
服务协议
服务等级协议
服务条款
隐私政策
数据处理和安全协议
联系我们
词汇表

DescribeDBParameters

聚焦模式
字号
最后更新时间: 2026-03-13 18:56:41

1. API Description

Domain name for API request: tdmysql.intl.tencentcloudapi.com.

This API is used to obtain the current parameter settings of the instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeDBParameters.
Version Yes String Common Params. The value used for this API: 2021-11-22.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID, for example: tdsql3-ow728lmc.

3. Output Parameters

Parameter Name Type Description
InstanceId String Instance ID, for example: tdsql3-ow728lmc.
Params Array of ParamDesc Request the current parameter value of the instance.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtaining the Current Parameters of a Database

Input Example

https://tdmysql.intl.tencentcloudapi.com/?Action=DescribeDBParameters
&InstanceId=tdsql3-ige1a5k3
&<Common request parameters>

Output Example

{
    "Response": {
        "InstanceId": "tdsql3-ige1a5k3",
        "Params": [
            {
                "Default": "1",
                "SetValue": "",
                "Value": "1",
                "Param": "auto_increment_increment",
                "Constraint": {
                    "Range": {
                        "Max": "65535",
                        "Min": "1"
                    },
                    "Type": "section"
                },
                "HaveSetValue": false,
                "NeedRestart": true,
                "Description": ""
            },
            {
                "Default": "ON",
                "SetValue": "",
                "Description": "",
                "Value": "ON",
                "Param": "autocommit",
                "Constraint": {
                    "Enum": "ON,OFF",
                    "Type": "enum"
                },
                "HaveSetValue": false,
                "NeedRestart": true
            }
        ],
        "RequestId": "914db412-d6e6-47ad-8e62-d06e02e52a56"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.CamAuthError CAM authentication error.
AuthFailure.CheckCamAuthError CAM authentication request parameter check failed.
AuthFailure.UnauthorizedOperation CAM authentication failure.
FailedOperation.DBQueryInstanceError Query instance data failed.
FailedOperation.OssGetVariablesError Oss query parameter error.
InvalidParameterValue.CheckInstanceVersionError Instance version validation error.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈