调取DescribeParameters接口获取AnalyticDB PostgreSQL版实例的配置参数信息。
使用说明
本接口仅支持查看存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版实例的配置参数和相关信息。
QPS限制
本接口的单用户QPS限制默认为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
本文档中的QPS仅为默认参考值,准确信息请参见API速率配额列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeParameters |
系统规定参数。取值:DescribeParameters。 |
DBInstanceId | String | 是 | gp-bp*************** |
实例ID。 说明 您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情,包括实例ID。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Parameters | Array of Parameters |
配置参数列表。 |
|
IsChangeableConfig | String | true |
配置参数是否可修改。取值说明:
|
ForceRestartInstance | String | false |
是否需要重启实例。取值说明:
|
OptionalRange | String | [0-2147483647] |
配置参数的取值范围。 |
ParameterName | String | statement_timeout |
配置参数名称。 |
ParameterValue | String | 10800000 |
配置参数默认值。 |
ParameterDescription | String | Sets the maximum allowed duration of any statement,A value of 0 turns off the timeout. |
配置参数的说明。 |
CurrentValue | String | 10800000 |
配置参数当前值。 |
RequestId | String | 62506167-D284-562A-B7C2-0A********** |
请求ID。 |
示例
请求示例
http(s)://gpdb.aliyuncs.com/?Action=DescribeParameters
&DBInstanceId=gp-bp***************
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeParametersResponse>
<Parameters>
<OptionalRange>[0-2147483647]</OptionalRange>
<ParameterValue>10800000</ParameterValue>
<IsChangeableConfig>true</IsChangeableConfig>
<CurrentValue>10800000</CurrentValue>
<ParameterName>statement_timeout</ParameterName>
<ParameterDescription>Sets the maximum allowed duration of any statement,A value of 0 turns off the timeout.</ParameterDescription>
<ForceRestartInstance>false</ForceRestartInstance>
</Parameters>
<Parameters>
<OptionalRange>[multi_write_ec|multi_write_sc|single]</OptionalRange>
<ParameterValue>single</ParameterValue>
<IsChangeableConfig>true</IsChangeableConfig>
<CurrentValue>multi_write_ec</CurrentValue>
<ParameterName>rds_master_mode</ParameterName>
<ParameterDescription>Enable global strong consistency when rds_master_mode is set to multi_write_sc, and session consistency when rds_master_mode is set to multi_write_ec</ParameterDescription>
<ForceRestartInstance>true</ForceRestartInstance>
</Parameters>
<RequestId>62506167-D284-562A-B7C2-0A**********</RequestId>
</DescribeParametersResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Parameters" : [ {
"OptionalRange" : "[0-2147483647]",
"ParameterValue" : "10800000",
"IsChangeableConfig" : "true",
"CurrentValue" : "10800000",
"ParameterName" : "statement_timeout",
"ParameterDescription" : "Sets the maximum allowed duration of any statement,A value of 0 turns off the timeout.",
"ForceRestartInstance" : "false"
}, {
"OptionalRange" : "[multi_write_ec|multi_write_sc|single]",
"ParameterValue" : "single",
"IsChangeableConfig" : "true",
"CurrentValue" : "multi_write_ec",
"ParameterName" : "rds_master_mode",
"ParameterDescription" : "Enable global strong consistency when rds_master_mode is set to multi_write_sc, and session consistency when rds_master_mode is set to multi_write_ec",
"ForceRestartInstance" : "true"
} ],
"RequestId" : "62506167-D284-562A-B7C2-0A**********"
}
错误码
访问错误中心查看更多错误码。