该接口用于查看PolarDB集群的参数。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBClusterParameters

系统规定参数,取值:DescribeDBClusterParameters

DBClusterId String pc-xxxxxxxxxx

集群ID。

返回数据

名称 类型 示例值 描述
DBType String MySQL

数据库类型,取值:

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String 5.6

数据库版本号,取值:

  • MySQL:5.6/8.0
  • PostgreSQL:11
  • Oracle:11
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

是否需要重启生效:

  • False:否。
  • True:是。
IsModifiable Boolean true

是否可修改:

  • False:不可修改。
  • True:可修改。
ParameterDescription String The server's default character set.

参数描述。

ParameterName String character_set_server

参数名。

ParameterStatus String Normal

参数状态:

  • normal:正常。
  • modifying:修改中。
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": [
			{
				"ParameterStatus": "Normal",
				"DefaultParameterValue": "1",
				"IsModifiable": true,
				"DataType": "INT",
				"ParameterDescription": "Auto-increment columns are incremented by this",
				"ParameterValue": "1",
				"CheckingCode": "[1-65535]",
				"ForceRestart": false,
				"ParameterName": "auto_increment_increment"
			},
			{
				"ParameterStatus": "Normal",
				"DefaultParameterValue": "86400",
				"IsModifiable": true,
				"DataType": "INT",
				"ParameterDescription": "The number of seconds the server waits for activity on a connection before closing it",
				"ParameterValue": "86400",
				"CheckingCode": "[1-31536000]",
				"ForceRestart": false,
				"ParameterName": "wait_timeout"
			}
		]
	},
	"Engine": "PolarDB"
}

错误码

访问错误中心查看更多错误码。