DescribeParameters - ApsaraDB for Redis - Alibaba Cloud ドキュメントセンター

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。

リクエストパラメーター


パラメータ	タイプ	必須項目	例	説明
Action	String	必須	DescribeParameters	実行する操作。値を DescribeParameters を設定します。
DBInstanceId	String	必須	r-bp1xxxxxxxxxxxxx	パラメーターを照会するインスタンスの ID。
NodeId	String	任意	r-bp1xxxxxxxxxxxxx-db-0#6889415	クラスター内のノードの ID。クラスター内のノードを指定して照会する場合、このパラメーターを指定する必要があります。
AccessKeyId	String	任意	Lxxxxxxxxxxxxxxw	Alibaba Cloud がサービスにアクセスするために提供する AccessKey ID。

応答パラメーター


パラメーター	データ型	例	説明
ConfigParameters			返された設定パラメーター。
└CheckingCode	String	[0\|1]	検証に使用されるパラメーターの有効な値。
└ForceRestart	Boolean	true	パラメーターの変更を有効にするために再起動が必要かどうかを示します。有効な値： true：インスタンスの再起動後に変更が有効になります。 false：変更は送信後すぐに有効になります。
└ModifiableStatus	Boolean	true	パラメーターが変更可能かどうかを示します。有効な値： false true
└ParameterDescription	String	Check all keys passed in the KEYS array map to the same slot.	パラメーターの説明。
└ParameterName	String	script_check_enable	パラメータの名前。
└ParameterValue	String	1	パラメーターの値。
Engine	String	redis	インスタンスのエンジンタイプ。
EngineVersion	String	4.0	インスタンスのエンジンバージョン。
RunningParameters			返された実行時パラメーター。
└CheckingCode	String	[0\|1]	検証に使用されるパラメーターの有効な値。
└ForceRestart	String	true	パラメーターの変更を有効にするために再起動が必要かどうかを示します。有効な値： true：インスタンスの再起動後に変更が有効になります。 false：変更は送信後すぐに有効になります。
└ModifiableStatus	String	true	パラメーターが変更可能かどうかを示します。有効な値： false true
└ParameterDescription	String	You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].	パラメーターの説明。
└ParameterName	String	#no_loose_disabled-commands	パラメーターの名前。
└ParameterValue	String	keys,flushall,flushdb	パラメーターの値。
RequestId	String	9C1338BE-8DE8-4890-A900-E1BC06BF7E1A	リクエストの ID です。

例

リクエスト例


http(s)://[Endpoint]/? Action=DescribeParameters
&DBInstanceId=r-bp1xxxxxxxxxxxxx
&<Common request parameters>

通常のレスポンス例

XML 形式

<DescribeParametersResponse>
  <ConfigParameters/>
  <RequestId>9C1338BE-8DE8-4890-A900-E1BC06BF7E1A</RequestId>
  <RunningParameters>
    <Parameter>
      <ParameterDescription>check whitelist always</ParameterDescription>
      <ParameterValue>no</ParameterValue>
      <CheckingCode>[yes|no]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>#no_loose_check-whitelist-always</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>You can disable some dangerous commands, for example "keys,flushdb,flushall", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script]. </ParameterDescription>
      <ParameterValue>keys,flushall,flushdb</ParameterValue>
      <CheckingCode>. *</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>#no_loose_disabled-commands</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>Enable or disable SSL</ParameterDescription>
      <ParameterValue>yes</ParameterValue>
      <CheckingCode>[yes|no]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>#no_loose_ssl-enabled</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>Be compatible with cluster mode. </ParameterDescription>
      <ParameterValue>0</ParameterValue>
      <CheckingCode>[0|1]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>cluster_compat_enable</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>Check all keys passed in the KEYS array map to the same slot. </ParameterDescription>
      <ParameterValue>1</ParameterValue>
      <CheckingCode>[0|1]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>script_check_enable</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>If hash fields are less than this value and hash value sizes are less than hash-max-ziplist-value, the ziplist will be used. </ParameterDescription>
      <ParameterValue>512</ParameterValue>
      <CheckingCode>[0-999999999999999]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>hash-max-ziplist-entries</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>If hash value sizes are less than this value and hash fields are less than hash-max-ziplist-entries, the ziplist will be used. </ParameterDescription>
      <ParameterValue>64</ParameterValue>
      <CheckingCode>[0-999999999999999]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>hash-max-ziplist-value</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>lazyfree switch on eviction. </ParameterDescription>
      <ParameterValue>yes</ParameterValue>
      <CheckingCode>[yes|no]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>lazyfree-lazy-eviction</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>lazyfree switch on expire. </ParameterDescription>
      <ParameterValue>yes</ParameterValue>
      <CheckingCode>[yes|no]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>lazyfree-lazy-expire</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>lazyfree switch on server implicit deletion. </ParameterDescription>
      <ParameterValue>yes</ParameterValue>
      <CheckingCode>[yes|no]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>lazyfree-lazy-server-del</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>The number of entries on the list that are not compressed at both ends. </ParameterDescription>
      <ParameterValue>0</ParameterValue>
      <CheckingCode>[0-65535]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>list-compress-depth</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>Threadhold of ziplist size on quicklist. </ParameterDescription>
      <ParameterValue>-2</ParameterValue>
      <CheckingCode>[-5-99999999]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>list-max-ziplist-size</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>To config how Redis will select what to remove when maxmemory is reached. There are eight behaviors that can be chose : volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction</ParameterDescription>
      <ParameterValue>volatile-lfu</ParameterValue>
      <CheckingCode>[volatile-lru|allkeys-lru|volatile-random|allkeys-random|volatile-ttl|volatile-lfu|allkeys-lfu|noeviction]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>maxmemory-policy</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>
				Sets have a special encoding in just one case: when a set is composed
				of just strings that happen to be integers in radix 10 in the range
				of 64 bit signed integers.
				The following configuration setting sets the limit in the size of the
			set in order to use this special memory saving encoding. </ParameterDescription>
      <ParameterValue>512</ParameterValue>
      <CheckingCode>[0-999999999999999]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>set-max-intset-entries</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>
				The time is expressed in microseconds, so 1000000 is equivalent
				to one second. Note that a negative number disables the slow log,
			while a value of zero forces the logging of every command. </ParameterDescription>
      <ParameterValue>10000</ParameterValue>
      <CheckingCode>[0-10000000]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>slowlog-log-slower-than</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>The max slowlog count. </ParameterDescription>
      <ParameterValue>1024</ParameterValue>
      <CheckingCode>[100-10000]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>slowlog-max-len</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>
				Similarly to hashes and lists, sorted sets are also specially encoded in
			order to save a lot of space. </ParameterDescription>
      <ParameterValue>128</ParameterValue>
      <CheckingCode>[0-999999999999999]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>zset-max-ziplist-entries</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>
				Similarly to hashes and lists, sorted sets are also specially encoded in
			order to save a lot of space. </ParameterDescription>
      <ParameterValue>64</ParameterValue>
      <CheckingCode>[0-999999999999999]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>zset-max-ziplist-value</ParameterName>
    </Parameter>
  </RunningParameters>
  <EngineVersion>4.0</EngineVersion>
  <Engine>redis</Engine>
</DescribeParametersResponse>

JSON 形式

{
	"ConfigParameters":{
		"Parameter":[]
	},
	"RequestId":"9C1338BE-8DE8-4890-A900-E1BC06BF7E1A",
	"RunningParameters":{
		"Parameter":[
			{
				"ParameterDescription":"check whitelist always",
				"ParameterValue":"no",
				"ForceRestart":"false",
				"CheckingCode":"[yes|no]",
				"ModifiableStatus":"true",
				"ParameterName":"#no_loose_check-whitelist-always"
			},
			{
				"ParameterDescription":"You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].",
				"ParameterValue":"keys,flushall,flushdb",
				"ForceRestart":"false",
				"CheckingCode":". *",
				"ModifiableStatus":"true",
				"ParameterName":"#no_loose_disabled-commands"
			},
			{
				"ParameterDescription":"Enable or disable SSL",
				"ParameterValue":"yes",
				"ForceRestart":"false",
				"CheckingCode":"[yes|no]",
				"ModifiableStatus":"true",
				"ParameterName":"#no_loose_ssl-enabled"
			},
			{
				"ParameterDescription":"Be compatible with cluster mode.",
				"ParameterValue":"0",
				"ForceRestart":"false",
				"CheckingCode":"[0|1]",
				"ModifiableStatus":"true",
				"ParameterName":"cluster_compat_enable"
			},
			{
				"ParameterDescription":"Check all keys passed in the KEYS array map to the same slot.",
				"ParameterValue":"1",
				"ForceRestart":"false",
				"CheckingCode":"[0|1]",
				"ModifiableStatus":"true",
				"ParameterName":"script_check_enable"
			},
			{
				"ParameterDescription":"If hash fields are less than this value and hash value sizes are less than hash-max-ziplist-value, the ziplist will be used.",
				"ParameterValue":"512",
				"ForceRestart":"false",
				"CheckingCode":"[0-999999999999999]",
				"ModifiableStatus":"true",
				"ParameterName":"hash-max-ziplist-entries"
			},
			{
				"ParameterDescription":"If hash value sizes are less than this value and hash fields are less than hash-max-ziplist-entries, the ziplist will be used.",
				"ParameterValue":"64",
				"ForceRestart":"false",
				"CheckingCode":"[0-999999999999999]",
				"ModifiableStatus":"true",
				"ParameterName":"hash-max-ziplist-value"
			},
			{
				"ParameterDescription":"lazyfree switch on eviction.",
				"ParameterValue":"yes",
				"ForceRestart":"false",
				"CheckingCode":"[yes|no]",
				"ModifiableStatus":"true",
				"ParameterName":"lazyfree-lazy-eviction"
			},
			{
				"ParameterDescription":"lazyfree switch on expire.",
				"ParameterValue":"yes",
				"ForceRestart":"false",
				"CheckingCode":"[yes|no]",
				"ModifiableStatus":"true",
				"ParameterName":"lazyfree-lazy-expire"
			},
			{
				"ParameterDescription":"lazyfree switch on server implicit deletion.",
				"ParameterValue":"yes",
				"ForceRestart":"false",
				"CheckingCode":"[yes|no]",
				"ModifiableStatus":"true",
				"ParameterName":"lazyfree-lazy-server-del"
			},
			{
				"ParameterDescription":"The number of entries on the list that are not compressed at both ends.",
				"ParameterValue":"0",
				"ForceRestart":"false",
				"CheckingCode":"[0-65535]",
				"ModifiableStatus":"true",
				"ParameterName":"list-compress-depth"
			},
			{
				"ParameterDescription":"Threadhold of ziplist size on quicklist.",
				"ParameterValue":"-2",
				"ForceRestart":"false",
				"CheckingCode":"[-5-99999999]",
				"ModifiableStatus":"true",
				"ParameterName":"list-max-ziplist-size"
			},
			{
				"ParameterDescription":"To config how Redis will select what to remove when maxmemory is reached. There are eight behaviors that can be chose : volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction",
				"ParameterValue":"volatile-lfu",
				"ForceRestart":"false",
				"CheckingCode":"[volatile-lru|allkeys-lru|volatile-random|allkeys-random|volatile-ttl|volatile-lfu|allkeys-lfu|noeviction]",
				"ModifiableStatus":"true",
				"ParameterName":"maxmemory-policy"
			},
			{
				"ParameterDescription":"Sets have a special encoding in just one case: when a set is composed\nof just strings that happen to be integers in radix 10 in the range\nof 64 bit signed integers.\nThe following configuration setting sets the limit in the size of the\nset in order to use this special memory saving encoding.",
				"ParameterValue":"512",
				"ForceRestart":"false",
				"CheckingCode":"[0-999999999999999]",
				"ModifiableStatus":"true",
				"ParameterName":"set-max-intset-entries"
			},
			{
				"ParameterDescription":"The time is expressed in microseconds, so 1000000 is equivalent\nto one second. Note that a negative number disables the slow log,\nwhile a value of zero forces the logging of every command.",
				"ParameterValue":"10000",
				"ForceRestart":"false",
				"CheckingCode":"[0-10000000]",
				"ModifiableStatus":"true",
				"ParameterName":"slowlog-log-slower-than"
			},
			{
				"ParameterDescription":"The max slowlog count.",
				"ParameterValue":"1024",
				"ForceRestart":"false",
				"CheckingCode":"[100-10000]",
				"ModifiableStatus":"true",
				"ParameterName":"slowlog-max-len"
			},
			{
				"ParameterDescription":"Similarly to hashes and lists, sorted sets are also specially encoded in\norder to save a lot of space.",
				"ParameterValue":"128",
				"ForceRestart":"false",
				"CheckingCode":"[0-999999999999999]",
				"ModifiableStatus":"true",
				"ParameterName":"zset-max-ziplist-entries"
			},
			{
				"ParameterDescription":"Similarly to hashes and lists, sorted sets are also specially encoded in\norder to save a lot of space.",
				"ParameterValue":"64",
				"ForceRestart":"false",
				"CheckingCode":"[0-999999999999999]",
				"ModifiableStatus":"true",
				"ParameterName":"zset-max-ziplist-value"
			}
		]
	},
	"EngineVersion":"4.0",
	"Engine":"redis"
}

Error codes


HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.	指定されたインスタンスタイプが無効な場合に返されるエラーメッセージ。インスタンスタイプが正しいか確認してください。
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	現行インスタンスタイプがこの操作をサポートしていない場合に返されるエラーメッセージ。読み取り専用インスタンスのみをクローンまたはバックアップできます。

エラーコードの表示。