DescribeDBClusterParameters
该接口用于查看POLARDB集群的参数。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DBClusterId | String | 是 | pc-xxxxxxxxxx |
集群ID。 |
AccessKeyId | String | 否 | key-test |
阿里云颁发给用户的访问服务所用的密钥ID。 |
Action | String | 否 | DescribeDBClusterParameters |
系统规定参数,取值:DescribeDBClusterParameters。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBType | String | MySQL |
数据库类型,取值:
|
DBVersion | String | 5.6 |
数据库版本号,取值:
|
Engine | String | POLARDB |
引擎。 |
RequestId | String | 0FF7F658-ECE2-476C-B3C5-122BA9EB43C6 |
请求ID。 |
RunningParameters | Array |
当前运行的参数列表。 |
|
Parameter |
当前运行的参数列表。 |
||
CheckingCode | String | [utf8|latin1|gbk|utf8mb4] |
校验代码,参数的可选范围。 |
DataType | String | STRING |
值类型。 |
DefaultParameterValue | String | utf8 |
参数默认值。 |
ForceRestart | Boolean | true |
是否需要重启生效:
|
IsModifiable | Boolean | true |
是否可修改:
|
ParameterDescription | String | The server's default character set. |
参数描述。 |
ParameterName | String | character_set_server |
参数名。 |
ParameterStatus | String | Normal |
参数状态:
|
ParameterValue | String | utf8 |
参数值。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeDBClusterParameters
&DBClusterId=pc-xxxxxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>85DC8A9E-4E3E-4107-A569-A92B1D9C5B7C</RequestId>
<RunningParameters>
<Parameter>
<ParameterStatus>Normal</ParameterStatus>
<DefaultParameterValue>1</DefaultParameterValue>
<IsModifiable>true</IsModifiable>
<DataType>INT</DataType>
<ParameterDescription>Auto-increment columns are incremented by this</ParameterDescription>
<ParameterValue>1</ParameterValue>
<CheckingCode>[1-65535]</CheckingCode>
<ForceRestart>false</ForceRestart>
<ParameterName>auto_increment_increment</ParameterName>
</Parameter>
<Parameter>
<ParameterStatus>Normal</ParameterStatus>
<DefaultParameterValue>86400</DefaultParameterValue>
<IsModifiable>true</IsModifiable>
<DataType>INT</DataType>
<ParameterDescription>The number of seconds the server waits for activity on a connection before closing it</ParameterDescription>
<ParameterValue>86400</ParameterValue>
<CheckingCode>[1-31536000]</CheckingCode>
<ForceRestart>false</ForceRestart>
<ParameterName>wait_timeout</ParameterName>
</Parameter>
</RunningParameters>
<Engine>POLARDB</Engine>
JSON
格式
{
"RequestId":"85DC8A9E-4E3E-4107-A569-A92B1D9C5B7C",
"RunningParameters":{
"Parameter":[
{
"DefaultParameterValue":"1",
"ParameterStatus":"Normal",
"DataType":"INT",
"IsModifiable":true,
"ParameterDescription":"Auto-increment columns are incremented by this",
"ParameterValue":"1",
"ForceRestart":false,
"CheckingCode":"[1-65535]",
"ParameterName":"auto_increment_increment"
},
{
"DefaultParameterValue":"86400",
"ParameterStatus":"Normal",
"DataType":"INT",
"IsModifiable":true,
"ParameterDescription":"The number of seconds the server waits for activity on a connection before closing it",
"ParameterValue":"86400",
"ForceRestart":false,
"CheckingCode":"[1-31536000]",
"ParameterName":"wait_timeout"
}
]
},
"Engine":"POLARDB"
}
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论