API参考 - API参考 -参数管理 - DescribeParameterTemplates
描述
该接口返回参数模板列表，包含参数名、参数默认值、是否可修改、是否需要重启才能生效、参数校验规则（正则表达式）。
[tr=transparent]
[/url]说明[tr=transparent]该接口只适用于MySQL和SQL Server类型的数据库。
请求参数
返回参数
List<TemplateRecord>
TemplateRecord参数
- False：需要重启数据库才能生效
- True：立即生效
请求示例
https://rds.aliyuncs.com/?Action=DescribeParameterTemplates&Engine=SQLServer&EngineVersion=2008r2&<公共请求参数>
返回示例
XML格式
<DescribeParameterTemplatesResponse><Engine>mssql</Engine><EngineVersion>2008r2</EngineVersion><ParameterCount>1</ParameterCount><Parameters><TemplateRecord><CheckingCode>[0-100]</CheckingCode><ForceRestart>True</ForceRestart><Factor>1</Factor><ParameterDescription>此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。</ParameterDescription><ParameterName>fill factor</ParameterName><ParameterValue>0</ParameterValue><ForceModify>True</ForceModify><Unit>INT</Unit></TemplateRecord></Parameters><RequestId>7B96585A-0FF2-4979-8FE5-7D147A29FDC0</RequestId></DescribeParameterTemplatesResponse>
JSON格式
{"Engine": "mssql","EngineVersion": "2008r2","ParameterCount":1"Parameters": {"TemplateRecord": [{"ParameterDescription": "此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。","ForceRestart": "True","CheckingCode": "[0-100]""Factor":"1""ParameterName":"fill factor""ParameterValue":"0""ForceModify":"True""Unit":"INT"}]},"RequestId": "7B96585A-0FF2-4979-8FE5-7D147A29FDC0"}
展开
收起
版权声明：本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
阿里云 AI 助理回答
根据您的描述，您想了解关于查询参数模板列表的接口详情，特别是针对MySQL和SQL Server类型的数据库。以下是该接口的详细说明及使用方法：
请求参数
-
Action
- 类型: String
- 是否必须: 是
- 描述: 系统规定参数，固定取值为：
DescribeParameterTemplates。
-
Engine
- 类型: String
- 是否必须: 是
- 描述: 数据库类型，可取值为
MySQL或SQL Server。
-
EngineVersion
- 类型: String
- 是否必须: 是
- 描述: 数据库版本号。对于MySQL，可选版本为5.1、5.5或5.6；对于SQL Server，可选版本为2008r2、2012_web或2016_web。
返回参数
- Engine 和 EngineVersion 重复提及，确认了查询结果将包含所查询的数据库类型及版本信息。
- ParameterCount
- 类型: Integer
- 描述: 返回的参数总数。
- ParametersList
- 格式: {parameter1, parameter2, parameter3, …}
- 描述: 参数列表，包含多个参数详情。
TemplateRecord 中的参数详情
- ParameterName
- 类型: String
- 描述: 参数名。
- ParameterValue
- 类型: String
- 描述: 参数默认值。
- ForceModify
- 类型: String
- 描述: 修改权限，
False表示不可修改，True表示可修改。
- ForceRestart
- 类型: String
- 描述: 是否需要重启数据库以使修改生效，
False表示需要重启，True表示立即生效（此描述与原始文档中的逻辑相反，请根据实际API行为理解）。
- CheckingCode
- 类型: String
- 描述: 参数校验规则，正则表达式形式，定义了参数的有效输入范围。
- ParameterDescription
- 类型: String
- 描述: 参数的详细描述。
请求示例
https://rds.aliyuncs.com/?Action=DescribeParameterTemplates
请注意，实际调用时还需根据阿里云API要求添加AccessKeyId、Signature等认证信息，并且确保请求参数符合API规范。此外，关于ForceRestart字段的解释可能存在误导，请参考官方文档或直接通过API测试来验证其实际含义。
参考资料： - [1] 接口描述与参数定义来源于用户问题中提及的信息。
有帮助
无帮助
AI 助理回答生成答案可能存在不准确，仅供参考
相关问答