开发者社区 问答 正文

API参考 - API参考 -参数管理 - DescribeParameters



描述


该接口返回用户某个实例当前的参数配置。

请求参数

[tr=rgb(51, 205, 229)][td]名称 类型是否必须描述ActionString是系统规定参数,取值:DescribeParameters。DBInstanceIdString是实例名。

返回参数

[tr=rgb(51, 205, 229)][td]名称 类型描述<公共返回参数>无详见公共参数。EngineString数据库类型。EngineVersionString数据库版本号。RunningParameters

List<DBInstanceParameter>当前运行的参数列表,格式为{parameter1,parameter2,parameter3, …}。ConfigParameters

List<DBInstanceParameter>正在同步的参数列表,格式为{parameter1,parameter2,parameter3,…}。

DBInstanceParameter参数

[tr=rgb(51, 205, 229)][td]名称 类型描述ParameterNameString参数名。ParameterValueString参数值。ParameterDescriptionString参数描述。

请求示例



https: //rds.aliyuncs.com/?Action=DescribeParameters &DBInstanceId=riauvjz6zajfiq6ba1370329449201 &<公共请求参数>

返回示例


XML格式

< DescribeParametersResponse> <RequestId>2A748162-8040-4D6B-813E-6910C8C033F1 </RequestId> <Engine>mssql </ Engine > <EngineVersion>2008r2 </ EngineVersion > <RunningParameters> <DBInstanceParameter> <ParameterDescription>此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能 </ParameterDescription> <ParameterName>fill factor </ParameterName> <ParameterValue>0 </ParameterValue> </DBInstanceParameter> </RunningParameters> <ConfigParameters> <DBInstanceParameter> <ParameterDescription>此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能 </ParameterDescription> <ParameterName>fill factor </ParameterName> <ParameterValue>50 </ParameterValue> </DBInstanceParameter> </ConfigParameters> </DescribeParametersResponse>
JSON格式

{"ConfigParameters": {"DBInstanceParameter": [{"ParameterDescription": "此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。","ParameterName": "fill factor","ParameterValue": "50"}]},"Engine": "mssql","EngineVersion": "2008r2","RunningParameters": {"DBInstanceParameter": [{"ParameterDescription": "此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。","ParameterName": "fill factor","ParameterValue": "0"}]},"RequestId": "2A748162-8040-4D6B-813E-6910C8C033F1"}

展开
收起
梨好橙 2018-09-15 22:42:02 1554 分享 版权
阿里云 AI 助理回答

该接口用于查询阿里云RDS实例的当前参数配置,支持包括RDS MySQL、RDS PostgreSQL、RDS SQL Server和RDS MariaDB在内的多种数据库引擎。以下是关于请求参数、返回参数以及请求示例的详细说明:

请求参数

  • Action (String, 必须): 系统规定参数,固定取值为DescribeParameters
  • DBInstanceId (String, 必须): 实例ID,表示您想要查询参数配置的RDS实例。

返回参数

公共参数

  • 请参考相关API文档中的公共参数部分,这里不具体列出。

特定返回参数

  • Engine (String): 指示数据库的类型。
  • EngineVersion (String): 数据库的版本号。
  • RunningParameters (List): 当前运行的参数列表,每个参数包含:
    • ParameterName (String): 参数名称。
    • ParameterValue (String): 参数当前值。
    • ParameterDescription (String): 参数描述。
  • ConfigParameters (List): 正在同步的参数列表,结构与RunningParameters相同。

DBInstanceParameter 参数说明

  • ParameterName (String): 参数名。
  • ParameterValue (String): 参数值。
  • ParameterDescription (String): 参数描述。

请求示例

https://rds.aliyuncs.com/?Action=DescribeParameters&DBInstanceId=您的实例ID

请注意,实际使用时需将您的实例ID替换为具体的RDS实例ID。此外,尽管示例中未展示,但根据需要,您可以添加可选参数ClientToken来保证请求幂等性。

此接口可以帮助您获取实例的实时参数配置情况,以便于进行参数调整或故障排查。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答