调用DescribeParameters接口查询实例当前的参数配置。
该接口适用的实例版本如下:
- MySQL 5.5、5.6、5.7、8.0
- SQL Server 2008 R2
- PostgreSQL 10、 11、12、13、14、15
- MariaDB 10.3
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeParameters | 系统规定参数。取值:DescribeParameters。 |
ClientToken | String | 否 | ETnLKlblzczshOTUbOCzxxxxx | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx | 实例ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF | 请求ID。 |
Engine | String | MySQL | 数据库类型。 |
EngineVersion | String | 5.5 | 数据库版本号。 |
ConfigParameters | Array of DBInstanceParameter | 正在同步的参数列表。修改并提交参数后,需要等待实例同步参数,同步结束后从此列表删除。 |
|
DBInstanceParameter | |||
ParameterDescription | String | 此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。 | 参数描述。 |
ParameterName | String | fill factor | 参数名称。 |
ParameterValue | String | 50 | 参数值。 |
RunningParameters | Array of DBInstanceParameter | 当前运行的参数列表。 |
|
DBInstanceParameter | |||
ParameterDescription | String | 此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。 | 参数描述。 |
ParameterName | String | fill factor | 参数名称。 |
ParameterValue | String | 0 | 参数值。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeParameters
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<DescribeParametersResponse>
<ConfigParameters>
<DBInstanceParameter>
<ParameterDescription>此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。</ParameterDescription>
<ParameterName>fill factor</ParameterName>
<ParameterValue>50</ParameterValue>
</DBInstanceParameter>
</ConfigParameters>
<Engine>mssql</Engine>
<EngineVersion>2008r2</EngineVersion>
<RunningParameters>
<DBInstanceParameter>
<ParameterDescription>此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。</ParameterDescription>
<ParameterName>fill factor</ParameterName>
<ParameterValue>0</ParameterValue>
</DBInstanceParameter>
</RunningParameters>
<RequestId>2A748162-8040-4D6B-813E-6910C8C033F1</RequestId>
</DescribeParametersResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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"
}
错误码
访问错误中心查看更多错误码。