1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
该接口(DescribeParamTemplateInfo)用于查询参数模板详情,全地域公共参数Region均为ap-guangzhou。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeParamTemplateInfo。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-singapore 。 |
TemplateId | 是 | Integer | 参数模板 ID。 示例值:233 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TemplateId | Integer | 参数模板 ID。 示例值:233 |
Name | String | 参数模板名称。 示例值:*** |
EngineVersion | String | 参数模板对应实例版本 示例值:5.6 |
TotalCount | Integer | 参数模板中的参数数量 示例值:1 |
Items | Array of ParameterDetail | 参数详情 示例值:[] |
Description | String | 参数模板描述 示例值:your_description |
TemplateType | String | 参数模板类型。支持值包括:"HIGH_STABILITY" - 高稳定模板,"HIGH_PERFORMANCE" - 高性能模板。 示例值:HIGH_STABILITY |
EngineType | String | 参数模板引擎。支持值包括:"InnoDB","RocksDB"。 注意:此字段可能返回 null,表示取不到有效值。 示例值:InnoDB |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询参数模板详情
该接口用于查询参数模板详细详情。
输入示例
https://cdb.tencentcloudapi.com/?Action=DescribeParamTemplateInfo
&TemplateId=233
&<公共请求参数>
输出示例
{
"Response": {
"TemplateId": 233,
"Name": "test",
"EngineVersion": "5.7",
"Description": "test",
"TotalCount": 72,
"TemplateType": "HIGH_STABILITY",
"RequestId": "92131c95-aa65-44db-8c3c-e8cd67883b58",
"EngineType": "InnoDB",
"Items": [
{
"CurrentValue": "1",
"Default": "1",
"Description": "Controls the interval between successive column values.",
"EnumValue": [],
"Max": 65535,
"MaxFunc": "",
"Min": 1,
"MinFunc": "",
"Name": "auto_increment_increment",
"NeedReboot": 0,
"ParamType": "integer"
},
{
"CurrentValue": "1",
"Default": "1",
"Description": "Determines the starting point for the AUTO_INCREMENT column value.",
"EnumValue": [],
"Max": 65535,
"MaxFunc": "",
"Min": 1,
"MinFunc": "",
"Name": "auto_increment_offset",
"NeedReboot": 0,
"ParamType": "integer"
},
{
"CurrentValue": "800",
"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。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
CdbError | 后端错误或者流程错误。 |
InternalError.DatabaseAccessError | 数据库内部错误。 |
InternalError.ParamError | 参数错误。 |
InvalidParameter | 参数错误。 |