この操作を呼び出して、指定した ApsaraDB for PolarDB クラスターのパラメーターを照会できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須 / 任意 説明
DBClusterId String 必須 pc-xxxxxxxxxx

クラスターの ID。

AccessKeyId String 任意 key-test

Alibaba Cloud から提供された AccessKey ID。

Action String 任意 DescribeDBClusterParameters

実行する操作。 この値を DescribeDBClusterParameters に設定します。

レスポンスパラメーター

パラメーター データ型 説明
DBType String MySQL

データベースの種類。 有効な値は次のとおりです。

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String 5.6

データベースエンジンのバージョン。 有効な値は次のとおりです。

  • MySQL:5.6 または 8.0
  • PostgreSQL:11
  • Oracle:11
Engine String ApsaraDB for 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":[
			{
				"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"
}

エラーコード

エラーコードのリストについては、「API エラーセンター (API Error Center)」をご参照ください。